openstack/nova
Code Issues Proposed changes

api-ref: servers-action-shelve.inc

Browse Source 
-Fixed headers to match method names.
-Verified methods and content.
-Verified parameters in parameters.yaml.
-Removed empty response sections and added
 a line between request param table and example.
-Todo: verify the example string for each action (null).

Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf
This commit is contained in:
Karen Bradshaw 2016-05-10 11:11:45 -04:00
parent bd23817207
commit 0d4127aac9
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
api-ref/source/servers-action-shelve.inc
View File

@ -1,9 +1,8 @@
.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Shelve Server (Shelve Action)
Shelve Server (shelve Action)
=============================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
@ -45,15 +44,21 @@ Request
- server_id: server_id
- shelve: shelve
**Example Shelve server: JSON request**
|
**Example Shelve server (shelve Action):**
.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve.json
:language: javascript
Response
--------
Shelf-Offload (Remove) Server (Shelveoffload Action)
No body is returned on successful request.
Shelf-Offload (Remove) Server (shelveOffload Action)
====================================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
@ -93,15 +98,21 @@ Request
- server_id: server_id
- shelveOffload: shelveOffload
**Example Shelve server: JSON request**
|
**Example Shelf-Offload server (shelveOffload Action)**
.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve-offload.json
:language: javascript
Response
--------
Unshelve (Restore) Shelved Server (Unshelve Action)
No body is returned on successful request.
Unshelve (Restore) Shelved Server (unshelve Action)
===================================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
@ -141,11 +152,15 @@ Request
- server_id: server_id
- unshelve: unshelve
**Example Unshelve server: JSON request**
|
**Example Unshelve server (unshelve Action):**
.. literalinclude:: ../../doc/api_samples/os-shelve/os-unshelve.json
:language: javascript
Response
--------
No body is returned on successful request.