summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-12-04 17:04:08 +0000
committerGerrit Code Review <review@openstack.org>2017-12-04 17:04:08 +0000
commit0c702e17518e0a09d312981fc3d04c86faffd1f1 (patch)
tree1d6ec1893017106bae50deb37dc541a61f5d2287
parentc860fa5f2e855be04295d1d7549e842e7040b2e5 (diff)
parent94f0a7bf49d60fc4ccf761d278149c32852ce959 (diff)
Merge "Update to correct status tables"
-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 7a54e00..55d2faf 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
16 16
17Create a Blacklist 17Create a Blacklist
18 18
19Normal response codes: 201 19Response codes
20--------------
20 21
21Error response codes: 409, 405,404,403,401,400,503 22.. rest_status_code:: success status.yaml
23
24 - 201
25
26
27.. rest_status_code:: error status.yaml
28
29 - 400
30 - 401
31 - 403
32 - 405
33 - 409
34 - 500
35 - 503
22 36
23 37
24Request Parameters 38Request Parameters
@@ -70,10 +84,19 @@ List Blacklists
70List all blacklists 84List all blacklists
71 85
72 86
73Normal response codes: 200 87.. rest_status_code:: success status.yaml
88
89 - 200
74 90
75Error response codes: 405,404,403,401,400,503
76 91
92.. rest_status_code:: error status.yaml
93
94 - 400
95 - 401
96 - 403
97 - 404
98 - 405
99 - 503
77 100
78Request Parameters 101Request Parameters
79------------------ 102------------------
@@ -116,9 +139,21 @@ Show Blacklist
116Show a blacklist 139Show a blacklist
117 140
118 141
119Normal response codes: 200 142.. rest_status_code:: success status.yaml
143
144 - 200
145
146
147.. rest_status_code:: error status.yaml
148
149 - 400
150 - 401
151 - 403
152 - 404
153 - 405
154 - 409
155 - 503
120 156
121Error response codes: 405,404,403,401,400,503
122 157
123 158
124Request 159Request
@@ -217,9 +252,20 @@ Delete a Blacklist
217Delete a blacklist 252Delete a blacklist
218 253
219 254
220Normal response codes: 204 255.. rest_status_code:: success status.yaml
221 256
222Error response codes: 405,404,403,401,400,503 257 - 204
258
259
260.. rest_status_code:: error status.yaml
261
262 - 400
263 - 401
264 - 403
265 - 404
266 - 405
267 - 409
268 - 503
223 269
224 270
225Request 271Request
diff --git a/api-ref/source/dns-api-v2-limits.inc b/api-ref/source/dns-api-v2-limits.inc
index e0c79d7..0afea29 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
13List project limits 13List project limits
14 14
15 15
16Normal response codes: 200 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 405,404,403,401,400,503 18 - 200
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 503
19 29
20 30
21Request 31Request
diff --git a/api-ref/source/dns-api-v2-pool.inc b/api-ref/source/dns-api-v2-pool.inc
index 3f0fcba..3d0ee9e 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
13Get the list of Pools. 13Get the list of Pools.
14 14
15 15
16Normal response codes: 200 16.. rest_status_code:: success status.yaml
17
18 - 200
17 19
18Error response codes: 405,404,403,401,400,503
19 20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 503
20 29
21Request 30Request
22------- 31-------
@@ -67,6 +76,21 @@ Normal response codes: 200
67Error response codes: 405,404,403,401,400,503 76Error response codes: 405,404,403,401,400,503
68 77
69 78
79.. rest_status_code:: success status.yaml
80
81 - 200
82
83
84.. rest_status_code:: error status.yaml
85
86 - 400
87 - 401
88 - 403
89 - 404
90 - 405
91 - 503
92
93
70Request 94Request
71------- 95-------
72 96
diff --git a/api-ref/source/dns-api-v2-quota.inc b/api-ref/source/dns-api-v2-quota.inc
index 5bcc791..f9f48b5 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.
23 They will need a role with the ``All-Projects`` permission to do this. 23 They will need a role with the ``All-Projects`` permission to do this.
24 24
25 25
26Normal response codes: 200 26.. rest_status_code:: success status.yaml
27 27
28Error response codes: 409,405,404,403,401,400,503 28 - 200
29
30
31.. rest_status_code:: error status.yaml
32
33 - 400
34 - 401
35 - 403
36 - 404
37 - 405
38 - 409
39 - 503
29 40
30 41
31Request 42Request
@@ -63,9 +74,20 @@ View the quotas for the current project
63 74
64This returns a key:value set of quotas on the system. 75This returns a key:value set of quotas on the system.
65 76
66Normal response codes: 200
67 77
68Error response codes: 409,405,404,403,401,400,503 78.. rest_status_code:: success status.yaml
79
80 - 200
81
82
83.. rest_status_code:: error status.yaml
84
85 - 400
86 - 401
87 - 403
88 - 404
89 - 409
90 - 503
69 91
70 92
71Request 93Request
@@ -115,9 +137,21 @@ This returns a key:value set of quotas on the system.
115 permission to do this. 137 permission to do this.
116 138
117 139
118Normal response codes: 200
119 140
120Error response codes: 409,405,404,403,401,400,503 141.. rest_status_code:: success status.yaml
142
143 - 200
144
145
146.. rest_status_code:: error status.yaml
147
148 - 400
149 - 401
150 - 403
151 - 404
152 - 405
153 - 409
154 - 503
121 155
122 156
123Request Example 157Request Example
@@ -171,9 +205,21 @@ Reset all quotas for a project to default
171 permission to do this. 205 permission to do this.
172 206
173 207
174Normal response codes: 204
175 208
176Error response codes: 409,405,404,403,401,400,503 209.. rest_status_code:: success status.yaml
210
211 - 204
212
213
214.. rest_status_code:: error status.yaml
215
216 - 400
217 - 401
218 - 403
219 - 404
220 - 405
221 - 409
222 - 503
177 223
178 224
179Request 225Request
diff --git a/api-ref/source/dns-api-v2-recordset.inc b/api-ref/source/dns-api-v2-recordset.inc
index dda81b2..a84bb64 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
13Create a recordset in a zone 13Create a recordset in a zone
14 14
15 15
16Normal response codes: 202 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 405,404,403,401,400,503 18 - 202
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 409
29 - 503
19 30
20 31
21Request 32Request
@@ -77,9 +88,19 @@ List Recordsets in a Zone
77This lists all recordsets in a zone 88This lists all recordsets in a zone
78 89
79 90
80Normal response codes: 200 91.. rest_status_code:: success status.yaml
92
93 - 200
94
81 95
82Error response codes: 405,404,403,401,400,503 96.. rest_status_code:: error status.yaml
97
98 - 400
99 - 401
100 - 403
101 - 404
102 - 405
103 - 503
83 104
84 105
85Request 106Request
@@ -141,9 +162,20 @@ List all Recordsets owned by project
141 162
142This lists all recordsets owned by a project in Designate 163This lists all recordsets owned by a project in Designate
143 164
144Normal response codes: 200
145 165
146Error response codes: 405,404,403,401,400,503 166.. rest_status_code:: success status.yaml
167
168 - 200
169
170
171.. rest_status_code:: error status.yaml
172
173 - 400
174 - 401
175 - 403
176 - 404
177 - 405
178 - 503
147 179
148 180
149Request 181Request
@@ -204,9 +236,20 @@ Show a Recordset
204 236
205Show an single recordset 237Show an single recordset
206 238
207Normal response codes: 200
208 239
209Error response codes: 405,404,403,401,400,503 240.. rest_status_code:: success status.yaml
241
242 - 200
243
244
245.. rest_status_code:: error status.yaml
246
247 - 400
248 - 401
249 - 403
250 - 404
251 - 405
252 - 503
210 253
211 254
212Request 255Request
@@ -257,9 +300,21 @@ Update a Recordset
257 300
258Update a recordset 301Update a recordset
259 302
260Normal response codes: 202
261 303
262Error response codes: 405,404,403,401,400,503 304.. rest_status_code:: success status.yaml
305
306 - 202
307
308
309.. rest_status_code:: error status.yaml
310
311 - 400
312 - 401
313 - 403
314 - 404
315 - 405
316 - 409
317 - 503
263 318
264 319
265Request 320Request
@@ -319,9 +374,21 @@ Delete a Recordset
319 374
320Delete a recordset 375Delete a recordset
321 376
322Normal response codes: 202
323 377
324Error response codes: 405,404,403,401,400,503 378.. rest_status_code:: success status.yaml
379
380 - 202
381
382
383.. rest_status_code:: error status.yaml
384
385 - 400
386 - 401
387 - 403
388 - 404
389 - 405
390 - 503
391
325 392
326 393
327Request 394Request
@@ -373,10 +440,21 @@ Create a MX Recordset
373 440
374Create a MX recordset in a zone 441Create a MX recordset in a zone
375 442
443.. rest_status_code:: success status.yaml
376 444
377Normal response codes: 202 445 - 202
446
447
448.. rest_status_code:: error status.yaml
449
450 - 400
451 - 401
452 - 403
453 - 404
454 - 405
455 - 409
456 - 503
378 457
379Error response codes: 405,404,403,401,400,503
380 458
381 459
382Request 460Request
@@ -437,12 +515,23 @@ Create a SSHFP Recordset
437 515
438.. rest_method:: POST /v2/zones/{zone_id}/recordsets 516.. rest_method:: POST /v2/zones/{zone_id}/recordsets
439 517
440Create a MX recordset in a zone 518Create a SSHFP recordset in a zone
441 519
442 520
443Normal response codes: 202 521.. rest_status_code:: success status.yaml
444 522
445Error response codes: 405,404,403,401,400,503 523 - 202
524
525
526.. rest_status_code:: error status.yaml
527
528 - 400
529 - 401
530 - 403
531 - 404
532 - 405
533 - 409
534 - 503
446 535
447 536
448Request 537Request
@@ -502,12 +591,22 @@ Create a SPF Recordset
502 591
503.. rest_method:: POST /v2/zones/{zone_id}/recordsets 592.. rest_method:: POST /v2/zones/{zone_id}/recordsets
504 593
505Create a MX recordset in a zone 594Create a SPF recordset in a zone
506 595
596.. rest_status_code:: success status.yaml
507 597
508Normal response codes: 202 598 - 202
509 599
510Error response codes: 405,404,403,401,400,503 600
601.. rest_status_code:: error status.yaml
602
603 - 400
604 - 401
605 - 403
606 - 404
607 - 405
608 - 409
609 - 503
511 610
512 611
513Request 612Request
@@ -567,13 +666,22 @@ Create a SRV Recordset
567 666
568.. rest_method:: POST /v2/zones/{zone_id}/recordsets 667.. rest_method:: POST /v2/zones/{zone_id}/recordsets
569 668
570Create a MX recordset in a zone 669Create a SRV recordset in a zone
670
671.. rest_status_code:: success status.yaml
571 672
673 - 202
572 674
573Normal response codes: 202
574 675
575Error response codes: 405,404,403,401,400,503 676.. rest_status_code:: error status.yaml
576 677
678 - 400
679 - 401
680 - 403
681 - 404
682 - 405
683 - 409
684 - 503
577 685
578Request 686Request
579------- 687-------
diff --git a/api-ref/source/dns-api-v2-reverse-floatingips.inc b/api-ref/source/dns-api-v2-reverse-floatingips.inc
index 55dc18b..ff41d5f 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
13Set a PTR record for the given FloatingIP. The domain if it does not exist 13Set a PTR record for the given FloatingIP. The domain if it does not exist
14will be provisioned automatically. 14will be provisioned automatically.
15 15
16Normal response codes: 202 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 405,404,403,401,400,503 18 - 202
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 409
29 - 503
19 30
20 31
21Request 32Request
@@ -69,9 +80,19 @@ Show FloatingIP's PTR record
69 80
70Shows a particular FloatingIP PTR 81Shows a particular FloatingIP PTR
71 82
72Normal response codes: 200 83.. rest_status_code:: success status.yaml
84
85 - 200
86
87
88.. rest_status_code:: error status.yaml
73 89
74Error response codes: 405,404,403,401,400,503 90 - 400
91 - 401
92 - 403
93 - 404
94 - 405
95 - 503
75 96
76 97
77Request 98Request
@@ -115,9 +136,19 @@ List FloatingIP's PTR record
115 136
116List FloatingIP PTR records 137List FloatingIP PTR records
117 138
118Normal response codes: 200 139.. rest_status_code:: success status.yaml
119 140
120Error response codes: 405,404,403,401,400,503 141 - 200
142
143
144.. rest_status_code:: error status.yaml
145
146 - 400
147 - 401
148 - 403
149 - 404
150 - 405
151 - 503
121 152
122 153
123Request 154Request
@@ -160,9 +191,19 @@ Unset FloatingIP's PTR record
160 191
161Unset the PTR record for a FloatingIP 192Unset the PTR record for a FloatingIP
162 193
163Normal response codes: 202 194.. rest_status_code:: success status.yaml
195
196 - 202
197
198
199.. rest_status_code:: error status.yaml
164 200
165Error response codes: 405,404,403,401,400,503 201 - 400
202 - 401
203 - 403
204 - 404
205 - 405
206 - 503
166 207
167 208
168Request 209Request
diff --git a/api-ref/source/dns-api-v2-tld.inc b/api-ref/source/dns-api-v2-tld.inc
index 44786c5..11c6d2a 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
13Create a tld 13Create a tld
14 14
15 15
16Normal response codes: 201 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 409,405,404,403,401,400,503 18 - 201
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 409
29 - 503
19 30
20 31
21Request 32Request
@@ -66,9 +77,19 @@ Show Tld
66Show a tld 77Show a tld
67 78
68 79
69Normal response codes: 200 80.. rest_status_code:: success status.yaml
81
82 - 200
70 83
71Error response codes: 405,404,403,401,400,503 84
85.. rest_status_code:: error status.yaml
86
87 - 400
88 - 401
89 - 403
90 - 404
91 - 405
92 - 503
72 93
73 94
74Request 95Request
@@ -113,9 +134,19 @@ List Tlds
113List the tlds associated with the Project 134List the tlds associated with the Project
114 135
115 136
116Normal response codes: 200 137.. rest_status_code:: success status.yaml
138
139 - 200
140
117 141
118Error response codes: 405,403,401,400,503 142.. rest_status_code:: error status.yaml
143
144 - 400
145 - 401
146 - 403
147 - 404
148 - 405
149 - 503
119 150
120 151
121Request 152Request
@@ -162,9 +193,20 @@ Update Tld
162Update a tld 193Update a tld
163 194
164 195
165Normal response codes: 200 196.. rest_status_code:: success status.yaml
197
198 - 200
199
200
201.. rest_status_code:: error status.yaml
166 202
167Error response codes: 405,404,403,401,400,503 203 - 400
204 - 401
205 - 403
206 - 404
207 - 405
208 - 409
209 - 503
168 210
169 211
170Request 212Request
@@ -216,9 +258,19 @@ Delete Tld
216 258
217Delete a tld 259Delete a tld
218 260
219Normal response codes: 204 261.. rest_status_code:: success status.yaml
262
263 - 204
264
265
266.. rest_status_code:: error status.yaml
220 267
221Error response codes: 405,404,403,401,400,503 268 - 400
269 - 401
270 - 403
271 - 404
272 - 405
273 - 503
222 274
223 275
224Request 276Request
diff --git a/api-ref/source/dns-api-v2-tsigkey.inc b/api-ref/source/dns-api-v2-tsigkey.inc
index 3e48956..025199f 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
13 13
14Create a new Tsigkey 14Create a new Tsigkey
15 15
16Normal response codes: 201 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 409, 405,404,403,401,400,503 18 - 201
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 409
29 - 503
19 30
20 31
21Request 32Request
@@ -72,9 +83,19 @@ List Tsigkeys
72List all tsigkeys 83List all tsigkeys
73 84
74 85
75Normal response codes: 200 86.. rest_status_code:: success status.yaml
87
88 - 200
76 89
77Error response codes: 405,404,403,401,400,503 90
91.. rest_status_code:: error status.yaml
92
93 - 400
94 - 401
95 - 403
96 - 404
97 - 405
98 - 503
78 99
79 100
80Request Parameters 101Request Parameters
@@ -127,9 +148,19 @@ Show a Tsigkey
127Show a tsigkey 148Show a tsigkey
128 149
129 150
130Normal response codes: 200 151.. rest_status_code:: success status.yaml
152
153 - 200
154
131 155
132Error response codes: 405,404,403,401,400,503 156.. rest_status_code:: error status.yaml
157
158 - 400
159 - 401
160 - 403
161 - 404
162 - 405
163 - 503
133 164
134 165
135Request 166Request
@@ -176,9 +207,19 @@ Update Tsigkey
176Update the attribute(s) of an existing tsigkey 207Update the attribute(s) of an existing tsigkey
177 208
178 209
179Normal response codes: 200 210.. rest_status_code:: success status.yaml
211
212 - 200
213
214
215.. rest_status_code:: error status.yaml
180 216
181Error response codes: 405,404,403,401,400,503 217 - 400
218 - 401
219 - 403
220 - 404
221 - 405
222 - 503
182 223
183 224
184Request Parameters 225Request Parameters
@@ -237,9 +278,19 @@ Delete a Tsigkey
237Delete a tsigkey 278Delete a tsigkey
238 279
239 280
240Normal response codes: 204 281.. rest_status_code:: success status.yaml
282
283 - 204
284
285
286.. rest_status_code:: error status.yaml
241 287
242Error response codes: 405,404,403,401,400,503 288 - 400
289 - 401
290 - 403
291 - 404
292 - 405
293 - 503
243 294
244 295
245Request 296Request
diff --git a/api-ref/source/dns-api-v2-version.inc b/api-ref/source/dns-api-v2-version.inc
index e6d8e8c..b4c9de1 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
10.. rest_method:: GET / 10.. rest_method:: GET /
11 11
12 12
13Normal response codes: 200 13.. rest_status_code:: success status.yaml
14 14
15Error response codes: 405,404,403,401,400,503 15 - 200
16
17
18.. rest_status_code:: error status.yaml
19
20 - 400
21 - 401
22 - 403
23 - 404
24 - 405
25 - 503
16 26
17 27
18Request 28Request
diff --git a/api-ref/source/dns-api-v2-zone-export.inc b/api-ref/source/dns-api-v2-zone-export.inc
index 83c04ee..3b13e18 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.
15 15
16.. note:: This POST should have no body 16.. note:: This POST should have no body
17 17
18Normal response codes: 202 18.. rest_status_code:: success status.yaml
19 19
20Error response codes: 405,404,403,401,400,503 20 - 202
21
22
23.. rest_status_code:: error status.yaml
24
25 - 400
26 - 401
27 - 403
28 - 404
29 - 405
30 - 409
31 - 503
21 32
22 33
23Request 34Request
@@ -61,9 +72,19 @@ List all Zone Exports
61.. rest_method:: GET /v2/zones/tasks/exports 72.. rest_method:: GET /v2/zones/tasks/exports
62 73
63 74
64Normal response codes: 200 75.. rest_status_code:: success status.yaml
76
77 - 200
65 78
66Error response codes: 405,404,403,401,400,503 79
80.. rest_status_code:: error status.yaml
81
82 - 400
83 - 401
84 - 403
85 - 404
86 - 405
87 - 503
67 88
68 89
69Request 90Request
@@ -110,9 +131,19 @@ Show a Zone Export Information
110.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id} 131.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}
111 132
112 133
113Normal response codes: 200 134.. rest_status_code:: success status.yaml
135
136 - 200
137
114 138
115Error response codes: 405,404,403,401,400,503 139.. rest_status_code:: error status.yaml
140
141 - 400
142 - 401
143 - 403
144 - 404
145 - 405
146 - 503
116 147
117 148
118Request 149Request
@@ -156,9 +187,19 @@ Retrive a Zone Export from the Designate Datastore
156.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export 187.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export
157 188
158 189
159Normal response codes: 200 190.. rest_status_code:: success status.yaml
191
192 - 200
193
194
195.. rest_status_code:: error status.yaml
160 196
161Error response codes: 405,404,403,401,400,503 197 - 400
198 - 401
199 - 403
200 - 404
201 - 405
202 - 503
162 203
163.. note:: 204.. note::
164 This endpoint will send a response with a ``text/dns`` content-type. 205 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.
203The zone will have to be deleted from the zone delete API 244The zone will have to be deleted from the zone delete API
204 245
205 246
206Normal response codes: 204 247.. rest_status_code:: success status.yaml
248
249 - 204
250
251
252.. rest_status_code:: error status.yaml
207 253
208Error response codes: 405,404,403,401,400,503 254 - 400
255 - 401
256 - 403
257 - 404
258 - 405
259 - 503
209 260
210 261
211Request 262Request
diff --git a/api-ref/source/dns-api-v2-zone-import.inc b/api-ref/source/dns-api-v2-zone-import.inc
index 4a417d5..fe515d8 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.
15 15
16.. note:: This POST should have no body, and the content-type should be text/dns 16.. note:: This POST should have no body, and the content-type should be text/dns
17 17
18Normal response codes: 202 18.. rest_status_code:: success status.yaml
19 19
20Error response codes: 405,404,403,401,400,503 20 - 202
21
22
23.. rest_status_code:: error status.yaml
24
25 - 400
26 - 401
27 - 403
28 - 404
29 - 405
30 - 409
31 - 503
21 32
22 33
23Request 34Request
@@ -59,9 +70,19 @@ List all Zone Imports
59.. rest_method:: GET /v2/zones/tasks/imports 70.. rest_method:: GET /v2/zones/tasks/imports
60 71
61 72
62Normal response codes: 200 73.. rest_status_code:: success status.yaml
74
75 - 200
76
77
78.. rest_status_code:: error status.yaml
63 79
64Error response codes: 405,404,403,401,400,503 80 - 400
81 - 401
82 - 403
83 - 404
84 - 405
85 - 503
65 86
66 87
67Request 88Request
@@ -105,10 +126,19 @@ Show a Zone Import
105 126
106.. rest_method:: GET /v2/zones/tasks/imports/{zone_import_id} 127.. rest_method:: GET /v2/zones/tasks/imports/{zone_import_id}
107 128
129.. rest_status_code:: success status.yaml
108 130
109Normal response codes: 200 131 - 200
110 132
111Error response codes: 405,404,403,401,400,503 133
134.. rest_status_code:: error status.yaml
135
136 - 400
137 - 401
138 - 403
139 - 404
140 - 405
141 - 503
112 142
113 143
114Request 144Request
@@ -154,9 +184,19 @@ This will just delete the record of the zone import, not the imported zone.
154The zone will have to be deleted from the zone delete API 184The zone will have to be deleted from the zone delete API
155 185
156 186
157Normal response codes: 204 187.. rest_status_code:: success status.yaml
188
189 - 204
190
191
192.. rest_status_code:: error status.yaml
158 193
159Error response codes: 405,404,403,401,400,503 194 - 400
195 - 401
196 - 403
197 - 404
198 - 405
199 - 503
160 200
161 201
162Request 202Request
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 90bc9b0..62d3feb 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
16This accepts an offer of a ownership transfer 16This accepts an offer of a ownership transfer
17 17
18 18
19Normal response codes: 200 19.. rest_status_code:: success status.yaml
20 20
21Error response codes: 405,404,403,401,400,503 21 - 201
22
23
24.. rest_status_code:: error status.yaml
25
26 - 400
27 - 401
28 - 403
29 - 404
30 - 405
31 - 409
32 - 503
22 33
23 34
24Request 35Request
@@ -68,10 +79,19 @@ Get Zone Transfer Accept
68 79
69.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_accept_id} 80.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_accept_id}
70 81
82.. rest_status_code:: success status.yaml
83
84 - 200
71 85
72Normal response codes: 200
73 86
74Error response codes: 405,404,403,401,400,503 87.. rest_status_code:: error status.yaml
88
89 - 400
90 - 401
91 - 403
92 - 404
93 - 405
94 - 503
75 95
76 96
77Request 97Request
@@ -115,9 +135,19 @@ List Zone Transfer Accepts
115 135
116This will list all your accepted ownership transfer. 136This will list all your accepted ownership transfer.
117 137
118Normal response codes: 200 138.. rest_status_code:: success status.yaml
139
140 - 200
141
142
143.. rest_status_code:: error status.yaml
119 144
120Error response codes: 405,404,403,401,400,503 145 - 400
146 - 401
147 - 403
148 - 404
149 - 405
150 - 503
121 151
122 152
123Request 153Request
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 aece818..a8399bd 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.
22.. note:: This POST can have no body. 22.. note:: This POST can have no body.
23 23
24 24
25Normal response codes: 201 25.. rest_status_code:: success status.yaml
26 26
27Error response codes: 405,404,403,401,400,503 27 - 201
28
29
30.. rest_status_code:: error status.yaml
31
32 - 400
33 - 401
34 - 403
35 - 404
36 - 405
37 - 409
38 - 503
28 39
29 40
30Request 41Request
@@ -79,9 +90,19 @@ List Zone Transfer Requests
79This will list all your outgoing requests, and any incoming requests that 90This will list all your outgoing requests, and any incoming requests that
80have been scoped to your project. 91have been scoped to your project.
81 92
82Normal response codes: 200 93.. rest_status_code:: success status.yaml
94
95 - 200
83 96
84Error response codes: 405,404,403,401,400,503 97
98.. rest_status_code:: error status.yaml
99
100 - 400
101 - 401
102 - 403
103 - 404
104 - 405
105 - 503
85 106
86 107
87Request 108Request
@@ -127,9 +148,19 @@ Show a Zone Transfer Request
127.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} 148.. rest_method:: GET /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
128 149
129 150
130Normal response codes: 200 151.. rest_status_code:: success status.yaml
152
153 - 200
154
131 155
132Error response codes: 405,404,403,401,400,503 156.. rest_status_code:: error status.yaml
157
158 - 400
159 - 401
160 - 403
161 - 404
162 - 405
163 - 503
133 164
134 165
135Request 166Request
@@ -174,9 +205,19 @@ Update a Zone Transfer Request
174.. rest_method:: PATCH /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} 205.. rest_method:: PATCH /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
175 206
176 207
177Normal response codes: 200 208.. rest_status_code:: success status.yaml
209
210 - 200
211
212
213.. rest_status_code:: error status.yaml
178 214
179Error response codes: 405,404,403,401,400,503 215 - 400
216 - 401
217 - 403
218 - 404
219 - 405
220 - 503
180 221
181 222
182Request 223Request
@@ -229,9 +270,19 @@ Delete a Zone Transfer Request
229.. rest_method:: DELETE /v2/zones/tasks/transfer_requests/{zone_transfer_request_id} 270.. rest_method:: DELETE /v2/zones/tasks/transfer_requests/{zone_transfer_request_id}
230 271
231 272
232Normal response codes: 204 273.. rest_status_code:: success status.yaml
274
275 - 204
276
277
278.. rest_status_code:: error status.yaml
233 279
234Error response codes: 405,404,403,401,400,503 280 - 400
281 - 401
282 - 403
283 - 404
284 - 405
285 - 503
235 286
236 287
237Request 288Request
diff --git a/api-ref/source/dns-api-v2-zone-tasks.inc b/api-ref/source/dns-api-v2-zone-tasks.inc
index 06e179d..62a46a3 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.
20.. warning:: 20.. warning::
21 This is a protentially dangerous operation, and should only be used if required 21 This is a protentially dangerous operation, and should only be used if required
22 22
23Normal response codes: 204 23.. rest_status_code:: success status.yaml
24 24
25Error response codes: 405,404,403,401,400,503 25 - 204
26
27
28.. rest_status_code:: error status.yaml
29
30 - 400
31 - 401
32 - 403
33 - 404
34 - 405
35 - 503
26 36
27 37
28Request 38Request
@@ -61,9 +71,19 @@ This is useful if an upstream server failed to send a notify to Designate
61 71
62.. important:: This is only useful on SECONDARY zones. 72.. important:: This is only useful on SECONDARY zones.
63 73
64Normal response codes: 202 74.. rest_status_code:: success status.yaml
75
76 - 202
77
78
79.. rest_status_code:: error status.yaml
65 80
66Error response codes: 405,404,403,401,400,503 81 - 400
82 - 401
83 - 403
84 - 404
85 - 405
86 - 503
67 87
68 88
69Request 89Request
diff --git a/api-ref/source/dns-api-v2-zone.inc b/api-ref/source/dns-api-v2-zone.inc
index 0a1efdc..f1a48b9 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
13Create a zone 13Create a zone
14 14
15 15
16Normal response codes: 202 16.. rest_status_code:: success status.yaml
17 17
18Error response codes: 405,404,403,401,400,503 18 - 202
19
20
21.. rest_status_code:: error status.yaml
22
23 - 400
24 - 401
25 - 403
26 - 404
27 - 405
28 - 409
29 - 503
19 30
20 31
21Request 32Request
@@ -81,10 +92,19 @@ List Zones
81 92
82List all zones 93List all zones
83 94
95.. rest_status_code:: success status.yaml
96
97 - 200
98
84 99
85Normal response codes: 200 100.. rest_status_code:: error status.yaml
86 101
87Error response codes: 405,404,403,401,400,503 102 - 400
103 - 401
104 - 403
105 - 404
106 - 405
107 - 503
88 108
89 109
90Request 110Request
@@ -148,9 +168,19 @@ Show a Zone
148Show a zone 168Show a zone
149 169
150 170
151Normal response codes: 200 171.. rest_status_code:: success status.yaml
152 172
153Error response codes: 405,404,403,401,400,503 173 - 200
174
175
176.. rest_status_code:: error status.yaml
177
178 - 400
179 - 401
180 - 403
181 - 404
182 - 405
183 - 503
154 184
155 185
156Request 186Request
@@ -205,9 +235,19 @@ Get the Name Servers for a Zone
205 235
206Show the nameservers for a zone 236Show the nameservers for a zone
207 237
208Normal response codes: 200 238.. rest_status_code:: success status.yaml
239
240 - 200
209 241
210Error response codes: 405,404,403,401,400,503 242
243.. rest_status_code:: error status.yaml
244
245 - 400
246 - 401
247 - 403
248 - 404
249 - 405
250 - 503
211 251
212 252
213Request 253Request
@@ -249,9 +289,19 @@ Update a Zone
249Update the attribute(s) for an existing zone. 289Update the attribute(s) for an existing zone.
250 290
251 291
252Normal response codes: 202 292.. rest_status_code:: success status.yaml
293
294 - 202
295
253 296
254Error response codes: 405,404,403,401,400,503 297.. rest_status_code:: error status.yaml
298
299 - 400
300 - 401
301 - 403
302 - 404
303 - 405
304 - 503
255 305
256 306
257Request 307Request
@@ -316,9 +366,19 @@ Delete a Zone
316Delete a zone 366Delete a zone
317 367
318 368
319Normal response codes: 202 369.. rest_status_code:: success status.yaml
370
371 - 202
372
373
374.. rest_status_code:: error status.yaml
320 375
321Error response codes: 405,404,403,401,400,503 376 - 400
377 - 401
378 - 403
379 - 404
380 - 405
381 - 503
322 382
323 383
324Request 384Request
diff --git a/api-ref/source/status.yaml b/api-ref/source/status.yaml
index 81f60f3..7bc348c 100644
--- a/api-ref/source/status.yaml
+++ b/api-ref/source/status.yaml
@@ -1,8 +1,6 @@
1 200: 1 200:
2 default: | 2 default: |
3 Request was successful. 3 Request was successful.
4 image-data-200: |
5 The service lists the image data in the response body.
6 201: 4 201:
7 default: | 5 default: |
8 Request has been fulfilled and new resource created. 6 Request has been fulfilled and new resource created.