Docs: Add the missing parameter table in deployables API

Co-Author-By: Brin Zhang <zhangbailin@inspur.com>

Closes-Bug: #1927058
Change-Id: I6bbf5df5631cfaf175e9d9268ad704f786ae2e13
This commit is contained in:
Arthur Dayne 2021-06-11 09:45:04 +08:00 committed by zhangbailin
parent f033fc32f7
commit de7cdd68da
2 changed files with 113 additions and 0 deletions

View File

@ -20,6 +20,31 @@ Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Request
=======
.. rest_parameters:: parameters.yaml
- filters: filters
Response
========
.. rest_parameters:: parameters.yaml
- deployables: deployables
- uuid: deployable_uuid_resp
- parent_id: deployable_parent_id
- root_id: deployable_root_id
- name: deployable_name
- num_accelerators: deployable_num_accelerators
- device_id: deployable_device_id
- attributes_list: deployable_attributes_list
- rp_uuid: deployable_rp_uuid
- driver_name: deployable_driver_name
- bitstream_id: deployable_bitstream_id
- created_at: created
- updated_at: updated
- links: links
**Example response: list all deployables**
.. literalinclude:: ../../doc/api_samples/deployables/deployables-list-resp.json
@ -42,6 +67,24 @@ Request
- deployable_uuid: deployable_uuid
Response
========
.. rest_parameters:: parameters.yaml
- uuid: deployable_uuid_resp
- parent_id: deployable_parent_id
- root_id: deployable_root_id
- name: deployable_name
- num_accelerators: deployable_num_accelerators
- device_id: deployable_device_id
- attributes_list: deployable_attributes_list
- rp_uuid: deployable_rp_uuid
- driver_name: deployable_driver_name
- bitstream_id: deployable_bitstream_id
- created_at: created
- updated_at: updated
- links: links
**Example response: show details of a specific deployable**
.. literalinclude:: ../../doc/api_samples/deployables/deployables-getone-resp.json

View File

@ -57,6 +57,7 @@ hostname:
in: query
required: false
type: string
# variables in body
created:
description: |
@ -73,6 +74,75 @@ created:
in: body
required: true
type: string
deployable_attributes_list:
description: |
A list of dictionaries (in json string format) representing attributes of
the deployable.
in: body
required: true
type: string
deployable_bitstream_id:
description: |
The UUID of the bitstream corresponding to the deployable.
in: body
required: true
type: string
deployable_device_id:
description: |
ID of device associated with the deployable.
in: body
required: true
type: integer
deployable_driver_name:
description: |
Name of the driver reported.
in: body
required: true
type: string
deployable_name:
description: |
Name of the deployable.
in: body
required: true
type: string
deployable_num_accelerators:
description: |
Number of accelerators spawned by this deployable.
in: body
requied: true
type: integer
deployable_parent_id:
description: |
The parent_id refers to the id of the deployable's parent node.
in: body
required: true
type: string
deployable_root_id:
description: |
The root_id refers to the id of the deployable's root to
for nested tree.
in: body
required: true
type: string
deployable_rp_uuid:
description: |
UUID of the resource provider corresponding to this deployable.
in: body
required: true
type: string
deployable_uuid_resp:
description: |
The UUID of the deployable.
in: body
required: true
type: string
deployables:
description: |
This is a list of dictionaries, with each dictionary representing
a deployable object.
in: body
required: true
type: array
device_model_resp:
description: |
The model of the device.