Skip to content

Commit cfc5294

Browse files
bbiggerrnmelehan
andauthored
[Update] DomainRecord schema (#390)
* Update DomainRecord schema Co-authored-by: nmelehan <[email protected]>
1 parent 7e42dd4 commit cfc5294

File tree

1 file changed

+51
-20
lines changed

1 file changed

+51
-20
lines changed

openapi.yaml

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15870,66 +15870,94 @@ components:
1587015870
description: >
1587115871
The type of Record this is in the DNS system. For example, A
1587215872
records associate a domain name with an IPv4 address, and AAAA
15873-
records associate a domain name with an IPv6 address.
15873+
records associate a domain name with an IPv6 address. For more information, see our guide on
15874+
[DNS Records](/docs/guides/dns-records-an-introduction).
1587415875
example: A
1587515876
x-linode-cli-display: 2
1587615877
name:
1587715878
type: string
15878-
description: >
15879-
The name of this Record. This field's actual usage depends on the
15880-
type of record this represents. For A and AAAA records, this is
15881-
the subdomain being associated with an IP address.
15879+
description: |
15880+
The name of this Record. For requests, this property's actual usage and whether it is required depends on the type of record this represents:
15881+
15882+
`A` and `AAAA`: The hostname or FQDN of the Record.
15883+
15884+
`NS`: The subdomain, if any, to use with the Domain of the Record.
15885+
15886+
`MX`: The subdomain.
15887+
15888+
`CNAME`: The hostname. Must be unique. Required.
15889+
15890+
`TXT`: The hostname.
15891+
15892+
`SRV`: Unused. Use the `service` property to set the service name for this record.
15893+
15894+
`CAA`: The subdomain. Omit or enter an empty string ("") to apply to the entire Domain.
15895+
15896+
`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS (rDNS)](/docs/guides/configure-your-linode-for-reverse-dns).
1588215897
minLength: 1
1588315898
maxLength: 100
1588415899
example: test
1588515900
x-linode-cli-display: 3
1588615901
target:
1588715902
type: string
15888-
description: >
15889-
The target for this Record. This field's actual usage depends on
15890-
the type of record this represents. For A and AAAA records, this
15891-
is the address the named Domain should resolve to.
15903+
description: |
15904+
The target for this Record. For requests, this property's actual usage and whether it is required depends on the type of record this represents:
1589215905

15906+
`A` and `AAAA`: The IP address. Use `[remote_addr]` to submit the IPv4 address of the request. Required.
1589315907

15894-
With the exception of A and AAAA records, this field accepts
15895-
a trailing period.
15896-
example: 12.34.56.78
15908+
`NS`: The name server. Must be a valid domain. Required.
15909+
15910+
`MX`: The mail server. Must be a valid domain. Required.
15911+
15912+
`CNAME`: The alias. Must be a valid domain. Required.
15913+
15914+
`TXT`: The value. Required.
15915+
15916+
`SRV`: The target domain or subdomain. If a subdomain is entered, it is automatically used with the Domain. To configure for a different domain, enter a valid FQDN. For example, the value `www` with a Domain for `example.com` results in a target set to `www.example.com`, whereas the value `sample.com` results in a target set to `sample.com`. Required.
15917+
15918+
`CAA`: The value. For `issue` or `issuewild` tags, the domain of your certificate issuer. For the `iodef` tag, a contact or submission URL (http or mailto).
15919+
15920+
`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS (rDNS)](/docs/guides/configure-your-linode-for-reverse-dns).
15921+
15922+
With the exception of A, AAAA, and CAA records, this field accepts a trailing period.
15923+
example: 192.0.2.0
1589715924
x-linode-cli-display: 4
1589815925
priority:
1589915926
type: integer
1590015927
minimum: 0
1590115928
maximum: 255
1590215929
description: >
15903-
The priority of the target host. Lower values are preferred.
15930+
The priority of the target host for this Record. Lower values are preferred. Only valid and required for SRV record requests.
1590415931
example: 50
1590515932
x-linode-cli-display: 6
1590615933
weight:
1590715934
type: integer
1590815935
description: >
15909-
The relative weight of this Record. Higher values are preferred.
15936+
The relative weight of this Record. Higher values are preferred. Only valid and required for SRV record requests.
1591015937
example: 50
1591115938
minimum: 0
1591215939
maximum: 65535
1591315940
x-linode-cli-display: 7
1591415941
port:
1591515942
type: integer
1591615943
description: >
15917-
The port this Record points to.
15944+
The port this Record points to. Only valid and required for SRV record requests.
1591815945
example: 80
1591915946
minimum: 0
1592015947
maximum: 65535
1592115948
service:
1592215949
type: string
1592315950
nullable: true
1592415951
description: >
15925-
The service this Record identified. Only valid for SRV records.
15952+
The name of the service. An underscore (_) is prepended and a period (.) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.
1592615953
example: null
1592715954
protocol:
1592815955
type: string
1592915956
nullable: true
1593015957
description: >
15931-
The protocol this Record's service communicates with. Only valid
15932-
for SRV records.
15958+
The protocol this Record's service communicates with. An underscore (_) is prepended
15959+
automatically to the submitted value for this property. Only valid
15960+
for SRV record requests.
1593315961
example: null
1593415962
ttl_sec:
1593515963
type: integer
@@ -15943,10 +15971,13 @@ components:
1594315971
x-linode-cli-display: 5
1594415972
tag:
1594515973
type: string
15974+
enum:
15975+
- issue
15976+
- issuewild
15977+
- iodef
1594615978
nullable: true
1594715979
description: >
15948-
The tag portion of a CAA record. It is invalid to set this on
15949-
other record types.
15980+
The tag portion of a CAA record. Only valid and required for CAA record requests.
1595015981
example: null
1595115982
x-linode-filterable: true
1595215983
created:

0 commit comments

Comments
 (0)