openstack
/
cyborg
Code Issues Proposed changes

Merge "Update the API content in the document to Rocky"

This commit is contained in:
Zuul 2019-02-07 19:38:15 +00:00 committed by Gerrit Code Review
parent 4a968353c0 d9516e9f14
commit b12ae00844
1 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/source/admin/api.rst
View File

@ -5,19 +5,30 @@ General Information
===================
This document describes the basic REST API operation that Cyborg supports
for Pike release::
+--------+-----------------------+-----------------------------------------------------------+
| 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}` |
+--------+-----------------------+-----------------------------------------------------------+
for Rocky release::
+--------+-----------------------------------------+-----------------------------------------------------------+
| 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}` |
+--------+-----------------------------------------+-----------------------------------------------------------+