Improve API Documentation for v2 API
This patch modifies the following for the API Documentation for v2 API: [1] Added 400 code - All APIs return "400 Bad Request" if the validation check in the Version header fails. [2] Added 406 code - All APIs except api_versions return "406 Not Acceptable" if an unsupported version is set in the Version header. [3] Removed 422 code - It is not necessary to describe the "422 Unprocessable Entity" error that occurs after returning "202 Accepted" in the response. Change-Id: I8565c12a69ca75f6c7934e351b5f76ca093ffb02
This commit is contained in:
parent
3ce72ac65f
commit
0e3793b1a2
|
@ -244,7 +244,6 @@ Response Codes
|
|||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -282,6 +281,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
|
@ -313,6 +313,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
|
@ -620,7 +621,6 @@ Response Codes
|
|||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -730,7 +730,6 @@ Response Codes
|
|||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -806,7 +805,6 @@ Response Codes
|
|||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -840,6 +838,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
|
@ -1127,10 +1126,11 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -1156,11 +1156,11 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
@ -1300,8 +1300,10 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
- 409
|
||||
- 422
|
||||
|
||||
|
@ -1339,6 +1341,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 406
|
||||
- 422
|
||||
|
@ -1416,6 +1419,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
|
@ -1443,6 +1447,7 @@ Response Codes
|
|||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 400
|
||||
- 401
|
||||
- 404
|
||||
- 406
|
||||
|
|
Loading…
Reference in New Issue