summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorGraham Hayes <gr@ham.ie>2017-11-22 19:25:20 +0000
committerGraham Hayes <gr@ham.ie>2017-11-27 14:31:16 +0000
commit94f0a7bf49d60fc4ccf761d278149c32852ce959 (patch)
tree4e8ad994b71ec6905713b92d32ac9154e5aeb0dd /api-ref
parent2f75586379e8d611f37e06d385e79d0bc2c84ca1 (diff)
downloaddesignate-94f0a7bf49d60fc4ccf761d278149c32852ce959.tar.gz
Update to correct status tables
Change-Id: I13053b8faddf5c1045d52f047185f309e1ee6a26
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/dns-api-v2-blacklist.inc62
-rw-r--r--api-ref/source/dns-api-v2-limits.inc14
-rw-r--r--api-ref/source/dns-api-v2-pool.inc28
-rw-r--r--api-ref/source/dns-api-v2-quota.inc62
-rw-r--r--api-ref/source/dns-api-v2-recordset.inc154
-rw-r--r--api-ref/source/dns-api-v2-reverse-floatingips.inc57
-rw-r--r--api-ref/source/dns-api-v2-tld.inc72
-rw-r--r--api-ref/source/dns-api-v2-tsigkey.inc71
-rw-r--r--api-ref/source/dns-api-v2-version.inc14
-rw-r--r--api-ref/source/dns-api-v2-zone-export.inc71
-rw-r--r--api-ref/source/dns-api-v2-zone-import.inc56
-rw-r--r--api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc42
-rw-r--r--api-ref/source/dns-api-v2-zone-ownership-transfer-request.inc71
-rw-r--r--api-ref/source/dns-api-v2-zone-tasks.inc28
-rw-r--r--api-ref/source/dns-api-v2-zone.inc84
-rw-r--r--api-ref/source/status.yaml2
16 files changed, 763 insertions, 125 deletions
diff --git a/api-ref/source/dns-api-v2-blacklist.inc b/api-ref/source/dns-api-v2-blacklist.inc
index 7a54e009..55d2faff 100644
--- a/api-ref/source/dns-api-v2-blacklist.inc
+++ b/api-ref/source/dns-api-v2-blacklist.inc
@@ -16,9 +16,23 @@ Create 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
@@ -70,10 +84,19 @@ List Blacklists
List all blacklists
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request Parameters
------------------
@@ -116,9 +139,21 @@ Show 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
@@ -217,9 +252,20 @@ 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
diff --git a/api-ref/source/dns-api-v2-limits.inc b/api-ref/source/dns-api-v2-limits.inc
index e0c79d73..0afea292 100644
--- a/api-ref/source/dns-api-v2-limits.inc
+++ b/api-ref/source/dns-api-v2-limits.inc
@@ -13,9 +13,19 @@ Get 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
diff --git a/api-ref/source/dns-api-v2-pool.inc b/api-ref/source/dns-api-v2-pool.inc
index 3f0fcba7..3d0ee9e2 100644
--- a/api-ref/source/dns-api-v2-pool.inc
+++ b/api-ref/source/dns-api-v2-pool.inc
@@ -13,10 +13,19 @@ List all Pools
Get the list of Pools.
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
-------
@@ -67,6 +76,21 @@ 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
-------
diff --git a/api-ref/source/dns-api-v2-quota.inc b/api-ref/source/dns-api-v2-quota.inc
index 5bcc7913..f9f48b53 100644
--- a/api-ref/source/dns-api-v2-quota.inc
+++ b/api-ref/source/dns-api-v2-quota.inc
@@ -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.
-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
@@ -63,9 +74,20 @@ View the quotas for the current project
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
@@ -115,9 +137,21 @@ This returns a key:value set of quotas on the system.
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
@@ -171,9 +205,21 @@ Reset all quotas for a project to default
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
diff --git a/api-ref/source/dns-api-v2-recordset.inc b/api-ref/source/dns-api-v2-recordset.inc
index dda81b25..a84bb640 100644
--- a/api-ref/source/dns-api-v2-recordset.inc
+++ b/api-ref/source/dns-api-v2-recordset.inc
@@ -13,9 +13,20 @@ Create Recordset
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
@@ -77,9 +88,19 @@ List Recordsets in a Zone
This lists all recordsets in a zone
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -141,9 +162,20 @@ 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
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -204,9 +236,20 @@ Show a 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
@@ -257,9 +300,21 @@ 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
@@ -319,9 +374,21 @@ 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
@@ -373,10 +440,21 @@ Create a MX Recordset
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
@@ -437,12 +515,23 @@ Create a SSHFP Recordset
.. 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
@@ -502,12 +591,22 @@ Create a SPF Recordset
.. 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
-Normal response codes: 202
+ - 202
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 409
+ - 503
Request
@@ -567,13 +666,22 @@ Create a SRV Recordset
.. 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
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 409
+ - 503
Request
-------
diff --git a/api-ref/source/dns-api-v2-reverse-floatingips.inc b/api-ref/source/dns-api-v2-reverse-floatingips.inc
index 55dc18b5..ff41d5f7 100644
--- a/api-ref/source/dns-api-v2-reverse-floatingips.inc
+++ b/api-ref/source/dns-api-v2-reverse-floatingips.inc
@@ -13,9 +13,20 @@ Set FloatingIP's PTR record
Set a PTR record for the given FloatingIP. The domain if it does not exist
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
@@ -69,9 +80,19 @@ Show FloatingIP's PTR record
Shows a particular FloatingIP PTR
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -115,9 +136,19 @@ List FloatingIP's PTR record
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
@@ -160,9 +191,19 @@ Unset FloatingIP's PTR record
Unset the PTR record for a FloatingIP
-Normal response codes: 202
+.. rest_status_code:: success status.yaml
+
+ - 202
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-tld.inc b/api-ref/source/dns-api-v2-tld.inc
index 44786c5e..11c6d2a3 100644
--- a/api-ref/source/dns-api-v2-tld.inc
+++ b/api-ref/source/dns-api-v2-tld.inc
@@ -13,9 +13,20 @@ Create 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
@@ -66,9 +77,19 @@ Show Tld
Show a tld
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -113,9 +134,19 @@ List Tlds
List the tlds associated with the Project
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Error response codes: 405,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -162,9 +193,20 @@ Update Tld
Update a tld
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 409
+ - 503
Request
@@ -216,9 +258,19 @@ Delete Tld
Delete a tld
-Normal response codes: 204
+.. rest_status_code:: success status.yaml
+
+ - 204
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-tsigkey.inc b/api-ref/source/dns-api-v2-tsigkey.inc
index 3e489562..025199ff 100644
--- a/api-ref/source/dns-api-v2-tsigkey.inc
+++ b/api-ref/source/dns-api-v2-tsigkey.inc
@@ -13,9 +13,20 @@ Create Tsigkeys
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
@@ -72,9 +83,19 @@ List Tsigkeys
List all tsigkeys
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request Parameters
@@ -127,9 +148,19 @@ Show a Tsigkey
Show a tsigkey
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -176,9 +207,19 @@ Update Tsigkey
Update the attribute(s) of an existing tsigkey
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request Parameters
@@ -237,9 +278,19 @@ Delete a Tsigkey
Delete a tsigkey
-Normal response codes: 204
+.. rest_status_code:: success status.yaml
+
+ - 204
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-version.inc b/api-ref/source/dns-api-v2-version.inc
index e6d8e8ce..b4c9de1f 100644
--- a/api-ref/source/dns-api-v2-version.inc
+++ b/api-ref/source/dns-api-v2-version.inc
@@ -10,9 +10,19 @@ List all API versions
.. 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
diff --git a/api-ref/source/dns-api-v2-zone-export.inc b/api-ref/source/dns-api-v2-zone-export.inc
index 83c04eec..3b13e180 100644
--- a/api-ref/source/dns-api-v2-zone-export.inc
+++ b/api-ref/source/dns-api-v2-zone-export.inc
@@ -15,9 +15,20 @@ Export a zone.
.. 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
@@ -61,9 +72,19 @@ List all Zone Exports
.. rest_method:: GET /v2/zones/tasks/exports
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -110,9 +131,19 @@ Show a Zone Export Information
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -156,9 +187,19 @@ Retrive a Zone Export from the Designate Datastore
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
.. note::
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
-Normal response codes: 204
+.. rest_status_code:: success status.yaml
+
+ - 204
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-zone-import.inc b/api-ref/source/dns-api-v2-zone-import.inc
index 4a417d56..fe515d8a 100644
--- a/api-ref/source/dns-api-v2-zone-import.inc
+++ b/api-ref/source/dns-api-v2-zone-import.inc
@@ -15,9 +15,20 @@ Import a zone.
.. 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
@@ -59,9 +70,19 @@ List all Zone Imports
.. rest_method:: GET /v2/zones/tasks/imports
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -105,10 +126,19 @@ Show a Zone Import
.. 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
@@ -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
-Normal response codes: 204
+.. rest_status_code:: success status.yaml
+
+ - 204
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc b/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
index 90bc9b07..62d3febe 100644
--- a/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
+++ b/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
@@ -16,9 +16,20 @@ Create Zone Transfer Accept
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
@@ -68,10 +79,19 @@ Get Zone Transfer Accept
.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_accept_id}
+.. rest_status_code:: success status.yaml
+
+ - 200
-Normal response codes: 200
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -115,9 +135,19 @@ List Zone Transfer Accepts
This will list all your accepted ownership transfer.
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-zone-ownership-transfer-request.inc b/api-ref/source/dns-api-v2-zone-ownership-transfer-request.inc
index aece818c..a8399bdc 100644
--- a/api-ref/source/dns-api-v2-zone-ownership-transfer-request.inc
+++ b/api-ref/source/dns-api-v2-zone-ownership-transfer-request.inc
@@ -22,9 +22,20 @@ supplied.
.. 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
@@ -79,9 +90,19 @@ List Zone Transfer Requests
This will list all your outgoing requests, and any incoming requests that
have been scoped to your project.
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -127,9 +148,19 @@ Show a Zone Transfer Request
.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -174,9 +205,19 @@ Update a Zone Transfer Request
.. rest_method:: PATCH /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -229,9 +270,19 @@ Delete a Zone Transfer Request
.. rest_method:: DELETE /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
-Normal response codes: 204
+.. rest_status_code:: success status.yaml
+
+ - 204
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-zone-tasks.inc b/api-ref/source/dns-api-v2-zone-tasks.inc
index 06e179df..62a46a33 100644
--- a/api-ref/source/dns-api-v2-zone-tasks.inc
+++ b/api-ref/source/dns-api-v2-zone-tasks.inc
@@ -20,9 +20,19 @@ from the backends.
.. warning::
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
@@ -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.
-Normal response codes: 202
+.. rest_status_code:: success status.yaml
+
+ - 202
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/dns-api-v2-zone.inc b/api-ref/source/dns-api-v2-zone.inc
index 0a1efdcf..f1a48b96 100644
--- a/api-ref/source/dns-api-v2-zone.inc
+++ b/api-ref/source/dns-api-v2-zone.inc
@@ -13,9 +13,20 @@ Create 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
@@ -81,10 +92,19 @@ List Zones
List all zones
+.. rest_status_code:: success status.yaml
+
+ - 200
+
-Normal response codes: 200
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -148,9 +168,19 @@ 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
@@ -205,9 +235,19 @@ Get the Name Servers for a Zone
Show the nameservers for a zone
-Normal response codes: 200
+.. rest_status_code:: success status.yaml
+
+ - 200
-Error response codes: 405,404,403,401,400,503
+
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -249,9 +289,19 @@ Update a Zone
Update the attribute(s) for an existing zone.
-Normal response codes: 202
+.. rest_status_code:: success status.yaml
+
+ - 202
+
-Error response codes: 405,404,403,401,400,503
+.. rest_status_code:: error status.yaml
+
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
@@ -316,9 +366,19 @@ Delete a Zone
Delete a zone
-Normal response codes: 202
+.. rest_status_code:: success status.yaml
+
+ - 202
+
+
+.. rest_status_code:: error status.yaml
-Error response codes: 405,404,403,401,400,503
+ - 400
+ - 401
+ - 403
+ - 404
+ - 405
+ - 503
Request
diff --git a/api-ref/source/status.yaml b/api-ref/source/status.yaml
index 81f60f3b..7bc348c7 100644
--- a/api-ref/source/status.yaml
+++ b/api-ref/source/status.yaml
@@ -1,8 +1,6 @@
200:
default: |
Request was successful.
- image-data-200: |
- The service lists the image data in the response body.
201:
default: |
Request has been fulfilled and new resource created.