diff --git a/doc/source/admin/api.rst b/doc/source/admin/api.rst index 01c11a75..e28b2c16 100644 --- a/doc/source/admin/api.rst +++ b/doc/source/admin/api.rst @@ -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}` | + +--------+-----------------------------------------+-----------------------------------------------------------+