diff --git a/components/schemas/containers/ContainersMeta.yml b/components/schemas/containers/ContainersMeta.yml index 30e52496..fc90d70f 100644 --- a/components/schemas/containers/ContainersMeta.yml +++ b/components/schemas/containers/ContainersMeta.yml @@ -18,7 +18,7 @@ properties: type: string description: The fully qualified domain name. record: - "$ref": "../dns/records/Record.yml" + "$ref": "../dns/records/DnsRecord.yml" ips: description: An array of IP resources. type: array diff --git a/components/schemas/dns/Zone.yml b/components/schemas/dns/DnsZone.yml similarity index 95% rename from components/schemas/dns/Zone.yml rename to components/schemas/dns/DnsZone.yml index 30c2d2c0..78b61f4e 100644 --- a/components/schemas/dns/Zone.yml +++ b/components/schemas/dns/DnsZone.yml @@ -1,4 +1,4 @@ -title: DNSZone +title: DnsZone type: object description: DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address. required: @@ -24,10 +24,10 @@ properties: description: A boolean where true represents this zone is a hosted zone. acl: anyOf: - - $ref: ../common/ACL.yml + - $ref: ../common/ACL.yml - type: "null" state: - "$ref": "./ZoneState.yml" + "$ref": "./DnsZoneState.yml" events: title: ZoneEvents type: object diff --git a/components/schemas/dns/DnsZoneIncludes.yml b/components/schemas/dns/DnsZoneIncludes.yml new file mode 100644 index 00000000..bd3caf4f --- /dev/null +++ b/components/schemas/dns/DnsZoneIncludes.yml @@ -0,0 +1,6 @@ +title: DnsZoneIncludes +description: All includable resources linkable to the given Zone. +type: object +properties: + creators: + "$ref": "../includes/CreatorInclude.yml" diff --git a/components/schemas/dns/DnsZoneState.yml b/components/schemas/dns/DnsZoneState.yml new file mode 100644 index 00000000..d75ea8f3 --- /dev/null +++ b/components/schemas/dns/DnsZoneState.yml @@ -0,0 +1,17 @@ +title: DnsZoneState +allOf: + - required: + - current + properties: + current: + description: The current state of the zone. + type: string + enum: + - new + - pending + - verifying + - live + - disabled + - deleting + - deleted + - "$ref": "../State.yml" diff --git a/components/schemas/dns/ZoneIncludes.yml b/components/schemas/dns/ZoneIncludes.yml deleted file mode 100644 index a24011bc..00000000 --- a/components/schemas/dns/ZoneIncludes.yml +++ /dev/null @@ -1,6 +0,0 @@ -title: ZoneIncludes -description: All includable resources linkable to the given Zone. -type: object -properties: - creators: - "$ref": "../includes/CreatorInclude.yml" \ No newline at end of file diff --git a/components/schemas/dns/ZoneState.yml b/components/schemas/dns/ZoneState.yml deleted file mode 100644 index 9bcb6862..00000000 --- a/components/schemas/dns/ZoneState.yml +++ /dev/null @@ -1,17 +0,0 @@ -title: DNSZoneState -allOf: - - required: - - current - properties: - current: - description: The current state of the zone. - type: string - enum: - - new - - pending - - verifying - - live - - disabled - - deleting - - deleted - - "$ref": "../State.yml" \ No newline at end of file diff --git a/components/schemas/dns/records/Record.yml b/components/schemas/dns/records/DnsRecord.yml similarity index 87% rename from components/schemas/dns/records/Record.yml rename to components/schemas/dns/records/DnsRecord.yml index 0dfb0237..fe8e5022 100644 --- a/components/schemas/dns/records/Record.yml +++ b/components/schemas/dns/records/DnsRecord.yml @@ -1,4 +1,4 @@ -title: DNSRecord +title: DnsRecord type: object description: A DNS record. required: @@ -29,7 +29,7 @@ properties: type: string description: The name of the record and the origin as a domain name. type: - $ref: RecordTypes.yml + $ref: DnsRecordTypes.yml features: type: - object @@ -40,9 +40,9 @@ properties: properties: certificate: anyOf: - - $ref: RecordTlsCertificate.yml + - $ref: DnsRecordTlsCertificate.yml - type: "null" state: - $ref: RecordState.yml + $ref: DnsRecordState.yml events: $ref: ../../Events.yml diff --git a/components/schemas/dns/records/RecordState.yml b/components/schemas/dns/records/DnsRecordState.yml similarity index 92% rename from components/schemas/dns/records/RecordState.yml rename to components/schemas/dns/records/DnsRecordState.yml index 9dc422aa..7f0e87ac 100644 --- a/components/schemas/dns/records/RecordState.yml +++ b/components/schemas/dns/records/DnsRecordState.yml @@ -1,4 +1,4 @@ -title: DNSRecordState +title: DnsRecordState allOf: - required: - current diff --git a/components/schemas/dns/records/RecordTlsCertificate.yml b/components/schemas/dns/records/DnsRecordTlsCertificate.yml similarity index 95% rename from components/schemas/dns/records/RecordTlsCertificate.yml rename to components/schemas/dns/records/DnsRecordTlsCertificate.yml index a62f43a1..c1c22ce2 100644 --- a/components/schemas/dns/records/RecordTlsCertificate.yml +++ b/components/schemas/dns/records/DnsRecordTlsCertificate.yml @@ -1,4 +1,4 @@ -title: RecordTlsCertificate +title: DnsRecordTlsCertificate type: object description: A TLS certificate assigned to a DNS record. required: diff --git a/components/schemas/dns/records/RecordTypes.yml b/components/schemas/dns/records/DnsRecordTypes.yml similarity index 99% rename from components/schemas/dns/records/RecordTypes.yml rename to components/schemas/dns/records/DnsRecordTypes.yml index 61f2a601..c2bc2c02 100644 --- a/components/schemas/dns/records/RecordTypes.yml +++ b/components/schemas/dns/records/DnsRecordTypes.yml @@ -1,4 +1,4 @@ -title: DNSRecordTypes +title: DnsRecordTypes type: object description: DNS record types the platform supports. properties: diff --git a/components/schemas/includes/ComponentsIncludes.yml b/components/schemas/includes/ComponentsIncludes.yml index eb2f22da..3328f5d6 100644 --- a/components/schemas/includes/ComponentsIncludes.yml +++ b/components/schemas/includes/ComponentsIncludes.yml @@ -14,8 +14,8 @@ additionalProperties: - $ref: ../hubs/integrations/Integration.yml - $ref: ../stacks/Stack.yml - $ref: ../stacks/builds/StackBuild.yml - - $ref: ../dns/Zone.yml - - $ref: ../dns/records/Record.yml + - $ref: ../dns/DnsZone.yml + - $ref: ../dns/records/DnsRecord.yml - $ref: ../dns/tls/TlsCertificate.yml - $ref: ../hubs/ApiKey.yml - $ref: ../sdn/networks/Network.yml diff --git a/components/schemas/vms/VirtualMachineMeta.yml b/components/schemas/vms/VirtualMachineMeta.yml index 6033df97..157f5370 100644 --- a/components/schemas/vms/VirtualMachineMeta.yml +++ b/components/schemas/vms/VirtualMachineMeta.yml @@ -14,7 +14,7 @@ properties: description: The fully qualified domain name. record: anyOf: - - $ref: ../dns/records/Record.yml + - $ref: ../dns/records/DnsRecord.yml - type: "null" required: - fqdn diff --git a/internal/paths/container/domains.yml b/internal/paths/container/domains.yml index b0dd89b2..656fae4b 100644 --- a/internal/paths/container/domains.yml +++ b/internal/paths/container/domains.yml @@ -35,4 +35,4 @@ get: type: string description: The fully qualified domain name. record: - $ref: ../../../components/schemas/dns/records/Record.yml + $ref: ../../../components/schemas/dns/records/DnsRecord.yml diff --git a/internal/paths/virtual-machine/domains.yml b/internal/paths/virtual-machine/domains.yml index 4f71f977..23c58351 100644 --- a/internal/paths/virtual-machine/domains.yml +++ b/internal/paths/virtual-machine/domains.yml @@ -2,7 +2,7 @@ get: operationId: "getVirtualMachineDomains" summary: Get Virtual Machine Domains description: | - Returns the domains associated with the specified virtual machine. + Returns the domains associated with the specified virtual machine. tags: - Virtual Machines parameters: @@ -35,4 +35,4 @@ get: type: string record: anyOf: - - $ref: ../../../components/schemas/dns/records/Record.yml \ No newline at end of file + - $ref: ../../../components/schemas/dns/records/DnsRecord.yml diff --git a/platform/paths/dns/access.yml b/platform/paths/dns/access.yml index 54266e91..051a6861 100644 --- a/platform/paths/dns/access.yml +++ b/platform/paths/dns/access.yml @@ -47,8 +47,8 @@ patch: - data properties: data: - $ref: ../../../components/schemas/dns/Zone.yml + $ref: ../../../components/schemas/dns/DnsZone.yml includes: - $ref: ../../../components/schemas/dns/ZoneIncludes.yml + $ref: ../../../components/schemas/dns/DnsZoneIncludes.yml default: $ref: ../../../components/responses/errors/DefaultError.yml diff --git a/platform/paths/dns/records/record.yml b/platform/paths/dns/records/record.yml index fd50c2ef..01d5dbc0 100644 --- a/platform/paths/dns/records/record.yml +++ b/platform/paths/dns/records/record.yml @@ -28,7 +28,7 @@ patch: - type properties: type: - $ref: ../../../../components/schemas/dns/records/RecordTypes.yml + $ref: ../../../../components/schemas/dns/records/DnsRecordTypes.yml responses: 200: description: Returns a DNS Zone Record. @@ -40,7 +40,7 @@ patch: - data properties: data: - $ref: ../../../../components/schemas/dns/records/Record.yml + $ref: ../../../../components/schemas/dns/records/DnsRecord.yml includes: $ref: includes/RecordIncludes.yml default: diff --git a/platform/paths/dns/records/records.yml b/platform/paths/dns/records/records.yml index 30c6fb65..4ab858f0 100644 --- a/platform/paths/dns/records/records.yml +++ b/platform/paths/dns/records/records.yml @@ -44,7 +44,7 @@ get: data: type: array items: - $ref: ../../../../components/schemas/dns/records/Record.yml + $ref: ../../../../components/schemas/dns/records/DnsRecord.yml includes: $ref: includes/RecordIncludes.yml default: @@ -75,7 +75,7 @@ post: - name properties: type: - $ref: ../../../../components/schemas/dns/records/RecordTypes.yml + $ref: ../../../../components/schemas/dns/records/DnsRecordTypes.yml name: type: string description: A name for the given record where `@` represents the desire to use the root of the origin. @@ -91,7 +91,7 @@ post: - data properties: data: - $ref: ../../../../components/schemas/dns/records/Record.yml + $ref: ../../../../components/schemas/dns/records/DnsRecord.yml includes: $ref: includes/RecordIncludes.yml default: diff --git a/platform/paths/dns/zone.yml b/platform/paths/dns/zone.yml index bb302e88..bdf64280 100644 --- a/platform/paths/dns/zone.yml +++ b/platform/paths/dns/zone.yml @@ -22,7 +22,7 @@ get: - data properties: data: - $ref: ../../../components/schemas/dns/Zone.yml + $ref: ../../../components/schemas/dns/DnsZone.yml default: $ref: ../../../components/responses/errors/DefaultError.yml patch: @@ -60,7 +60,7 @@ patch: type: object properties: hosted: - type: + type: - boolean - "null" description: A boolean where true represents the desire for the origin to be of the type `hosted`. @@ -76,9 +76,9 @@ patch: - data properties: data: - $ref: ../../../components/schemas/dns/Zone.yml + $ref: ../../../components/schemas/dns/DnsZone.yml includes: - $ref: ../../../components/schemas/dns/ZoneIncludes.yml + $ref: ../../../components/schemas/dns/DnsZoneIncludes.yml default: $ref: ../../../components/responses/errors/DefaultError.yml delete: diff --git a/platform/paths/dns/zones.yml b/platform/paths/dns/zones.yml index 45c0eee5..ff254b51 100644 --- a/platform/paths/dns/zones.yml +++ b/platform/paths/dns/zones.yml @@ -49,9 +49,9 @@ get: data: type: array items: - $ref: ../../../components/schemas/dns/Zone.yml + $ref: ../../../components/schemas/dns/DnsZone.yml includes: - $ref: ../../../components/schemas/dns/ZoneIncludes.yml + $ref: ../../../components/schemas/dns/DnsZoneIncludes.yml default: $ref: ../../../components/responses/errors/DefaultError.yml post: @@ -79,7 +79,7 @@ post: description: The origin that will be created. acl: anyOf: - - $ref: ../../../components/schemas/common/ACL.yml + - $ref: ../../../components/schemas/common/ACL.yml - type: "null" responses: @@ -93,6 +93,6 @@ post: - data properties: data: - $ref: ../../../components/schemas/dns/Zone.yml + $ref: ../../../components/schemas/dns/DnsZone.yml default: $ref: ../../../components/responses/errors/DefaultError.yml