From d04e41e72ba69192cfdaf879c46c389a78e80074 Mon Sep 17 00:00:00 2001 From: Radoslav Gerganov Date: Tue, 12 Jul 2016 17:20:47 +0300 Subject: [PATCH] Fix API doc for os-console-auth-tokens There are multiple errors in the API doc for os-console-auth-tokens (name, description, params). This patch fixes them. Closes-Bug: #1602293 Change-Id: Ia3d678b4d9fc5b768088224d0338c8e97c761b3c --- api-ref/source/os-consoles.inc | 14 +++++++------- api-ref/source/parameters.yaml | 12 ++++++++++++ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index b3251ec094..22e975de6f 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -1,7 +1,7 @@ .. -*- rst -*- =============================================================== - Server consoles (servers, os-consoles, os-console-auth-token) + Server consoles (servers, os-consoles, os-console-auth-tokens) =============================================================== Manages server consoles. @@ -138,10 +138,10 @@ Response There is no body content for the response of a successful DELETE query -Show Console Authentication Token -================================= +Show Console Connection Information +=================================== -.. rest_method:: GET /servers/{server_id}/os-console-auth-token +.. rest_method:: GET /os-console-auth-tokens/{console_token} Given the console authentication token for a server instance, shows the related connection information. @@ -159,7 +159,7 @@ Request .. rest_parameters:: parameters.yaml - - server_id: server_id + - console_token: console_token | @@ -169,9 +169,9 @@ Response .. rest_parameters:: parameters.yaml - console: console - - instance_uuid: instance_id + - instance_uuid: instance_id_body - host: console_host - - port: port + - port: port_number - internal_access_path: internal_access_path | diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 3b3247da66..4665c44120 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -85,6 +85,12 @@ console_id: in: path required: true type: string +console_token: + description: | + Console authentication token. + in: path + required: true + type: string disabled_reason: description: | The reason for disabling a service. @@ -3409,6 +3415,12 @@ port_id_resp: in: body required: true type: string +port_number: + description: | + The port number. + in: body + required: true + type: integer port_state: description: | The port state.