openstack/cyborg
Code Issues Proposed changes

Update error codes in getting device API

Browse Source 
Add the error code 404 (notfound) and the response of the device.

Closes-Bug: #1955705
Change-Id: Ida000615c1c86222657e67f384eb3ba9c584d6c3
This commit is contained in:
ericxiett 2021-12-24 13:19:08 +00:00
parent 10473cd68a
commit 92a5bb8109
1 changed files with 87 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api-ref/source/devices.inc
View File

@ -58,7 +58,7 @@ Gets the UUID, name, type and more informations for one device with the specifie
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Error response codes: badRequest(400), unauthorized(401), forbidden(403), notfound(404)
Request
=======
@ -66,6 +66,21 @@ Request
- device_uuid: device_uuid
Response
========
.. rest_parameters:: parameters.yaml
- uuid: device_uuid_resp
- type: device_type_resp
- vendor: device_vendor_resp
- model: device_model_resp
- std_board_info: device_std_board_info_resp
- vendor_board_info: device_vendor_board_info_resp
- hostname: hostname_resp
- created_at: created
- updated_at: updated
- links: links
**Example response: show details of a specific device**
.. literalinclude:: ../../doc/api_samples/devices/devices-getone-resp.json