Skip to content

Commit c95df5c

Browse files
authored
[Update] Domain schema and Domain Create/Update endpoints (#397)
* Update Domain schema and Domain Create/Update * Add tags to API command sample
1 parent 67d0f1e commit c95df5c

File tree

1 file changed

+45
-25
lines changed

1 file changed

+45
-25
lines changed

openapi.yaml

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2625,7 +2625,11 @@ paths:
26252625
content:
26262626
application/json:
26272627
schema:
2628-
$ref: '#/components/schemas/Domain'
2628+
required:
2629+
- domain
2630+
- type
2631+
allOf:
2632+
- $ref: '#/components/schemas/Domain'
26292633
responses:
26302634
'200':
26312635
description: |
@@ -2653,7 +2657,8 @@ paths:
26532657
"status": "active",
26542658
"master_ips": ["127.0.0.1","255.255.255.1","123.123.123.7"],
26552659
"axfr_ips": ["44.55.66.77"],
2656-
"display_group": "Example Display Group"
2660+
"group": "Example Display Group",
2661+
"tags": ["tag1","tag2"]
26572662
}' \
26582663
https://api.linode.com/v4/domains
26592664
- lang: CLI
@@ -2750,7 +2755,8 @@ paths:
27502755
"status": "active",
27512756
"master_ips": ["127.0.0.1","255.255.255.1","123.123.123.7"],
27522757
"axfr_ips": ["44.55.66.77"],
2753-
"display_group": "Example Display Group"
2758+
"group": "Example Display Group",
2759+
"tags": ["tag1","tag2"]
27542760
}' \
27552761
https://api.linode.com/v4/domains/123
27562762
- lang: CLI
@@ -15771,10 +15777,6 @@ components:
1577115777
A domain zonefile in our DNS system. You must own the domain name and
1577215778
tell your registrar to use Linode's nameservers in order for a domain
1577315779
in our system to be treated as authoritative.
15774-
required:
15775-
- id
15776-
- domain
15777-
- type
1577815780
properties:
1577915781
id:
1578015782
type: integer
@@ -15795,6 +15797,8 @@ components:
1579515797
domain:
1579615798
type: string
1579715799
pattern: ([a-zA-Z0-9-_]{1,63}\.)+([a-zA-Z]{2,3}\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+\.?)
15800+
minLength: 1
15801+
maxLength: 255
1579815802
description: >
1579915803
The domain this Domain represents. Domain labels cannot be longer than
1580015804
63 characters and must conform to [RFC1035](https://tools.ietf.org/html/rfc1035).
@@ -15818,6 +15822,7 @@ components:
1581815822
enum:
1581915823
- disabled
1582015824
- active
15825+
default: active
1582115826
description: >
1582215827
Used to control whether this Domain is currently being rendered.
1582315828
example: active
@@ -15844,11 +15849,16 @@ components:
1584415849
x-linode-cli-display: 5
1584515850
retry_sec:
1584615851
type: integer
15847-
description: >
15852+
default: 0
15853+
description: |
1584815854
The interval, in seconds, at which a failed refresh should be retried.
15849-
Valid values are 300, 3600, 7200, 14400, 28800, 57600,
15850-
86400, 172800, 345600, 604800, 1209600, and 2419200 - any other
15851-
value will be rounded to the nearest valid value.
15855+
15856+
* Valid values are
15857+
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
15858+
15859+
* Any other value is rounded up to the nearest valid value.
15860+
15861+
* A value of 0 is equivalent to the default value of 14400.
1585215862
example: 300
1585315863
master_ips:
1585415864
type: array
@@ -15871,34 +15881,44 @@ components:
1587115881
example: []
1587215882
expire_sec:
1587315883
type: integer
15874-
description: >
15884+
default: 0
15885+
description: |
1587515886
The amount of time in seconds that may pass before this Domain is no longer
15876-
authoritative. Valid values are
15877-
300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600,
15878-
604800, 1209600, and 2419200 - any other value will be rounded to
15879-
the nearest valid value.
15887+
authoritative.
15888+
15889+
* Valid values are
15890+
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
15891+
15892+
* Any other value is rounded up to the nearest valid value.
15893+
15894+
* A value of 0 is equivalent to the default value of 1209600.
1588015895
example: 300
1588115896
refresh_sec:
1588215897
type: integer
15883-
description: >
15898+
default: 0
15899+
description: |
1588415900
The amount of time in seconds before this Domain should be refreshed.
15885-
Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600,
15886-
604800, 1209600, and 2419200 - any other value will be rounded to
15887-
the nearest valid value.
15901+
15902+
* Valid values are
15903+
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
15904+
15905+
* Any other value is rounded up to the nearest valid value.
15906+
15907+
* A value of 0 is equivalent to the default value of 14400.
1588815908
example: 300
1588915909
ttl_sec:
1589015910
type: integer
15911+
default: 0
1589115912
description: >
1589215913
"Time to Live" - the amount of time in seconds that this Domain's
1589315914
records may be cached by resolvers or other domain servers.
1589415915

15895-
* Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800,
15896-
345600, 604800, 1209600, and 2419200 - any other value will be
15897-
rounded to the nearest valid value.
15916+
* Valid values are
15917+
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
1589815918

15899-
* ttl_sec will default to 0 if no value is provided.
15919+
* Any other value is rounded up to the nearest valid value.
1590015920

15901-
* A value of 0 is equivalent to a value of 86400.
15921+
* A value of 0 is equivalent to the default value of 86400.
1590215922
example: 300
1590315923
tags:
1590415924
x-linode-filterable: true

0 commit comments

Comments
 (0)