device_profile.inc (openstack-cyborg-6.0.0) | : | device_profile.inc (openstack-cyborg-7.0.0) | ||
---|---|---|---|---|
skipping to change at line 30 | skipping to change at line 30 | |||
-------------------- | -------------------- | |||
.. rest_method:: GET /v2/device_profiles | .. rest_method:: GET /v2/device_profiles | |||
Lists UUIDs, names, groups for all device profiles. | Lists UUIDs, names, groups for all device profiles. | |||
Normal response codes: 200 | Normal response codes: 200 | |||
Error response codes: unauthorized(401), forbidden(403) | Error response codes: unauthorized(401), forbidden(403) | |||
Response | ||||
======== | ||||
.. rest_parameters:: parameters.yaml | ||||
- device_profiles: device_profiles | ||||
- name: device_prof_name_resp | ||||
- uuid: device_profile_uuid | ||||
- description: device_profile_description | ||||
- groups: device_prof_groups_resp | ||||
- created_at: created | ||||
- updated_at: updated | ||||
- links: links | ||||
**Example response: list all device profiles** | **Example response: list all device profiles** | |||
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-lis t-resp.json | .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-list-r esp.json | |||
:language: javascript | :language: javascript | |||
Get One Device Profile | Get One Device Profile | |||
---------------------- | ---------------------- | |||
.. rest_method:: GET /v2/device_profiles/{device_profile_uuid} | .. rest_method:: GET /v2/device_profiles/{device_profile_uuid} | |||
Gets the UUID, name, groups for one device_profile with the specified UUID. | Gets the UUID, name, groups for one device_profile with the specified UUID. | |||
Normal response codes: 200 | Normal response codes: 200 | |||
Error response codes: badRequest(400), unauthorized(401), forbidden(403) | Error response codes: badRequest(400), unauthorized(401), forbidden(403) | |||
Request | Request | |||
======= | ======= | |||
.. rest_parameters:: parameters.yaml | .. rest_parameters:: parameters.yaml | |||
- device_profile_uuid: device_profile_uuid | - device_profile_uuid: device_profile_uuid | |||
Response | ||||
======== | ||||
.. rest_parameters:: parameters.yaml | ||||
- device_profile: device_profile | ||||
- name: device_prof_name_resp | ||||
- uuid: device_profile_uuid | ||||
- description: device_profile_description | ||||
- groups: device_prof_groups_resp | ||||
- created_at: created | ||||
- updated_at: updated | ||||
- links: links | ||||
**Example response: get details of a specific device profile** | **Example response: get details of a specific device profile** | |||
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-get one-resp.json | .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-getone -resp.json | |||
:language: javascript | :language: javascript | |||
Create Device Profile | Create Device Profile | |||
--------------------- | --------------------- | |||
.. rest_method:: POST /v2/device_profiles | .. rest_method:: POST /v2/device_profiles | |||
Creates a device profile. The payload should have these fields: | Creates a device profile. The payload should have these fields: | |||
Normal response codes: 201 | Normal response codes: 201 | |||
skipping to change at line 76 | skipping to change at line 102 | |||
Error response codes: badRequest(400), unauthorized(401), forbidden(403), | Error response codes: badRequest(400), unauthorized(401), forbidden(403), | |||
conflict(409) | conflict(409) | |||
Request | Request | |||
======= | ======= | |||
.. rest_parameters:: parameters.yaml | .. rest_parameters:: parameters.yaml | |||
- name: device_prof_name_req | - name: device_prof_name_req | |||
- groups: device_prof_groups_req | - groups: device_prof_groups_req | |||
Response | ||||
======== | ||||
.. rest_parameters:: parameters.yaml | ||||
- name: device_prof_name_resp | ||||
- uuid: device_profile_uuid | ||||
- description: device_profile_description | ||||
- groups: device_prof_groups_resp | ||||
- created_at: created | ||||
- updated_at: updated | ||||
- links: links | ||||
**Example post curl with resource/trait** | **Example post curl with resource/trait** | |||
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-pos t-curl.json | .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-c url.json | |||
:language: javascript | :language: javascript | |||
**Example post curl with a cyborg property when bitstream is required** | **Example post curl with a cyborg property when bitstream is required** | |||
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-pos t-curl-with-bitstream.json | .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-c url-with-bitstream.json | |||
:language: javascript | :language: javascript | |||
**Example response: create a device profile** | **Example response: create a device profile** | |||
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-cre ate-resp.json | .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-create -resp.json | |||
:language: javascript | :language: javascript | |||
Delete One Device Profile by uuid | Delete One Device Profile by uuid | |||
--------------------------------- | --------------------------------- | |||
.. rest_method:: DELETE /v2/device_profiles/{device_profile_uuid} | .. rest_method:: DELETE /v2/device_profiles/{device_profile_uuid} | |||
Delete a device profile. No query parameters required. | Delete a device profile. No query parameters required. | |||
Delete Multiple Device Profiles by names | Delete Multiple Device Profiles by names | |||
End of changes. 8 change blocks. | ||||
5 lines changed or deleted | 43 lines changed or added |