-
Notifications
You must be signed in to change notification settings - Fork 2
/
domains.yaml
492 lines (489 loc) · 12.4 KB
/
domains.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
openapi: 3.0.0
info:
title: Domain API
version: 2.0.0
license:
name: MIT
url: https://github.com/aziontech/azionapi-openapi/blob/main/LICENSE.md
servers:
- description: Production
url: https://api.azionapi.net
security:
- tokenAuth: []
paths:
/domains:
get:
tags:
- Domains
summary: /domains
description: It returns the list of domains of an account.
operationId: getDomains
parameters:
- explode: true
in: query
name: page
required: false
schema:
format: int64
type: integer
style: form
- explode: true
in: query
name: page_size
required: false
schema:
format: int64
type: integer
style: form
- explode: true
in: query
name: sort
required: false
schema:
type: string
style: form
- explode: true
in: query
name: order_by
required: false
schema:
type: string
style: form
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
responses:
"200":
description: Successful response
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/DomainResponseWithResults"
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
post:
tags:
- Domains
summary: /domains
description: It enables you to include a new domain into an account.
requestBody:
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/CreateDomainRequest"
operationId: createDomain
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
"200":
description: Successful response
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/DomainResponseWithResult"
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"409":
description: Conflict
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
/domains/{id}:
get:
tags:
- Domains
summary: /domains/:id
description: It returns details of a domain.
operationId: getDomain
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
- name: id
in: path
schema:
type: string
required: true
description: "The id of the domain to be consulted.\t"
responses:
"200":
description: Successful response
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/DomainResponseWithResult"
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
delete:
tags:
- Domains
summary: /domains/:id
description: It enables you to delete a domain.
operationId: delDomain
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
- name: id
in: path
schema:
type: string
required: true
description: "The id of the domain to be deleted.\t"
responses:
"204":
description: No Content
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
put:
tags:
- Domains
summary: /domains:/:id
description: >-
It overwrites all fields of a domain, while preserving the id. Optional
fields not filled in will be replaced by the default values.
To update only some fields in a domain, consider using the PATCH method
instead of PUT.
requestBody:
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/PutDomainRequest"
operationId: putDomain
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: id
in: path
schema:
type: string
required: true
responses:
"200":
description: Successful response
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/DomainResponseWithResult"
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"405":
description: Method Not Allowed
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
patch:
tags:
- Domains
summary: /domains/:id
description: >-
It updates one or more fields in a Domain, preserving the value of the
fields not informed.
requestBody:
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/UpdateDomainRequest"
operationId: updateDomain
parameters:
- name: Accept
in: header
schema:
type: string
example: application/json; version=3
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: id
in: path
schema:
type: string
required: true
responses:
"200":
description: Successful response
content:
'application/json; version=3':
schema:
$ref: "#/components/schemas/DomainResponseWithResult"
"400":
description: Bad Request
"403":
description: Forbidden
"404":
description: Not Found
"405":
description: Method Not Allowed
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
components:
schemas:
DomainData:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
pattern: "[a-zA-Z0-9$%^&*()-+=\\[\\]{};:?><,|/]+"
cnames:
type: array
items:
type: string
cname_access_only:
type: boolean
is_active:
type: boolean
edge_application_id:
format: int64
type: integer
minimum: 1
maximum: 10000000000000000000
digital_certificate_id:
type: string
minLength: 1
maxLength: 100
pattern: "[a-zA-Z0-9$%^&*()-+=\\[\\]{};:?><,|/]+"
environment:
type: string
enum:
- production
- preview
is_mtls_enabled:
type: boolean
mtls_trusted_ca_certificate_id:
type: integer
format: int64
nullable: true
edge_firewall_id:
type: integer
format: int64
nullable: true
mtls_verification:
type: string
enum:
- enforce
- permissive
crl_list:
nullable: true
type: array
items:
type: integer
format: int64
DomainDataResponse:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
pattern: "[a-zA-Z0-9$%^&*()-+=\\[\\]{};:?><,|/]+"
cnames:
type: array
items:
type: string
cname_access_only:
type: boolean
is_active:
type: boolean
edge_application_id:
format: int64
type: integer
minimum: 1
maximum: 10000000000000000000
digital_certificate_id:
format: int64
type: integer
minimum: 1
maximum: 10000000000000000000
environment:
type: string
enum:
- production
- preview
is_mtls_enabled:
type: boolean
mtls_trusted_ca_certificate_id:
type: integer
format: int64
nullable: true
edge_firewall_id:
type: integer
format: int64
nullable: true
mtls_verification:
type: string
enum:
- enforce
- permissive
crl_list:
nullable: true
type: array
items:
type: integer
format: int64
DomainEntity:
allOf:
- type: object
properties:
id:
type: integer
format: int64
domain_name:
type: string
- $ref: "#/components/schemas/DomainData"
DomainEntityResponse:
allOf:
- type: object
properties:
id:
type: integer
format: int64
domain_name:
type: string
- $ref: "#/components/schemas/DomainDataResponse"
CreateDomainRequest:
allOf:
- $ref: "#/components/schemas/DomainData"
additionalProperties: false
required:
- name
- edge_application_id
- cnames
UpdateDomainRequest:
allOf:
- $ref: "#/components/schemas/DomainData"
PutDomainRequest:
allOf:
- $ref: "#/components/schemas/DomainData"
additionalProperties: false
required:
- name
- edge_application_id
- cnames
DomainLinks:
additionalProperties: false
properties:
previous:
type: string
nullable: true
next:
type: string
nullable: true
required:
- previous
- next
type: object
DomainResponseWithResults:
additionalProperties: false
properties:
count:
format: int64
type: integer
total_pages:
format: int64
type: integer
schema_version:
format: int64
type: integer
links:
$ref: "#/components/schemas/DomainLinks"
results:
items:
$ref: "#/components/schemas/DomainEntityResponse"
required:
- count
- total_pages
- schema_version
- links
- results
type: object
DomainResponseWithResult:
additionalProperties: false
properties:
count:
format: int64
type: integer
links:
$ref: "#/components/schemas/DomainLinks"
results:
$ref: "#/components/schemas/DomainEntityResponse"
total_pages:
format: int64
type: integer
schema_version:
format: int64
type: integer
required:
- schema_version
- results
type: object
securitySchemes:
tokenAuth:
type: apiKey
name: Authorization
in: header
description: |
You must inform a token to auth.
Usage format: `Token <TOKEN>`