diff options
| author |   bobzhou <zhoubo8@lenovo.com> | 2018-12-17 17:41:39 +0800 |
|---|---|---|
| committer | bobzhou <zhoubo8@lenovo.com> | 2018-12-17 17:41:39 +0800 |
| commit | 31560e9a26e6a7e2e65d18924c938ee7a7683fb3 (patch) | |
| tree | 26ec12331a2ec612a0f51c7866fbe41262ca0fe1 /cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst | |
| parent | fc1b7908a77b5cce763f92b3d314057345f3ab7a (diff) | |
upload cyborg base mitaka version
Change-Id: Iff52024026c9eff899246be70cc89fe6e65befff
Signed-off-by: bobzhou <zhoubo8@lenovo.com>
Diffstat (limited to 'cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst')
| -rw-r--r-- | cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst b/cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst new file mode 100644 index 0000000..982a4d1 --- /dev/null +++ b/cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst @@ -0,0 +1,23 @@ +Cyborg REST API v1.0 +******************** + +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}` | ++--------+-----------------------+-------------------------------------------------------------------------------+ + |