From a5bbe90eb771e3d4614762a73f28a254bf2f87ed Mon Sep 17 00:00:00 2001 From: zhangbailin <zhangbailin@inspur.com> Date: Tue, 12 Dec 2017 16:49:31 +0800 Subject: [PATCH] Add instructions for the Error response codes Improve the http return code information, for easy reading and calling Change-Id: I0fa54e084070a6407d732e69ca30f6079b923f33 --- api-ref/source/v2/limits.inc | 2 +- api-ref/source/v2/qos-specs-v2-qos-specs.inc | 4 +++- api-ref/source/v2/quota-classes.inc | 4 ++-- api-ref/source/v3/limits.inc | 2 +- api-ref/source/v3/qos-specs-v3-qos-specs.inc | 4 +++- api-ref/source/v3/quota-classes.inc | 4 ++-- 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/api-ref/source/v2/limits.inc b/api-ref/source/v2/limits.inc index 668e05ffac3..7503d434a02 100644 --- a/api-ref/source/v2/limits.inc +++ b/api-ref/source/v2/limits.inc @@ -22,7 +22,7 @@ for the item is infinite. Normal response codes: 200 -Error response codes: 403 +Error response codes: forbidden(403) Request ------- diff --git a/api-ref/source/v2/qos-specs-v2-qos-specs.inc b/api-ref/source/v2/qos-specs-v2-qos-specs.inc index 0bce3193ae3..64514c19087 100644 --- a/api-ref/source/v2/qos-specs-v2-qos-specs.inc +++ b/api-ref/source/v2/qos-specs-v2-qos-specs.inc @@ -141,7 +141,9 @@ Shows details for a QoS specification. Normal response codes: 200 -Error response codes: 413, 405, 404, 403, 401, 400, 503 +Error response codes: Request Entity Too Large(413), badMethod(405), +itemNotFound(404), forbidden(403), unauthorized(401), badRequest(400), +serviceUnavailable(503) Request diff --git a/api-ref/source/v2/quota-classes.inc b/api-ref/source/v2/quota-classes.inc index ed7e90c86a5..6a13272d822 100644 --- a/api-ref/source/v2/quota-classes.inc +++ b/api-ref/source/v2/quota-classes.inc @@ -17,7 +17,7 @@ resource exists, then the default value will be reported. Normal response codes: 200 -Error response codes: 403, 404 +Error response codes: forbidden(403), itemNotFound(404) Request @@ -60,7 +60,7 @@ exist, then the API will create one. Normal response codes: 200 -Error response codes: 400, 403, 404 +Error response codes: badRequest(400), forbidden(403), itemNotFound(404) Request diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index dfe96e1c051..0e6909e9fbf 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -22,7 +22,7 @@ for the item is infinite. Normal response codes: 200 -Error response codes: 403 +Error response codes: forbidden(403) Request ------- diff --git a/api-ref/source/v3/qos-specs-v3-qos-specs.inc b/api-ref/source/v3/qos-specs-v3-qos-specs.inc index ac7ff77f78e..a765c049ca8 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -146,7 +146,9 @@ Shows details for a QoS specification. Normal response codes: 200 -Error response codes: 413,405,404,403,401,400,503 +Error response codes: Request Entity Too Large(413), badMethod(405), +itemNotFound(404), forbidden(403), unauthorized(401), badRequest(400), +serviceUnavailable(503) Request diff --git a/api-ref/source/v3/quota-classes.inc b/api-ref/source/v3/quota-classes.inc index 3de6e4376ef..9653c60a3ec 100644 --- a/api-ref/source/v3/quota-classes.inc +++ b/api-ref/source/v3/quota-classes.inc @@ -17,7 +17,7 @@ resource exists, then the default value will be reported. Normal response codes: 200 -Error response codes: 403, 404 +Error response codes: forbidden(403), itemNotFound(404) Request @@ -61,7 +61,7 @@ exist, then the API will create one. Normal response codes: 200 -Error response codes: 400, 403, 404 +Error response codes: badRequest(400), forbidden(403), itemNotFound(404) Request