openstack/cyborg
Code Issues Proposed changes

Merge "API documentation update."

Browse Source
This commit is contained in:
Zuul 2019-10-10 22:02:52 +00:00 committed by Gerrit Code Review
commit 1e08be3dc2
1 changed files with 56 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
doc/source/api/api.rst
View File

@ -1,34 +1,59 @@
Cyborg REST API v1.0
********************
===============
Cyborg REST API
===============
General Information
===================
v2.0
-----
The Train release introduces version 2.0 APIs. Details of these APIs
can be found `here
<https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_.
This document describes the basic REST API operation that Cyborg supports
for Stein release::
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| Verb | URI | Description |
+========+=========================================+=======================================================================+
| GET | /accelerators | Return a list of accelerators (Deprecated) |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| GET | /accelerators/{uuid} | Retrieve a certain accelerator info identified by `{uuid}` (Deprecated)|
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| POST | /accelerators | Create a new accelerator (Deprecated) |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| PUT | /accelerators/{uuid} | Update the spec for the accelerator identified by `{uuid}` (Deprecated)|
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| DELETE | /accelerators/{uuid} | Delete the accelerator identified by `{uuid}` (Deprecated) |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| GET | /accelerators/deployables/ | Return a list of deployables |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| GET | /accelerators/deployables/{uuid} | Retrieve a certain deployable info identified by `{uuid}` |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| POST | /accelerators/deployables/ | Create a new deployable |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| PATCH | /accelerators/deployables/{uuid}/program| Program a new deployable(FPGA) |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| PATCH | /accelerators/deployables/{uuid} | Update the spec for the deployable identified by `{uuid}` |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
| DELETE | /accelerators/deployables/{uuid} | Delete the deployable identified by `{uuid}` |
+--------+-----------------------------------------+-----------------------------------------------------------------------+
v1.0
-----
The following v1 APIs are deprecated in Train and will be removed in the Ussuri
release.
The URIs are relative to ``http://<controller-ip>/accelerator/v1``.
.. list-table::
:widths: 10 40 50
:header-rows: 1
* - Verb
- URI
- Description
* - GET
- ``/accelerators``
- Return a list of accelerators
* - GET
- ``/accelerators/{uuid}``
- Retrieve a certain accelerator info identified by `{uuid}`
* - POST
- ``/accelerators``
- Create a new accelerator
* - PUT
- ``/accelerators/{uuid}``
- Update the spec for the accelerator identified by `{uuid}`
* - DELETE
- ``/accelerators/{uuid}``
- Delete the accelerator identified by `{uuid}`
* - GET
- ``/accelerators/deployables/``
- Return a list of deployables
* - GET
- ``/accelerators/deployables/{uuid}``
- Retrieve a certain deployable info identified by `{uuid}`
* - POST
- ``/accelerators/deployables/``
- Create a new deployable
* - PATCH
- ``/accelerators/deployables/{uuid}/program``
- Program a new deployable(FPGA)
* - PATCH
- ``/accelerators/deployables/{uuid}``
- Update the spec for the deployable identified by `{uuid}`
* - DELETE
- ``/accelerators/deployables/{uuid}``
- Delete the deployable identified by `{uuid}`