mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2025-11-04 12:41:00 +01:00
Provide better detail
Explain some of the schemas and endpoints in more detail.
This commit is contained in:
parent
f631c70931
commit
24ce031bc1
@ -98,9 +98,7 @@ paths:
|
|||||||
tags: [update]
|
tags: [update]
|
||||||
requestBody:
|
requestBody:
|
||||||
description: |
|
description: |
|
||||||
This is the list of records to be adjusted.
|
This is the list of changes to be applied.
|
||||||
|
|
||||||
TODO: Explain how this should be applied.
|
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
application/external.dns.webhook+json;version=1:
|
application/external.dns.webhook+json;version=1:
|
||||||
@ -135,14 +133,14 @@ components:
|
|||||||
|
|
||||||
endpoints:
|
endpoints:
|
||||||
description: |
|
description: |
|
||||||
TODO: explain the endpoints array.
|
This is a list of DNS records.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/endpoint'
|
$ref: '#/components/schemas/endpoint'
|
||||||
|
|
||||||
endpoint:
|
endpoint:
|
||||||
description: |
|
description: |
|
||||||
TODO: explain the endpoint object.
|
This is a DNS record.
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
dnsName:
|
dnsName:
|
||||||
@ -171,7 +169,8 @@ components:
|
|||||||
|
|
||||||
targets:
|
targets:
|
||||||
description: |
|
description: |
|
||||||
TODO: explain the targets array.
|
This is the list of targets that this DNS record points to.
|
||||||
|
So for an A record it will be a list of IP addresses.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
@ -195,7 +194,11 @@ components:
|
|||||||
|
|
||||||
changes:
|
changes:
|
||||||
description: |
|
description: |
|
||||||
TODO: explain the changes object.
|
This is the list of changes that need to be applied. There are
|
||||||
|
four lists of endpoints. The `create` and `delete` lists are lists
|
||||||
|
of records to create and delete respectively. The `updateOld` and
|
||||||
|
`updateNew` lists are paired. For each entry there's the old version
|
||||||
|
of the record and a new version of the record.
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
create:
|
create:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user