From d68e80ce444278552b11abed77a8d487a8351d98 Mon Sep 17 00:00:00 2001 From: Pushkar Umaranikar Date: Wed, 11 May 2016 14:41:25 +0000 Subject: [PATCH] method verification for server-action-remote-consoles Verify and update the response codes for the methods based on what is in the code. part of blueprint: api-ref-in-rst Change-Id: Ia84f61c8529a20f2d5ebe97939dc8ee45d8679b9 --- .../source/servers-action-remote-consoles.inc | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/api-ref/source/servers-action-remote-consoles.inc b/api-ref/source/servers-action-remote-consoles.inc index 8b92d4e5dd17..666ba0742024 100644 --- a/api-ref/source/servers-action-remote-consoles.inc +++ b/api-ref/source/servers-action-remote-consoles.inc @@ -1,10 +1,9 @@ .. -*- rst -*- -.. needs:method_verification .. needs:parameter_verification .. needs:example_verification .. needs:body_verification -Get Rdp Console (Os-Getrdpconsole Action) +Get Rdp Console (os-getRDPConsole Action) ========================================= .. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action @@ -15,8 +14,8 @@ Specify the ``os-getRDPConsole`` action in the request body. Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), notImplemented(501) Request ------- @@ -27,7 +26,7 @@ Request - server_id: server_id - os-getRDPConsole: os-getRDPConsole -**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request** +**Example Get Rdp Console (os-getRDPConsole Action): JSON request** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json :language: javascript @@ -35,12 +34,12 @@ Request Response -------- -**Example Get Rdp Console (Os-Getrdpconsole Action): JSON response** +**Example Get Rdp Console (os-getRDPConsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-resp.json :language: javascript -Get Serial Console (Os-Getserialconsole Action) +Get Serial Console (os-getSerialConsole Action) =============================================== .. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action @@ -51,8 +50,8 @@ Specify the ``os-getSerialConsole`` action in the request body. Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), notImplemented(501) Request ------- @@ -63,7 +62,7 @@ Request - server_id: server_id - os-getSerialConsole: os-getSerialConsole -**Example Get Serial Console (Os-Getserialconsole Action): JSON request** +**Example Get Serial Console (os-getSerialConsole Action): JSON request** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-req.json :language: javascript @@ -71,12 +70,12 @@ Request Response -------- -**Example Get Serial Console (Os-Getserialconsole Action): JSON response** +**Example Get Serial Console (os-getSerialConsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-resp.json :language: javascript -Get Spice Console (Os-Getspiceconsole Action) +Get Spice Console (os-getSPICEConsole Action) ============================================= .. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action @@ -87,8 +86,8 @@ Specify the ``os-getSPICEConsole`` action in the request body. Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), notImplemented(501) Request ------- @@ -99,7 +98,7 @@ Request - server_id: server_id - os-getSPICEConsole: os-getSPICEConsole -**Example Get Spice Console (Os-Getspiceconsole Action): JSON request** +**Example Get Spice Console (os-getSPICEConsole Action): JSON request** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-req.json :language: javascript @@ -107,12 +106,12 @@ Request Response -------- -**Example Get Spice Console (Os-Getspiceconsole Action): JSON response** +**Example Get Spice Console (os-getSPICEConsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-resp.json :language: javascript -Get Vnc Console (Os-Getvncconsole Action) +Get Vnc Console (os-getVNCConsole Action) ========================================= .. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action @@ -123,8 +122,8 @@ Specify the ``os-getVNCConsole`` action in the request body. Normal response codes: 200 -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), +conflict(409), notImplemented(501) Request ------- @@ -135,7 +134,7 @@ Request - server_id: server_id - os-getVNCConsole: os-getVNCConsole -**Example Get Vnc Console (Os-Getvncconsole Action): JSON request** +**Example Get Vnc Console (os-getVNCConsole Action): JSON request** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-req.json :language: javascript @@ -143,7 +142,7 @@ Request Response -------- -**Example Get Vnc Console (Os-Getvncconsole Action): JSON response** +**Example Get Vnc Console (os-getVNCConsole Action): JSON response** .. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-resp.json :language: javascript