Update to correct status tables

Change-Id: I13053b8faddf5c1045d52f047185f309e1ee6a26
This commit is contained in:
Graham Hayes 2017-11-22 19:25:20 +00:00
parent 2f75586379
commit 94f0a7bf49
No known key found for this signature in database
GPG Key ID: 1B263DC59F4AEFD5
16 changed files with 764 additions and 126 deletions

View File

@ -16,9 +16,23 @@ Create Blacklist
Create a Blacklist Create a Blacklist
Normal response codes: 201 Response codes
--------------
Error response codes: 409, 405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 405
- 409
- 500
- 503
Request Parameters Request Parameters
@ -70,11 +84,20 @@ List Blacklists
List all blacklists List all blacklists
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Parameters Request Parameters
------------------ ------------------
@ -116,9 +139,21 @@ Show Blacklist
Show a blacklist Show a blacklist
Normal response codes: 200 .. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Error response codes: 405,404,403,401,400,503
Request Request
@ -217,9 +252,20 @@ Delete a Blacklist
Delete a blacklist Delete a blacklist
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request

View File

@ -13,9 +13,19 @@ Get Project Limits
List project limits List project limits
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -13,11 +13,20 @@ List all Pools
Get the list of Pools. Get the list of Pools.
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
------- -------
@ -67,6 +76,21 @@ Normal response codes: 200
Error response codes: 405,404,403,401,400,503 Error response codes: 405,404,403,401,400,503
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
------- -------

View File

@ -23,9 +23,20 @@ This returns a key:value set of quotas on the system.
They will need a role with the ``All-Projects`` permission to do this. They will need a role with the ``All-Projects`` permission to do this.
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 409,405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -63,9 +74,20 @@ View the quotas for the current project
This returns a key:value set of quotas on the system. This returns a key:value set of quotas on the system.
Normal response codes: 200
Error response codes: 409,405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
- 503
Request Request
@ -115,9 +137,21 @@ This returns a key:value set of quotas on the system.
permission to do this. permission to do this.
Normal response codes: 200
Error response codes: 409,405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Example Request Example
@ -171,9 +205,21 @@ Reset all quotas for a project to default
permission to do this. permission to do this.
Normal response codes: 204
Error response codes: 409,405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request

View File

@ -13,9 +13,20 @@ Create Recordset
Create a recordset in a zone Create a recordset in a zone
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -77,9 +88,19 @@ List Recordsets in a Zone
This lists all recordsets in a zone This lists all recordsets in a zone
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -141,9 +162,20 @@ List all Recordsets owned by project
This lists all recordsets owned by a project in Designate This lists all recordsets owned by a project in Designate
Normal response codes: 200
Error response codes: 405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -204,9 +236,20 @@ Show a Recordset
Show an single recordset Show an single recordset
Normal response codes: 200
Error response codes: 405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -257,9 +300,21 @@ Update a Recordset
Update a recordset Update a recordset
Normal response codes: 202
Error response codes: 405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -319,9 +374,21 @@ Delete a Recordset
Delete a recordset Delete a recordset
Normal response codes: 202
Error response codes: 405,404,403,401,400,503 .. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -373,10 +440,21 @@ Create a MX Recordset
Create a MX recordset in a zone Create a MX recordset in a zone
.. rest_status_code:: success status.yaml
Normal response codes: 202 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Error response codes: 405,404,403,401,400,503
Request Request
@ -437,12 +515,23 @@ Create a SSHFP Recordset
.. rest_method:: POST /v2/zones/{zone_id}/recordsets .. rest_method:: POST /v2/zones/{zone_id}/recordsets
Create a MX recordset in a zone Create a SSHFP recordset in a zone
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -502,12 +591,22 @@ Create a SPF Recordset
.. rest_method:: POST /v2/zones/{zone_id}/recordsets .. rest_method:: POST /v2/zones/{zone_id}/recordsets
Create a MX recordset in a zone Create a SPF recordset in a zone
.. rest_status_code:: success status.yaml
- 202
Normal response codes: 202 .. rest_status_code:: error status.yaml
Error response codes: 405,404,403,401,400,503 - 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -567,13 +666,22 @@ Create a SRV Recordset
.. rest_method:: POST /v2/zones/{zone_id}/recordsets .. rest_method:: POST /v2/zones/{zone_id}/recordsets
Create a MX recordset in a zone Create a SRV recordset in a zone
.. rest_status_code:: success status.yaml
- 202
Normal response codes: 202 .. rest_status_code:: error status.yaml
Error response codes: 405,404,403,401,400,503
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
------- -------

View File

@ -13,9 +13,20 @@ Set FloatingIP's PTR record
Set a PTR record for the given FloatingIP. The domain if it does not exist Set a PTR record for the given FloatingIP. The domain if it does not exist
will be provisioned automatically. will be provisioned automatically.
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -69,9 +80,19 @@ Show FloatingIP's PTR record
Shows a particular FloatingIP PTR Shows a particular FloatingIP PTR
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -115,9 +136,19 @@ List FloatingIP's PTR record
List FloatingIP PTR records List FloatingIP PTR records
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -160,9 +191,19 @@ Unset FloatingIP's PTR record
Unset the PTR record for a FloatingIP Unset the PTR record for a FloatingIP
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -13,9 +13,20 @@ Create Tld
Create a tld Create a tld
Normal response codes: 201 .. rest_status_code:: success status.yaml
Error response codes: 409,405,404,403,401,400,503 - 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -66,9 +77,19 @@ Show Tld
Show a tld Show a tld
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -113,9 +134,19 @@ List Tlds
List the tlds associated with the Project List the tlds associated with the Project
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -162,9 +193,20 @@ Update Tld
Update a tld Update a tld
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -216,9 +258,19 @@ Delete Tld
Delete a tld Delete a tld
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -13,9 +13,20 @@ Create Tsigkeys
Create a new Tsigkey Create a new Tsigkey
Normal response codes: 201 .. rest_status_code:: success status.yaml
Error response codes: 409, 405,404,403,401,400,503 - 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -72,9 +83,19 @@ List Tsigkeys
List all tsigkeys List all tsigkeys
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Parameters Request Parameters
@ -127,9 +148,19 @@ Show a Tsigkey
Show a tsigkey Show a tsigkey
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -176,9 +207,19 @@ Update Tsigkey
Update the attribute(s) of an existing tsigkey Update the attribute(s) of an existing tsigkey
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Parameters Request Parameters
@ -237,9 +278,19 @@ Delete a Tsigkey
Delete a tsigkey Delete a tsigkey
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -10,9 +10,19 @@ List all API versions
.. rest_method:: GET / .. rest_method:: GET /
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -15,9 +15,20 @@ Export a zone.
.. note:: This POST should have no body .. note:: This POST should have no body
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -61,9 +72,19 @@ List all Zone Exports
.. rest_method:: GET /v2/zones/tasks/exports .. rest_method:: GET /v2/zones/tasks/exports
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -110,9 +131,19 @@ Show a Zone Export Information
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id} .. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -156,9 +187,19 @@ Retrive a Zone Export from the Designate Datastore
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export .. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
.. note:: .. note::
This endpoint will send a response with a ``text/dns`` content-type. This endpoint will send a response with a ``text/dns`` content-type.
@ -203,9 +244,19 @@ This will just delete the record of the zone export, not the exported zone.
The zone will have to be deleted from the zone delete API The zone will have to be deleted from the zone delete API
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -15,9 +15,20 @@ Import a zone.
.. note:: This POST should have no body, and the content-type should be text/dns .. note:: This POST should have no body, and the content-type should be text/dns
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -59,9 +70,19 @@ List all Zone Imports
.. rest_method:: GET /v2/zones/tasks/imports .. rest_method:: GET /v2/zones/tasks/imports
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -105,10 +126,19 @@ Show a Zone Import
.. rest_method:: GET /v2/zones/tasks/imports/{zone_import_id} .. rest_method:: GET /v2/zones/tasks/imports/{zone_import_id}
.. rest_status_code:: success status.yaml
Normal response codes: 200 - 200
Error response codes: 405,404,403,401,400,503
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -154,9 +184,19 @@ This will just delete the record of the zone import, not the imported zone.
The zone will have to be deleted from the zone delete API The zone will have to be deleted from the zone delete API
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -16,9 +16,20 @@ Create Zone Transfer Accept
This accepts an offer of a ownership transfer This accepts an offer of a ownership transfer
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -68,10 +79,19 @@ Get Zone Transfer Accept
.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_accept_id} .. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_accept_id}
.. rest_status_code:: success status.yaml
Normal response codes: 200 - 200
Error response codes: 405,404,403,401,400,503
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -115,9 +135,19 @@ List Zone Transfer Accepts
This will list all your accepted ownership transfer. This will list all your accepted ownership transfer.
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -22,9 +22,20 @@ supplied.
.. note:: This POST can have no body. .. note:: This POST can have no body.
Normal response codes: 201 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -79,9 +90,19 @@ List Zone Transfer Requests
This will list all your outgoing requests, and any incoming requests that This will list all your outgoing requests, and any incoming requests that
have been scoped to your project. have been scoped to your project.
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -127,9 +148,19 @@ Show a Zone Transfer Request
.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} .. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -174,9 +205,19 @@ Update a Zone Transfer Request
.. rest_method:: PATCH /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} .. rest_method:: PATCH /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -229,9 +270,19 @@ Delete a Zone Transfer Request
.. rest_method:: DELETE /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} .. rest_method:: DELETE /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -20,9 +20,19 @@ from the backends.
.. warning:: .. warning::
This is a protentially dangerous operation, and should only be used if required This is a protentially dangerous operation, and should only be used if required
Normal response codes: 204 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -61,9 +71,19 @@ This is useful if an upstream server failed to send a notify to Designate
.. important:: This is only useful on SECONDARY zones. .. important:: This is only useful on SECONDARY zones.
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -13,9 +13,20 @@ Create Zone
Create a zone Create a zone
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request Request
@ -81,10 +92,19 @@ List Zones
List all zones List all zones
.. rest_status_code:: success status.yaml
Normal response codes: 200 - 200
Error response codes: 405,404,403,401,400,503
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -148,9 +168,19 @@ Show a Zone
Show a zone Show a zone
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -205,9 +235,19 @@ Get the Name Servers for a Zone
Show the nameservers for a zone Show the nameservers for a zone
Normal response codes: 200 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -249,9 +289,19 @@ Update a Zone
Update the attribute(s) for an existing zone. Update the attribute(s) for an existing zone.
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request
@ -316,9 +366,19 @@ Delete a Zone
Delete a zone Delete a zone
Normal response codes: 202 .. rest_status_code:: success status.yaml
Error response codes: 405,404,403,401,400,503 - 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request Request

View File

@ -1,8 +1,6 @@
200: 200:
default: | default: |
Request was successful. Request was successful.
image-data-200: |
The service lists the image data in the response body.
201: 201:
default: | default: |
Request has been fulfilled and new resource created. Request has been fulfilled and new resource created.