Commit d9516e9f by wingwj

Update the API content in the document to Rocky

The current API document for the Cyborg project is still in the
Pike version and is outdated.
Need to update it to the latest Rocky version.

Change-Id: I663e6ed8ff1f99b423528d26533626466a54c530
Story: 2004705
Task: 28734
parent 34eac481
......@@ -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}` |
+--------+-----------------------------------------+-----------------------------------------------------------+
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment