API Ref: update server_id params

- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
  Review and change as needed.

Implements: bp/api-ref-in-rst-ocata

Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
This commit is contained in:
Karen Bradshaw
2016-10-10 14:50:17 -04:00
parent f21ba22fa9
commit 168a500570
13 changed files with 168 additions and 182 deletions
+15 -15
View File
@@ -29,7 +29,7 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
Response
--------
@@ -38,7 +38,7 @@ Response
- metadata: metadata_object
**Example List All Metadata:**
**Example List All Metadata**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
:language: javascript
@@ -65,10 +65,10 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- metadata: metadata_object
**Example Update Metadata Items:**
**Example Update Metadata Items**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
:language: javascript
@@ -80,7 +80,7 @@ Response
- metadata: metadata_object
**Example Update Metadata Items:**
**Example Update Metadata Items**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
:language: javascript
@@ -107,10 +107,10 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- metadata: metadata_object
**Example Create Or Replace Metadata Items:**
**Example Create Or Replace Metadata Items**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
:language: javascript
@@ -122,7 +122,7 @@ Response
- metadata: metadata_object
**Example Create Or Replace Metadata Items:**
**Example Create Or Replace Metadata Items**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
:language: javascript
@@ -146,7 +146,7 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- key: key
Response
@@ -156,7 +156,7 @@ Response
- meta: metadata_object
**Example Show Metadata Item Details:**
**Example Show Metadata Item Details**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
:language: javascript
@@ -183,10 +183,10 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- key: key
**Example Create Or Update Metadata Item:**
**Example Create Or Update Metadata Item**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-req.json
:language: javascript
@@ -198,7 +198,7 @@ Response
- meta: metadata_object
**Example Create Or Update Metadata Item:**
**Example Create Or Update Metadata Item**
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
:language: javascript
@@ -222,10 +222,10 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- key: key
Response
--------
There is no body content for the response of a successful DELETE action.
If successful, this method does not return content in the response body.