From cd04e9e7af7637af6d90fefd865e25fae260959d Mon Sep 17 00:00:00 2001 From: tengqm Date: Sun, 21 Aug 2016 23:15:25 -0400 Subject: api-ref - software config status codes This patch fixes the formatting of status codes returned from API calls. This change is leveraging the new status_code stanza supported by new version of os-api-ref library. Change-Id: Ib108e04b08c88696eadabf7bc32b41f47c0ead80 --- api-ref/source/v1/software-config.inc | 136 +++++++++++++++++++++++++++++----- 1 file changed, 118 insertions(+), 18 deletions(-) (limited to 'api-ref') diff --git a/api-ref/source/v1/software-config.inc b/api-ref/source/v1/software-config.inc index 8ecf33c92..26f8b286a 100644 --- a/api-ref/source/v1/software-config.inc +++ b/api-ref/source/v1/software-config.inc @@ -11,9 +11,18 @@ Create configuration Creates a software configuration. -Normal response codes: 200 +Response Codes +-------------- -Error response codes:404,401,400, +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 Request Parameters ------------------ @@ -64,9 +73,19 @@ List configs Lists all available software configurations. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml -Error response codes: 404,500,401,400 + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ @@ -102,9 +121,18 @@ Show configuration details Shows details for a software configuration. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 -Error response codes: 404,401,400 +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 Request Parameters ------------------ @@ -145,7 +173,18 @@ Delete config Deletes a software configuration. -Normal response codes: 204 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 Request Parameters ------------------ @@ -163,9 +202,18 @@ Create deployment Creates a software deployment. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml -Error response codes: + - 400 + - 401 + - 500 Request Parameters ------------------ @@ -218,9 +266,19 @@ List deployments Lists all available software deployments. -Normal response codes: 200 +Response Codes +-------------- -Error response codes: 404,500,401,400 +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ @@ -261,9 +319,19 @@ Show deployment details Shows details for a software deployment. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml -Error response codes: + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ @@ -304,9 +372,19 @@ Update deployment Updates a software deployment. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 -Error response codes: +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ @@ -358,7 +436,19 @@ Delete deployment Deletes a software deployment. -Normal response codes: 204 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 204 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ @@ -378,9 +468,19 @@ Shows the deployment configuration metadata for a server. Use the ``group`` property to specify the configuration hook to which the pass the metadata item. -Normal response codes: 200 +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml -Error response codes: + - 400 + - 401 + - 404 + - 500 Request Parameters ------------------ -- cgit v1.2.1