From 0d4127aac9eb900a7fff406a3d5e54ada18eda49 Mon Sep 17 00:00:00 2001
From: Karen Bradshaw <kbhawkey@gmail.com>
Date: Tue, 10 May 2016 11:11:45 -0400
Subject: [PATCH] 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
---
api-ref/source/servers-action-shelve.inc | 31 ++++++++++++++++++------
1 file changed, 23 insertions(+), 8 deletions(-)
diff --git a/api-ref/source/servers-action-shelve.inc b/api-ref/source/servers-action-shelve.inc
index c17d35fb7c7c..f294ca31e416 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.