openstack/cyborg
Code Issues Proposed changes

Remove the redundant index page for APIs entry

Browse Source 
Now we just have using V2 API, and we have no plans to add other versions
of the API, the current API page entry is redundant [1], this patch will
remove it.

[1] https://docs.openstack.org/api-ref/accelerator/

Change-Id: Idd6aa49b3d63b4acbda2444d892e28158b011ad5
This commit is contained in:
zhangbailin 2021-08-14 18:25:05 +08:00
parent 1052efe93b
commit b15a7a7120
7 changed files with 27 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-ref/source/v2/arqs.inc → api-ref/source/arqs.inc
View File

@ -24,7 +24,7 @@ for all accelerator_requests.
**Example response: list all accelerator requests** **Example response: list all accelerator requests**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-list-resp.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-list-resp.json
:language: javascript :language: javascript
Get One Accelerator Request Get One Accelerator Request
@ -43,7 +43,7 @@ Request
**Example response: get details of a specific accelerator request** **Example response: get details of a specific accelerator request**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-getone-resp.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-getone-resp.json
Create Accelerator Requests Create Accelerator Requests
--------------------------- ---------------------------
@ -60,11 +60,11 @@ Request
**Example post curl** **Example post curl**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-post-curl.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-post-curl.json
**Example response: create an accelerator request** **Example response: create an accelerator request**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-create-resp.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-create-resp.json
Update Accelerator Requests Update Accelerator Requests
--------------------------- ---------------------------
@ -90,11 +90,11 @@ Request
**Example patch curl** **Example patch curl**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-patch-curl.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-patch-curl.json
**Example response: update an accelerator request** **Example response: update an accelerator request**
.. literalinclude:: ../../../doc/api_samples/accelerator_requests/accelerator_requests-after-update-resp.json .. literalinclude:: ../../doc/api_samples/accelerator_requests/accelerator_requests-after-update-resp.json
Delete Accelerator Requests by ARQ uuid Delete Accelerator Requests by ARQ uuid
--------------------------------------- ---------------------------------------

4
api-ref/source/v2/deployables.inc → api-ref/source/deployables.inc
View File

@ -22,7 +22,7 @@ Error response codes: unauthorized(401), forbidden(403)
**Example response: list all deployables** **Example response: list all deployables**
.. literalinclude:: ../../../doc/api_samples/deployables/deployables-list-resp.json .. literalinclude:: ../../doc/api_samples/deployables/deployables-list-resp.json
:language: javascript :language: javascript
Get One Deployable Get One Deployable
@ -44,5 +44,5 @@ Request
**Example response: show details of a specific deployable** **Example response: show details of a specific deployable**
.. literalinclude:: ../../../doc/api_samples/deployables/deployables-getone-resp.json .. literalinclude:: ../../doc/api_samples/deployables/deployables-getone-resp.json
:language: javascript :language: javascript

10
api-ref/source/v2/device_profile.inc → api-ref/source/device_profile.inc
View File

@ -43,7 +43,7 @@ Response
**Example response: list all device profiles** **Example response: list all device profiles**
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-list-resp.json .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-list-resp.json
:language: javascript :language: javascript
Get One Device Profile Get One Device Profile
@ -78,7 +78,7 @@ Response
**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-getone-resp.json .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-getone-resp.json
:language: javascript :language: javascript
Create Device Profile Create Device Profile
@ -114,17 +114,17 @@ Response
**Example post curl with resource/trait** **Example post curl with resource/trait**
.. literalinclude:: ../../../doc/api_samples/device_profiles/device_profiles-post-curl.json .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-curl.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-post-curl-with-bitstream.json .. literalinclude:: ../../doc/api_samples/device_profiles/device_profiles-post-curl-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-create-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

4
api-ref/source/v2/devices.inc → api-ref/source/devices.inc
View File

@ -21,7 +21,7 @@ Error response codes: unauthorized(401), forbidden(403)
**Example response: list all devices** **Example response: list all devices**
.. literalinclude:: ../../../doc/api_samples/devices/devices-list-resp.json .. literalinclude:: ../../doc/api_samples/devices/devices-list-resp.json
:language: javascript :language: javascript
Get One Device Get One Device
@ -43,5 +43,5 @@ Request
**Example response: show details of a specific device** **Example response: show details of a specific device**
.. literalinclude:: ../../../doc/api_samples/devices/devices-getone-resp.json .. literalinclude:: ../../doc/api_samples/devices/devices-getone-resp.json
:language: javascript :language: javascript

17
api-ref/source/index.rst
View File

@ -2,10 +2,17 @@
OpenStack Acceleration APIs OpenStack Acceleration APIs
=========================== ===========================
This is a reference for the OpenStack Acceleration API which is provided by This is a reference for the OpenStack Acceleration v2 API which is provided
the Cyborg project. by the Cyborg project. Starting from Ussuri, Cyborg supports only Version 2
REST APIs. The Version 1 APIs were deprecated in Train and shall be removed
in Ussuri.
.. toctree:: .. rest_expand_all::
:maxdepth: 1
v2/index .. include:: device_profile.inc
.. include:: arqs.inc
.. include:: devices.inc
.. include:: deployables.inc

0
api-ref/source/v2/parameters.yaml → api-ref/source/parameters.yaml
View File

18
api-ref/source/v2/index.rst
View File

@ -1,18 +0,0 @@
==============================
OpenStack Acceleration v2 APIs
==============================
This is a reference for the OpenStack Acceleration v2 API which is provided
by the Cyborg project. Starting from Ussuri, Cyborg supports only Version 2
REST APIs. The Version 1 APIs were deprecated in Train and shall be removed
in Ussuri.
.. rest_expand_all::
.. include:: device_profile.inc
.. include:: arqs.inc
.. include:: devices.inc
.. include:: deployables.inc