summaryrefslogtreecommitdiff
path: root/api-ref/source/servers-action-shelve.inc
diff options
context:
space:
mode:
authorKaren Bradshaw <kbhawkey@gmail.com>2016-05-10 11:11:45 -0400
committerKaren Bradshaw <kbhawkey@gmail.com>2016-05-11 08:45:51 -0400
commit0d4127aac9eb900a7fff406a3d5e54ada18eda49 (patch)
tree2b28ba1b69d5193c16d51a60d166362765b5ee51 /api-ref/source/servers-action-shelve.inc
parentbd23817207af97f7869a77ae2aa4f1b98a67a2a5 (diff)
downloadnova-0d4127aac9eb900a7fff406a3d5e54ada18eda49.tar.gz
api-ref: servers-action-shelve.inc
-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
Diffstat (limited to 'api-ref/source/servers-action-shelve.inc')
-rw-r--r--api-ref/source/servers-action-shelve.inc31
1 files changed, 23 insertions, 8 deletions
diff --git a/api-ref/source/servers-action-shelve.inc b/api-ref/source/servers-action-shelve.inc
index c17d35fb7c..f294ca31e4 100644
--- a/api-ref/source/servers-action-shelve.inc
+++ b/api-ref/source/servers-action-shelve.inc
@@ -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.