mir/vinyldns
2
0
Fork 0
mirror of https://github.com/VinylDNS/vinyldns synced 2025-08-30 22:05:21 +00:00
Code Issues Releases Wiki Activity

add DeleteRecord info to the docs (#792)

Browse Source 
* add DeleteRecord info to the docs
This commit is contained in:
Britney Wright
2019-09-27 21:40:37 -04:00
committed by GitHub
parent cbaa13e647
commit f19f293cf7
4 changed files with 45 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
modules/docs/src/main/resources/microsite/static/dns-changes-csv-sample.csv
View File

@@ -6,9 +6,14 @@ Add,AAAA,test3.example.com.,,fd69:27cc:fe91::60
Add,CNAME,test4.example.com.,,test0.example.com.
Add,PTR,192.0.2.193,200,test.example.com.
Add,TXT,test5.example.com,7200,example text
DeleteRecordSet,A+PTR,test5.example.com.,,1.1.1.1
DeleteRecordSet,A,test6.exmaple.com.,,
DeleteRecordSet,AAAA+PTR,test7.example.com.,,fd69:27cc:fe91::60
DeleteRecordSet,CNAME,test8.example.com.,,
DeleteRecordSet,PTR,193.0.2.192,,
DeleteRecordSet,TXT,test5.example.com,,
DeleteRecord,A+PTR,test.example.,,1.1.1.1
DeleteRecord,A,test1.example.,,1.2.3.4
DeleteRecord,AAAA+PTR,test2.example.,,fd69:27cc:fe91::60
DeleteRecord,AAAA,test3.example.com.,,fd69:27cc:fe91::60
DeleteRecord,CNAME,test4.example.com.,,test0.example.com.
DeleteRecord,PTR,192.0.2.193,,test.example.com.
DeleteRecord,TXT,test5.example.com,,example text
1 Change Type Record Type Input Name TTL Record Data
6 Add CNAME test4.example.com. test0.example.com.
7 Add PTR 192.0.2.193 200 test.example.com.
8 Add TXT test5.example.com 7200 example text
DeleteRecordSet A+PTR test5.example.com. 1.1.1.1
9 DeleteRecordSet A test6.exmaple.com.
DeleteRecordSet AAAA+PTR test7.example.com. fd69:27cc:fe91::60
10 DeleteRecordSet CNAME test8.example.com.
11 DeleteRecordSet PTR 193.0.2.192
12 DeleteRecordSet TXT test5.example.com
13 DeleteRecord A+PTR test.example. 1.1.1.1
14 DeleteRecord A test1.example. 1.2.3.4
15 DeleteRecord AAAA+PTR test2.example. fd69:27cc:fe91::60
16 DeleteRecord AAAA test3.example.com. fd69:27cc:fe91::60
17 DeleteRecord CNAME test4.example.com. test0.example.com.
18 DeleteRecord PTR 192.0.2.193 test.example.com.
19 DeleteRecord TXT test5.example.com example text

33
modules/docs/src/main/tut/api/batchchange-errors.md
View File

@@ -123,8 +123,6 @@ the VinylDNS instance is configured to have manual review disabled.
- [Missing Owner Group Id](#MissingOwnerGroupId)
- [Not a Member of Owner Group](#NotAMemberOfOwnerGroup)
- [High Value Domain](#HighValueDomain)
- [RecordSet has Multiple Records](#ExistingMultiRecordError)
- [Cannot Create a RecordSet with Multiple Records](#NewMultiRecordError)
- [CNAME Cannot be the Same Name as Zone Name]("CnameApexError")
### Non-Fatal Errors <a id="non-fatal-errors"></a>
@@ -417,7 +415,6 @@ User "<user name>" must be a member of group "<group ID>" to apply this group to
You must be a member of the group you are assigning for record ownership in the batch change.
#### High Value Domain <a id="HighValueDomain"></a>
##### Error Message:
@@ -433,36 +430,6 @@ The list of high value domains is specific to each VinylDNS instance.
You should reach out to your VinylDNS administrators for more information.
#### RecordSet has Multiple DNS records <a id="ExistingMultiRecordError"></a>
##### Error Message:
```
RecordSet with name <name> and type <type> cannot be updated in a single Batch Change because it contains multiple DNS records (<count>).
```
##### Details:
This error means that the recordset you are attempting to update/delete has multiple records within it.
Note that this error is configuration-driven and will only appear if your instance of VinylDNS does not support multi-record batch updates.
#### Cannot Create a RecordSet with Multiple Records <a id="NewMultiRecordError"></a>
##### Error Message:
```
Multi-record recordsets are not enabled for this instance of VinylDNS. Cannot create a new record set with multiple records for inputName <name> and type <type>
```
##### Details:
This error means that you have multiple Add entries with the same name and type in a batch change.
Note that this error is configuration-driven and will only appear if your instance of VinylDNS does not support multi-record batch updates.
#### CNAME at the Zone Apex is not Allowed <a id="CnameApexError"></a>
##### Error Message:

28
modules/docs/src/main/tut/api/batchchange-model.md
View File

@@ -68,7 +68,7 @@ A successful batch change response consists of a corresponding [SingleAddChange]
name | type | description |
------------ | :------------ | :---------- |
changeType | ChangeInputType | Type of change input. Can either be an **Add** or **DeleteRecordSet**. |
changeType | ChangeInputType | Type of change input. Can be an **Add**, **DeleteRecordSet**, or **DeleteRecord**. [See full details](#changetype-values).|
inputName | string | The fully-qualified domain name of the record which was provided in the create batch request. |
type | RecordType | Type of DNS record, supported records for batch changes are currently: **A**, **AAAA**, **CNAME**, and **PTR**. |
ttl | long | The time-to-live in seconds. |
@@ -87,7 +87,7 @@ id | string | The unique identifier for this change. |
name | type | description |
------------ | :------------ | :---------- |
changeType | ChangeInputType | Type of change input. Can either be an **Add** or **DeleteRecordSet**. |
changeType | ChangeInputType | Type of change input. Can be an **Add**, **DeleteRecordSet**, or **DeleteRecord**. [See full details](#changetype-values).|
inputName | string | The fully-qualified domain name of the record which was provided in the create batch request. |
type | RecordType | Type of DNS record, supported records for batch changes are currently: **A**, **AAAA**, **CNAME**, and **PTR**. |
status | SingleChangeStatus | Status for this change. Can be one of: **Pending**, **Complete**, **Failed**, **NeedsReview** or **Rejected**. |
@@ -100,6 +100,14 @@ recordSetId | string | Conditional: The unique identifier for the recor
validationErrors | Array of BatchChangeError | Array containing any validation errors associated with this SingleDeleteRRSetChange. *Note: These will only exist on `NeedsReview` or `Rejected` SingleChanges* |
id | string | The unique identifier for this change. |
#### ChangeType Values <a id="changetype-values" />
There are three valid changeTypes for a SingleChange, **Add**, **DeleteRecordSet** and **DeleteRecord**.
Used alone, or in conjunction with one another, they determine if you are creating, removing or modifying DNS records. Below are the change types to use based on intended outcome.
- Create a new DNS record: **Add** changeType
- Delete an entire recordset: **DeleteRecordSet** changeType
- Delete a single record in a multi-record recordset: **DeleteRecord** changeType. Record types that only support one record data entry (i.e. CNAME records) will treat a DeleteRecord changeType as DeleteRecordSet.
- Update an existing recordset: at least one entry with a **DeleteRecord** or **DeleteRecordSet** changeType and at least one entry with a **Add** changeType.
#### BATCH CHANGE EXAMPLE <a id="batchchange-example" />
@@ -142,6 +150,22 @@ Successful batch change response example with a [SingleAddChange](#singleaddchan
"recordSetId": "4754b084-5f81-11e8-9c2d-fa7ae01bbebc",
"validationErrors": [],
"id": "c29d33e4-9bee-4417-a99b-6e815fdeb748"
},
{
"changeType": "DeleteRecord",
"inputName": "RecordName.zoneName.",
"type": "A",
"record": {
"address": "1.1.1.1"
},
"status": "Complete",
"recordName": "recordName",
"zoneName": "zoneName.",
"zoneId": "9cbdd3ac-9752-4d56-9ca0-6a1a14fc5562",
"recordChangeId": "4754b322-5f81-11e8-9c2d-fa7ae01bbebc",
"recordSetId": "4754b084-5f81-11e8-9c2d-fa7ae01bbebc",
"validationErrors": [],
"id": "c29d33e4-9bee-4417-a99b-6e815fdeb748"
}
],
"status": "Complete",

16
modules/docs/src/main/tut/api/create-batchchange.md
View File

@@ -25,14 +25,14 @@ name | type | required? | description |
comments | string | no | Optional comments about the batch change. |
changes | Array of ChangeInput| yes | Set of *ChangeInput*s in the batch change. A *ChangeInput* is an [AddChangeInput](#addchangeinput-attributes) or [DeleteChangeInput](#deletechangeinput-attributes). Type is inferred from specified *changeType*.|
ownerGroupId | string | sometimes | Record ownership assignment. Required if any records in the batch change are in [shared zones](../api/zone-model#shared-zones) and are new or unowned. |
scheduledTime | date-time | no | Optional datetime. Stored as UTC. Batch change will not be processed until after the scheduled time. Required format is an ISO 8601 date time string.|
scheduledTime | date-time | no | Optional datetime. Stored as UTC. Batch change will not be processed until after the scheduled time. Required format is an ISO 8601 date time string.|
allowManualReview | boolean | no | Optional override to control whether manual review is enabled for the batch change request. Default value is `true`. Must be passed in as a query parameter, not in the request body. |
##### AddChangeInput <a id="addchangeinput-attributes" />
name | type | required? | description |
------------ | :------------ | ----------- | :---------- |
changeType | ChangeInputType | yes | Type of change input. Must be set to **Add** for *AddChangeInput*. |
changeType | ChangeInputType | yes | Type of change input. Must be set to **Add** for *AddChangeInput*. [See full details](../api/batchchange-model/#changetype-values). |
inputName | string | yes | The fully qualified domain name of the record being added. For **PTR**, the input name is a valid IPv4 or IPv6 address. |
type | RecordType | yes | Type of DNS record. Supported records for batch changes are currently: **A**, **AAAA**, **CNAME**, and **PTR**. |
ttl | long | no | The time-to-live in seconds. The minimum and maximum values are 30 and 2147483647, respectively. If excluded, this will be set to the system default for new adds, or the existing TTL for updates |
@@ -42,10 +42,10 @@ record | [RecordData](../api/recordset-model#record-data) | yes |
name | type | required? | description |
------------ | :------------ | ----------- | :---------- |
changeType | ChangeInputType | yes | Type of change input. Must be **DeleteRecordSet** for *DeleteChangeInput*. |
changeType | ChangeInputType | yes | Type of change input. Must be **DeleteRecord** or **DeleteRecordSet** for *DeleteChangeInput*. [See full details](../api/batchchange-model/#changetype-values). |
inputName | string | yes | The fully qualified domain name of the record being deleted. |
type | RecordType | yes | Type of DNS record. Supported records for batch changes are currently: **A**, **AAAA**, **CNAME**, and **PTR**. |
record | [RecordData](../api/recordset-model#record-data) | sometimes | One existing record data entry in the recordset. Required if the changeType is DeleteRecord. |
#### EXAMPLE HTTP REQUEST
```
@@ -70,6 +70,14 @@ type | RecordType | yes | Type of DNS record. Supported reco
"record": {
"ptrdname": "ptrdata.data."
}
},
{
"inputName": "single.delete.example.",
"changeType": "DeleteRecord",
"type": "A",
"record": {
"address": "1.1.1.1"
}
},
{
"inputName": "cname.example.com.",