Difference between revisions of "StarlingX/Designer REST API Documentation"
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Locations == | + | |
| + | |||
| + | See the [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide] for information on contributing to StarlingX API documentation. | ||
| + | This wiki page has been deprecated. | ||
| + | |||
| + | <!-- == Locations == | ||
OpenStack API working group has defined a guideline to follow for API documentation when a project provides a REST API service. API documentation information comes from RST source files stored in the project repository, that when built, generate HTML files. More details about the OpenStack API documentation can be found at: | OpenStack API working group has defined a guideline to follow for API documentation when a project provides a REST API service. API documentation information comes from RST source files stored in the project repository, that when built, generate HTML files. More details about the OpenStack API documentation can be found at: | ||
| Line 17: | Line 22: | ||
* '''stx-nfv:''' StarlingX NFVI Orchestration | * '''stx-nfv:''' StarlingX NFVI Orchestration | ||
| − | |||
</Proposal> | </Proposal> | ||
| Line 29: | Line 33: | ||
<Proposal> | <Proposal> | ||
| − | |||
== Directory Structures == | == Directory Structures == | ||
| Line 113: | Line 116: | ||
< TEXT - list of normal response codes > | < TEXT - list of normal response codes > | ||
| − | **Error response codes** | + | **Error response codes** |
| − | < TEXT – list of error response codes > | + | < TEXT – list of error response codes > |
**Request parameters** | **Request parameters** | ||
| Line 125: | Line 128: | ||
"name (Optional)", "plain", "xsd:string", "A user-specified name of the cloud system. The default value is the system UUID." | "name (Optional)", "plain", "xsd:string", "A user-specified name of the cloud system. The default value is the system UUID." | ||
< etc. > | < etc. > | ||
| + | |||
:: | :: | ||
| + | |||
< verbatim list of an example REQUEST body > | < verbatim list of an example REQUEST body > | ||
[ | [ | ||
| Line 150: | Line 155: | ||
:: | :: | ||
| + | |||
< verbatim list of an example RESPONSE body > | < verbatim list of an example RESPONSE body > | ||
{ | { | ||
| Line 196: | Line 202: | ||
'''NOTE:''' The PDF build uses a different tox environment and is currently not supported for StarlingX. | '''NOTE:''' The PDF build uses a different tox environment and is currently not supported for StarlingX. | ||
| + | |||
| + | --> | ||
Latest revision as of 18:13, 25 October 2018
See the StarlingX API Contributor Guide for information on contributing to StarlingX API documentation.
This wiki page has been deprecated.
