Improve response codes display in api-ref docs

Change-Id: I9fc35783dfd2732be03b10ab67ddd9c6b8137ad4
This commit is contained in:
sonu.kumar 2016-05-20 11:34:28 +09:00
parent d8c6c22f07
commit 96bff5ce77
12 changed files with 84 additions and 43 deletions

View File

@ -14,7 +14,8 @@ List project limits
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -14,7 +14,8 @@ Get the list of Pools.
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -62,7 +63,8 @@ Get a specific Pool
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -14,7 +14,8 @@ Create a recordset in a zone
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -76,7 +77,8 @@ This lists all recordsets in a zone
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -139,7 +141,8 @@ List all Recordsets owned by project
This lists all recordsets owned by a project in Designate
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -201,7 +204,8 @@ Show a Recordset
Show an single recordset
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -253,7 +257,8 @@ Update a Recordset
Update a recordset
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -313,7 +318,8 @@ Delete a Recordset
Delete a recordset
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -14,7 +14,8 @@ Create a tld
Normal response codes: 201
Error response codes:409,405,404,403,401,400,503,
Error response codes: 409,405,404,403,401,400,503
Request
@ -66,7 +67,8 @@ Show a tld
Normal response codes: 200
Error response codes:405,404,403,401,400,503
Error response codes: 405,404,403,401,400,503
Request
@ -112,7 +114,8 @@ List the tlds associated with the Project
Normal response codes: 200
Error response codes:405,403,401,400,503
Error response codes: 405,403,401,400,503
Request
@ -160,7 +163,8 @@ Update a tld
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -213,7 +217,8 @@ Delete Tld
Delete a tld
Normal response codes: 204
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -14,7 +14,8 @@ Create Tsigkeys
Create a new Tsigkey
Normal response codes: 201
Error response codes:409, 405,404,403,401,400,503,
Error response codes: 409, 405,404,403,401,400,503
Request
@ -72,7 +73,8 @@ List all tsigkeys
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request Parameters
@ -126,7 +128,8 @@ Show a tsigkey
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -174,7 +177,8 @@ Update the attribute(s) of an existing tsigkey
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request Parameters
@ -233,7 +237,8 @@ Delete a tsigkey
Normal response codes: 204
Error response codes:405,404,403,401,400,503
Error response codes: 405,404,403,401,400,503
Request

View File

@ -12,7 +12,7 @@ List all API versions
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -16,7 +16,8 @@ Export a zone.
.. note:: This POST should have no body
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -61,7 +62,8 @@ List all Zone Exports
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -110,7 +112,7 @@ Show a Zone Export Information
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -155,7 +157,8 @@ Retrive a Zone Export from the Designate Datastore
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
.. note::
This endpoint will send a response with a ``text/dns`` content-type.

View File

@ -16,7 +16,8 @@ Import a zone.
.. note:: This POST should have no body, and the content-type should be text/dns
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -59,7 +60,8 @@ List all Zone Imports
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -105,7 +107,8 @@ Show a Zone Import
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -152,7 +155,8 @@ The zone will have to be deleted from the zone delete API
Normal response codes: 204
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -17,7 +17,8 @@ This accepts an offer of a ownership transfer
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -63,7 +64,8 @@ Get Zone Transfer Accept
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -23,7 +23,8 @@ supplied.
Normal response codes: 201
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -79,7 +80,8 @@ This will list all your outgoing requests, and any incoming requests that
have been scoped to your project.
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -126,7 +128,8 @@ Show a Zone Transfer Request
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -172,7 +175,8 @@ Update a Zone Transfer Request
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -226,7 +230,8 @@ Delete a Zone Transfer Request
Normal response codes: 204
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -21,7 +21,8 @@ from the backends.
This is a protentially dangerous operation, and should only be used if required
Normal response codes: 204
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -61,7 +62,8 @@ This is useful if an upstream server failed to send a notify to Designate
.. important:: This is only useful on SECONDARY zones.
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request

View File

@ -14,7 +14,8 @@ Create a zone
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -81,7 +82,8 @@ List all zones
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -146,7 +148,8 @@ Show a zone
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -202,7 +205,8 @@ Get the Name Servers for a Zone
Show the nameservers for a zone
Normal response codes: 200
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -245,7 +249,8 @@ Update the attribute(s) for an existing zone.
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request
@ -311,7 +316,8 @@ Delete a zone
Normal response codes: 202
Error response codes:405,404,403,401,400,503,
Error response codes: 405,404,403,401,400,503
Request