diff options
author | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2017-04-07 15:28:12 +0900 |
---|---|---|
committer | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2017-05-22 00:19:19 +0000 |
commit | cbf83a01fbe1aa0a3c48714e9ae3932c8b165210 (patch) | |
tree | 2ed3bc2201e540d9c4289379ffb77fc39df5e4a0 /api-ref/source/servers-actions.inc | |
parent | 99bd33402ed70332fb8e141a0c6686674d58f051 (diff) | |
download | nova-cbf83a01fbe1aa0a3c48714e9ae3932c8b165210.tar.gz |
api-ref: Example verification for servers-actions.inc
* Example for the rebuild action
The functional test is modified and
the example is replaced with v2.26 examples.
* Example for the rescue action
The example in API reference is replaced with
the example with 'rescue_imgae_ref'.
Parameters for the rebuild action and the rescue action
are also fixed.
The patch completes the parameter verification and
the example verification of servers-actions.inc.
Change-Id: Iaf8808b13d1fdfead50da4cd447b3893578f76dd
Implements: blueprint api-ref-in-rst-pike
Diffstat (limited to 'api-ref/source/servers-actions.inc')
-rw-r--r-- | api-ref/source/servers-actions.inc | 58 |
1 files changed, 45 insertions, 13 deletions
diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index f0f48dfbd0..290b1f8fa9 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -1,6 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification .. needs:body_verification =========================================== @@ -475,26 +473,60 @@ Request - server_id: server_id_path - rebuild: rebuild - - imageRef: imageRef - - name: server_name_optional + - imageRef: imageRef_rebuild + - accessIPv4: accessIPv4_in + - accessIPv6: accessIPv6_in - adminPass: adminPass_request - metadata: metadata + - name: server_name_optional + - OS-DCF:diskConfig: OS-DCF:diskConfig - personality: personality + - personality.path: path + - personality.contents: contents - preserve_ephemeral: preserve_ephemeral + - description: server_description -**Example Rebuild Server (rebuild Action)** +**Example Rebuild Server (rebuild Action) (v2.26)** -Preserving the ephemeral disk - -.. literalinclude:: ../../doc/api_samples/servers/server-action-rebuild-preserve-ephemeral.json +.. literalinclude:: ../../doc/api_samples/servers/v2.26/server-action-rebuild.json :language: javascript Response -------- -**Example Rebuild Server (rebuild Action)** +.. rest_parameters:: parameters.yaml -.. literalinclude:: ../../doc/api_samples/servers/server-action-rebuild-resp.json + - Location: server_location + - server: server + - accessIPv4: accessIPv4 + - accessIPv6: accessIPv6 + - addresses: addresses_obj + - adminPass: adminPass_response + - created: created + - flavor: flavor + - flavor.id: flavor_id_body + - flavor.links: links + - hostId: hostId + - id: server_id + - image: image + - image.id: image_id_body + - image.links: links + - links: server_links + - metadata: metadata_object + - name: server_name + - OS-DCF:diskConfig: disk_config + - progress: progress + - status: server_status + - tenant_id: tenant_id_body + - updated: updated + - user_id: user_id + - locked: locked + - description: server_description_resp + - tags: tags + +**Example Rebuild Server (rebuild Action) (v2.26)** + +.. literalinclude:: ../../doc/api_samples/servers/v2.26/server-action-rebuild-resp.json :language: javascript Remove (Disassociate) Floating Ip (removeFloatingIp Action) (DEPRECATED) @@ -607,9 +639,9 @@ Request - adminPass: adminPass_rescue_request - rescue_image_ref: rescue_image_ref -**Example Rescue server** +**Example Rescue server (rescue Action)** -.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue-req.json +.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue-req-with-image-ref.json :language: javascript Response @@ -619,7 +651,7 @@ Response - adminPass: adminPass_response -**Example Extended rescue server** +**Example Rescue server (rescue Action)** .. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue.json :language: javascript |