mirror of
https://github.com/VinylDNS/vinyldns
synced 2025-08-22 10:10:12 +00:00
reorganize documentation site (#66)
* reorganize documentation site * move contributing and developer doc links * reorganize doc nav
This commit is contained in:
parent
dada99d493
commit
7544c787fe
@ -286,14 +286,15 @@ lazy val docSettings = Seq(
|
||||
micrositeDescription := "DNS Management Platform",
|
||||
micrositeAuthor := "VinylDNS",
|
||||
micrositeHomepage := "http://vinyldns.io",
|
||||
micrositeDocumentationUrl := "/apidocs",
|
||||
micrositeDocumentationUrl := "/api",
|
||||
micrositeGitterChannelUrl := "vinyldns/Lobby",
|
||||
micrositeDocumentationLabelDescription := "API Documentation",
|
||||
micrositeShareOnSocial := false,
|
||||
micrositeExtraMdFiles := Map(
|
||||
file("CONTRIBUTING.md") -> ExtraMdFileConfig(
|
||||
"contributing.md",
|
||||
"page",
|
||||
Map("title" -> "Contributing", "section" -> "contributing", "position" -> "2")
|
||||
Map("title" -> "Contributing", "section" -> "contributing", "position" -> "4")
|
||||
)
|
||||
),
|
||||
micrositePushSiteWith := GitHub4s,
|
||||
|
@ -1,152 +1,142 @@
|
||||
options:
|
||||
|
||||
#############################
|
||||
# API Docs Menu Options #
|
||||
# Docs Layout Menu Options #
|
||||
#############################
|
||||
|
||||
- title: API Documentation
|
||||
url: apidocs/index
|
||||
menu_type: apidocs
|
||||
menu_section: apidocs
|
||||
- title: Portal Guide
|
||||
url: user/index.html
|
||||
menu_type: portal_menu
|
||||
menu_section: portal_section
|
||||
|
||||
- title: 1 - Getting Started
|
||||
url: apidocs/basics.html
|
||||
menu_type: apidocs
|
||||
menu_section: gettingstarted
|
||||
- title: Operator Guide
|
||||
url: operator/index.html
|
||||
menu_type: operator_menu
|
||||
menu_section: operator_section
|
||||
|
||||
nested_options:
|
||||
- title: Basics
|
||||
url: apidocs/basics.html
|
||||
menu_section: gettingstarted
|
||||
- title: Getting Help
|
||||
url: apidocs/getting-help.html
|
||||
menu_section: gettingstarted
|
||||
- title: FAQ
|
||||
url: apidocs/faq.html
|
||||
menu_section: gettingstarted
|
||||
- title: Tools
|
||||
url: apidocs/tools.html
|
||||
menu_section: gettingstarted
|
||||
- title: API documentation
|
||||
url: api/index
|
||||
menu_type: api
|
||||
menu_section: api
|
||||
|
||||
- title: 2.1 - Authentication
|
||||
url: apidocs/auth-mechanism.html
|
||||
menu_type: apidocs
|
||||
menu_section: authentication
|
||||
- title: Authentication
|
||||
url: api/auth-mechanism.html
|
||||
menu_type: api
|
||||
|
||||
- title: 2.2 - Zone
|
||||
url: apidocs/zone-model.html
|
||||
menu_type: apidocs
|
||||
- title: Zone
|
||||
url: api/zone-model.html
|
||||
menu_type: api
|
||||
menu_section: zoneapireference
|
||||
|
||||
nested_options:
|
||||
- title: Zone Model
|
||||
url: apidocs/zone-model.html
|
||||
url: api/zone-model.html
|
||||
menu_section: zoneapireference
|
||||
- title: Create Zone
|
||||
url: apidocs/create-zone.html
|
||||
url: api/create-zone.html
|
||||
menu_section: zoneapireference
|
||||
- title: Update Zone
|
||||
url: apidocs/update-zone.html
|
||||
url: api/update-zone.html
|
||||
menu_section: zoneapireference
|
||||
- title: Delete Zone
|
||||
url: apidocs/delete-zone.html
|
||||
url: api/delete-zone.html
|
||||
menu_section: zoneapireference
|
||||
- title: Get Zone
|
||||
url: apidocs/get-zone.html
|
||||
url: api/get-zone.html
|
||||
menu_section: zoneapireference
|
||||
- title: List / Search Zone
|
||||
url: apidocs/list-zones.html
|
||||
url: api/list-zones.html
|
||||
menu_section: zoneapireference
|
||||
- title: Sync Zone
|
||||
url: apidocs/sync-zone.html
|
||||
url: api/sync-zone.html
|
||||
menu_section: zoneapireference
|
||||
- title: List Zone Changes
|
||||
url: apidocs/list-zone-changes.html
|
||||
url: api/list-zone-changes.html
|
||||
menu_section: zoneapireference
|
||||
|
||||
- title: 2.3 - RecordSet
|
||||
url: apidocs/recordset-model.html
|
||||
menu_type: apidocs
|
||||
- title: RecordSet
|
||||
url: api/recordset-model.html
|
||||
menu_type: api
|
||||
menu_section: recordsetapireference
|
||||
|
||||
nested_options:
|
||||
- title: RecordSet Model
|
||||
url: apidocs/recordset-model.html
|
||||
url: api/recordset-model.html
|
||||
menu_section: recordsetapireference
|
||||
- title: Create RecordSet
|
||||
url: apidocs/create-recordset.html
|
||||
url: api/create-recordset.html
|
||||
menu_section: recordsetapireference
|
||||
- title: Update RecordSet
|
||||
url: apidocs/update-recordset.html
|
||||
url: api/update-recordset.html
|
||||
menu_section: recordsetapireference
|
||||
- title: Delete RecordSet
|
||||
url: apidocs/delete-recordset.html
|
||||
url: api/delete-recordset.html
|
||||
menu_section: recordsetapireference
|
||||
- title: Get RecordSet
|
||||
url: apidocs/get-recordset.html
|
||||
url: api/get-recordset.html
|
||||
menu_section: recordsetapireference
|
||||
- title: List / Search RecordSets
|
||||
url: apidocs/list-recordsets.html
|
||||
url: api/list-recordsets.html
|
||||
menu_section: recordsetapireference
|
||||
- title: Get RecordSet Change
|
||||
url: apidocs/get-recordset-change.html
|
||||
url: api/get-recordset-change.html
|
||||
menu_section: recordsetapireference
|
||||
- title: List RecordSet Changes
|
||||
url: apidocs/list-recordset-changes.html
|
||||
url: api/list-recordset-changes.html
|
||||
menu_section: recordsetapireference
|
||||
|
||||
- title: 2.4 - Batch Change
|
||||
url: apidocs/batchchange-model.html
|
||||
menu_type: apidocs
|
||||
- title: Batch Change
|
||||
url: api/batchchange-model.html
|
||||
menu_type: api
|
||||
menu_section: batchchangeapireference
|
||||
|
||||
nested_options:
|
||||
- title: Batch Change Model
|
||||
url: apidocs/batchchange-model.html
|
||||
url: api/batchchange-model.html
|
||||
menu_section: batchchangeapireference
|
||||
- title: Create Batch Change
|
||||
url: apidocs/create-batchchange.html
|
||||
url: api/create-batchchange.html
|
||||
menu_section: batchchangeapireference
|
||||
- title: Get Batch Change
|
||||
url: apidocs/get-batchchange.html
|
||||
url: api/get-batchchange.html
|
||||
menu_section: batchchangeapireference
|
||||
- title: List Batch Changes
|
||||
url: apidocs/list-batchchanges.html
|
||||
url: api/list-batchchanges.html
|
||||
menu_section: batchchangeapireference
|
||||
- title: Batch Change Errors
|
||||
url: apidocs/batchchange-errors.html
|
||||
url: api/batchchange-errors.html
|
||||
menu_section: batchchangeapireference
|
||||
|
||||
- title: 2.5 - Membership
|
||||
url: apidocs/membership-model.html
|
||||
menu_type: apidocs
|
||||
- title: Membership
|
||||
url: api/membership-model.html
|
||||
menu_type: api
|
||||
menu_section: membershipapireference
|
||||
|
||||
nested_options:
|
||||
- title: Membership Model
|
||||
url: apidocs/membership-model.html
|
||||
url: api/membership-model.html
|
||||
menu_section: membershipapireference
|
||||
- title: Create Group
|
||||
url: apidocs/create-group.html
|
||||
url: api/create-group.html
|
||||
menu_section: membershipapireference
|
||||
- title: Update Group
|
||||
url: apidocs/update-group.html
|
||||
url: api/update-group.html
|
||||
menu_section: membershipapireference
|
||||
- title: Delete Group
|
||||
url: apidocs/delete-group.html
|
||||
url: api/delete-group.html
|
||||
menu_section: membershipapireference
|
||||
- title: Get Group
|
||||
url: apidocs/get-group.html
|
||||
url: api/get-group.html
|
||||
menu_section: membershipapireference
|
||||
- title: List Groups
|
||||
url: apidocs/list-groups.html
|
||||
url: api/list-groups.html
|
||||
menu_section: membershipapireference
|
||||
- title: List Group Admins
|
||||
url: apidocs/list-group-admins.html
|
||||
url: api/list-group-admins.html
|
||||
menu_section: membershipapireference
|
||||
- title: List Group Members
|
||||
url: apidocs/list-group-members.html
|
||||
url: api/list-group-members.html
|
||||
menu_section: membershipapireference
|
||||
- title: List Group Activity
|
||||
url: apidocs/list-group-activity.html
|
||||
url: api/list-group-activity.html
|
||||
menu_section: membershipapireference
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "API Authentication"
|
||||
section: "apidocs"
|
||||
title: "Authentication"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# API Authentication
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Batch Change Errors"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Batch Change Errors
|
||||
@ -282,7 +282,7 @@ Record "<input>" Does Not Exist: cannot delete a record that does not exist.
|
||||
##### Details:
|
||||
|
||||
A record with the given name could not be found in VinylDNS.
|
||||
If the record exists in DNS, then you should [sync the zone](../apidocs/vinyl-basics/#syncingZone) for that record to bring VinylDNS up to date with what is in the DNS backend.
|
||||
If the record exists in DNS, then you should [sync the zone](../api/vinyl-basics/#syncingZone) for that record to bring VinylDNS up to date with what is in the DNS backend.
|
||||
|
||||
|
||||
#### 12. CNAME Conflict <a id="CNAMEConflict"></a>
|
||||
@ -363,7 +363,7 @@ Batch change contained no changes. Batch change must have at least one change, u
|
||||
|
||||
##### DETAILS:
|
||||
|
||||
There were no changes found in the [create batch change](../apidocs/create-batchchange) request. A batch must contain at least one change and no more than 20 changes.
|
||||
There were no changes found in the [create batch change](../api/create-batchchange) request. A batch must contain at least one change and no more than 20 changes.
|
||||
|
||||
|
||||
#### 2. CHANGE LIMIT EXCEEDED <a id="ChangeLimitExceeded" />
|
||||
@ -382,7 +382,7 @@ Cannot request more than <limit> changes in a single batch change request
|
||||
|
||||
##### DETAILS:
|
||||
|
||||
The number of change inputs in the [create batch change](../apidocs/create-batchchange) request exceeds the max change input limit threshold, which is currently set to 20.
|
||||
The number of change inputs in the [create batch change](../api/create-batchchange) request exceeds the max change input limit threshold, which is currently set to 20.
|
||||
|
||||
|
||||
#### 3. BATCH CHANGE NOT FOUND <a id="BatchChangeNotFound" />
|
||||
@ -391,7 +391,7 @@ The number of change inputs in the [create batch change](../apidocs/create-batch
|
||||
|
||||
Code | description |
|
||||
------------ | :---------- |
|
||||
404 | **Not Found** - batch change not found for specified ID in [get batch change](../apidocs/get-batchchange) request. |
|
||||
404 | **Not Found** - batch change not found for specified ID in [get batch change](../api/get-batchchange) request. |
|
||||
|
||||
##### ERROR MESSAGE:
|
||||
|
||||
@ -401,7 +401,7 @@ Batch change with id <id> cannot be found
|
||||
|
||||
##### DETAILS:
|
||||
|
||||
The batch ID specified in the [get batch change](../apidocs/get-batchchange) request does not exist.
|
||||
The batch ID specified in the [get batch change](../api/get-batchchange) request does not exist.
|
||||
|
||||
|
||||
#### 4. MALFORMED JSON ERRORS <a id="malformed-json-errors" />
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Batch Change Model"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Batch Change Model
|
||||
@ -15,12 +15,12 @@ section: "apidocs"
|
||||
|
||||
#### BATCH CHANGE INFORMATION <a id="batchchange-info" />
|
||||
|
||||
Batch change is an alternative to submitting individual [RecordSet](../apidocs/recordset-model) changes and provides the following:
|
||||
Batch change is an alternative to submitting individual [RecordSet](../api/recordset-model) changes and provides the following:
|
||||
|
||||
- The ability to accept multiple changes in a single API call.
|
||||
- The ability to include records of multiple record types across multiple zones.
|
||||
- Input names are entered as fully-qualified domain names (or IP addresses for **PTR** records), so users don't have to think in record/zone context.
|
||||
- All record validations are processed simultaneously. [Errors](../apidocs/batchchange-errors/#fail-slow-errors) for any change in the batch will result in a **400** response and none will be applied.
|
||||
- All record validations are processed simultaneously. [Errors](../api/batchchange-errors/#fail-slow-errors) for any change in the batch will result in a **400** response and none will be applied.
|
||||
|
||||
A batch change consists of multiple single changes which can be a combination of [SingleAddChanges](#singleaddchange-attributes) and [SingleDeleteChanges](#singledeletechange-attributes).
|
||||
|
||||
@ -48,7 +48,7 @@ id | string | The unique identifier for this batch change. |
|
||||
|
||||
#### SINGLE CHANGE ATTRIBUTES <a id="singlechange-attributes" />
|
||||
|
||||
A successful batch change response consists of a corresponding [SingleAddChange](#singleaddchange-attributes) or [SingleDeleteChange](#singledeletechange-attributes) for each batch change input. See the [batch change create](../apidocs/create-batchchange) page for details on constructing a batch change request.
|
||||
A successful batch change response consists of a corresponding [SingleAddChange](#singleaddchange-attributes) or [SingleDeleteChange](#singledeletechange-attributes) for each batch change input. See the [batch change create](../api/create-batchchange) page for details on constructing a batch change request.
|
||||
|
||||
#### SingleAddChange <a id="singleaddchange-attributes" />
|
||||
|
||||
@ -58,7 +58,7 @@ changeType | ChangeInputType | Type of change input. Can either be an **Add**
|
||||
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. |
|
||||
record | [RecordData](../apidocs/recordset-model/#record-data) | The data added for this record, which varies by record type. |
|
||||
record | [RecordData](../api/recordset-model/#record-data) | The data added for this record, which varies by record type. |
|
||||
status | SingleChangeStatus | Status for this change. Can be one of: **Pending**, **Complete** or **Failed**. |
|
||||
recordName | string | The name of the record. Record names for the apex will be match the zone name (including terminating dot). |
|
||||
zoneName | string | The name of the zone. |
|
@ -1,12 +1,12 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Create Batch Change"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Create Batch Change
|
||||
|
||||
Creates a batch change with [SingleAddChanges](../apidocs/batchchange-model/#singleaddchange-attributes) and/or [SingleDeleteChanges](../apidocs/batchchange-model/#singledeletechange-attributes) across different zones. A delete and add of the same record will be treated as an update on that record set. Regardless of the input order in the batch change, all deletes for the same recordset will be logically applied before the adds.
|
||||
Creates a batch change with [SingleAddChanges](../api/batchchange-model/#singleaddchange-attributes) and/or [SingleDeleteChanges](../api/batchchange-model/#singledeletechange-attributes) across different zones. A delete and add of the same record will be treated as an update on that record set. Regardless of the input order in the batch change, all deletes for the same recordset will be logically applied before the adds.
|
||||
|
||||
Current supported record types for creating a batch change are: **A**, **AAAA**, **CNAME**, and **PTR**. A batch must contain at least one change and no more than 20 changes.
|
||||
|
||||
@ -15,7 +15,7 @@ Current supported record types for creating a batch change are: **A**, **AAAA**,
|
||||
|
||||
> POST /zones/batchrecordchanges
|
||||
|
||||
Note that the batch change request inputs are a subset of the full [batch change model](../apidocs/batchchange-model/#batchchange-attributes).
|
||||
Note that the batch change request inputs are a subset of the full [batch change model](../api/batchchange-model/#batchchange-attributes).
|
||||
|
||||
#### HTTP REQUEST PARAMS
|
||||
|
||||
@ -33,7 +33,7 @@ changeType | ChangeInputType | yes | Type of change input. Must be set
|
||||
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 | yes | The time-to-live in seconds. The minimum and maximum values are 30 and 2147483647, respectively. |
|
||||
record | [RecordData](../apidocs/recordset-model/#record-data) | yes | The data for the record. |
|
||||
record | [RecordData](../api/recordset-model/#record-data) | yes | The data for the record. |
|
||||
|
||||
##### DeleteChangeInput <a id="deletechangeinput-attributes" />
|
||||
|
||||
@ -98,16 +98,16 @@ The first two items in the changes list are SingleAddChanges of an **A** record
|
||||
Code | description |
|
||||
------------ | :---------- |
|
||||
202 | **Accepted** - The batch change is queued and is returned in the response body. |
|
||||
400 | **Bad Request** - Error in the batch change. See [Batch Change Errors](../apidocs/batchchange-errors) page. |
|
||||
400 | **Bad Request** - Error in the batch change. See [Batch Change Errors](../api/batchchange-errors) page. |
|
||||
403 | **Forbidden** - The user does not have the access required to perform the action. |
|
||||
413 | **Request Entity Too Large** - Cannot request more than 20 changes in a single batch change request. |
|
||||
422 | **Unprocessable Entity** - the batch does not contain any changes, thus cannot be processed. |
|
||||
|
||||
A batch change goes through numerous validations before it is processed. This results in corresponding BadRequest or error responses. View the full list of batch change errors [here](../apidocs/batchchange-errors).
|
||||
A batch change goes through numerous validations before it is processed. This results in corresponding BadRequest or error responses. View the full list of batch change errors [here](../api/batchchange-errors).
|
||||
|
||||
#### HTTP RESPONSE ATTRIBUTES
|
||||
|
||||
On success, the response from create batch change includes the fields the user input, as well as some additional information provided by the system. This response is the same as that of [get batch change](../apidocs/get-batchchange/#http-response-attributes).
|
||||
On success, the response from create batch change includes the fields the user input, as well as some additional information provided by the system. This response is the same as that of [get batch change](../api/get-batchchange/#http-response-attributes).
|
||||
|
||||
|
||||
#### EXAMPLE RESPONSE
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Create Group"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Create Group
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Create RecordSet"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Create RecordSet
|
||||
@ -20,7 +20,7 @@ zoneId | string | yes | id of the zone where the recordset
|
||||
name | string | yes | the name of the recordset being updated |
|
||||
type | string | yes | the type of recordset |
|
||||
ttl | integer | yes | the TTL in seconds |
|
||||
records | array of record data | yes | record data for recordset, see [RecordSet Model](../apidocs/recordset-model) |
|
||||
records | array of record data | yes | record data for recordset, see [RecordSet Model](../api/recordset-model) |
|
||||
|
||||
#### EXAMPLE HTTP REQUEST
|
||||
```
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Create Zone"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Create Zone
|
||||
@ -15,7 +15,7 @@ if no info is provided the default VinylDNS connections will be used
|
||||
|
||||
#### HTTP REQUEST PARAMS
|
||||
|
||||
**zone fields** - adminGroupId, name, and email are required - refer to [zone model](../apidocs/zone-model) |
|
||||
**zone fields** - adminGroupId, name, and email are required - refer to [zone model](../api/zone-model) |
|
||||
|
||||
#### EXAMPLE HTTP REQUEST
|
||||
```
|
||||
@ -41,7 +41,7 @@ Code | description |
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
status | string | status of zone change |
|
||||
zone | map | refer to [zone model](../apidocs/zone-model) |
|
||||
zone | map | refer to [zone model](../api/zone-model) |
|
||||
created | string | the time (GMT) the change was initiated |
|
||||
changeType | string | type of change requested (Create, Update, Sync, Delete); in this case Create |
|
||||
userId | string | the user id that initiated the change |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Delete Group"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Delete Group
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Delete RecordSet"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Delete RecordSet
|
@ -1,14 +1,14 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Delete Zone"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Delete Zone
|
||||
|
||||
Abandons an existing zone that has already been connected to.
|
||||
The zone will be disconnected from VinylDNS, but the RecordSets still exist in the backend DNS zone.
|
||||
To delete the RecordSets see [Delete RecordSet](../apidocs/delete-recordset)
|
||||
To delete the RecordSets see [Delete RecordSet](../api/delete-recordset)
|
||||
|
||||
*Note: We do not recommend that you abandon zones, as your zone history will be lost after the Delete. This endpoint is provided in certain situations where a zone was incorrectly started.*
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Get Batch Change"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Get Batch Change
|
||||
@ -38,7 +38,7 @@ userId | string | The unique identifier of the user that created the
|
||||
userName | string | The username of the user that created the batch change. |
|
||||
comments | string | Optional comments about the batch change. |
|
||||
createdTimestamp | date-time | The timestamp (in GMT) when the batch change was created. |
|
||||
changes | Array of SingleChange | Array of single changes within a batch change. A *SingleChange* can either be a [SingleAddChange](../apidocs/batchchange-model/#singleaddchange-info) or a [SingleDeleteChange](../apidocs/batchchange-model/#singledeletechange-info). |
|
||||
changes | Array of SingleChange | Array of single changes within a batch change. A *SingleChange* can either be a [SingleAddChange](../api/batchchange-model/#singleaddchange-info) or a [SingleDeleteChange](../api/batchchange-model/#singledeletechange-info). |
|
||||
status | BatchChangeStatus | **Pending** - at least one change in batch in still in pending state; **Complete** - all changes are in complete state; **Failed** - all changes are in failure state; **PartialFailure** - some changes have failed and the rest are complete. |
|
||||
id | string | The unique identifier for this batch change. |
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Get Group"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Get Group
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Get RecordSet Change"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Get RecordSet Change
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Get RecordSet"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Get RecordSet
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Get Zone"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Get Zone
|
||||
@ -25,7 +25,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
zone | map | refer to [zone model](../apidocs/zone-model) |
|
||||
zone | map | refer to [zone model](../api/zone-model) |
|
||||
|
||||
#### EXAMPLE RESPONSE
|
||||
|
13
modules/docs/src/main/tut/api/index.md
Executable file
13
modules/docs/src/main/tut/api/index.md
Executable file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "API documentation"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# API documentation
|
||||
|
||||
* [Authentication](auth-mechanism)
|
||||
* [Zone](zone-model)
|
||||
* [RecordSet](recordset-model)
|
||||
* [Batch Change](batchchange-model)
|
||||
* [Membership](membership-model)
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Batch Changes"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Batch Changes
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Group Activity"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Group Activity
|
||||
@ -40,8 +40,8 @@ maxItems | integer | maxItems sent in request, default is 100 |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
newGroup | map | The new group as a result of the change, refer to [Membership Model]("../apidocs/membership-model") |
|
||||
oldGroup | map | The old group before the change, refer to [Membership Model]("../apidocs/membership-model") |
|
||||
newGroup | map | The new group as a result of the change, refer to [Membership Model]("../api/membership-model") |
|
||||
oldGroup | map | The old group before the change, refer to [Membership Model]("../api/membership-model") |
|
||||
created | string | Millisecond timestamp that change was created
|
||||
userId | string | User Id of user who made the change |
|
||||
changeType | string | The type change, either Create, Update, or Delete |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Group Admins"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Group Admins
|
||||
@ -24,7 +24,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
admins | Array of Users | refer to [membership model](../apidocs/membership-model) |
|
||||
admins | Array of Users | refer to [membership model](../api/membership-model) |
|
||||
|
||||
#### EXAMPLE RESPONSE
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Group Members"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Group Members
|
||||
@ -31,7 +31,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
members | Array of Users | refer to [membership model](../apidocs/membership-model), these Users will also include an isAdmin attribute |
|
||||
members | Array of Users | refer to [membership model](../api/membership-model), these Users will also include an isAdmin attribute |
|
||||
startFrom | *any* | startFrom sent in request, will not be returned if not provided |
|
||||
nextId | *any* | nextId, used as startFrom parameter of next page request, will not be returned if members are exhausted |
|
||||
maxItems | integer | maxItems sent in request, default is 100 |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Groups"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Groups
|
||||
@ -31,7 +31,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
groups | Array of Groups | refer to [membership model](../apidocs/membership-model) |
|
||||
groups | Array of Groups | refer to [membership model](../api/membership-model) |
|
||||
startFrom | *any* | startFrom sent in request, will not be returned if not provided |
|
||||
nextId | *any* | nextId, used as startFrom parameter of next page request, will not be returned if groups are exhausted |
|
||||
maxItems | integer | maxItems sent in request, default is 100 |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List RecordSet Changes"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List RecordSet Changes
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List / Search RecordSets"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List / Search RecordSets
|
||||
@ -33,7 +33,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
recordSets | Array of RecordSets | refer to [recordset model](../apidocs/recordset-model), the RecordSet data will also include the accessLevel the requesting user has based off acl rules and membership in Zone Admin Group |
|
||||
recordSets | Array of RecordSets | refer to [recordset model](../api/recordset-model), the RecordSet data will also include the accessLevel the requesting user has based off acl rules and membership in Zone Admin Group |
|
||||
startFrom | *any* | startFrom sent in request, will not be returned if not provided |
|
||||
nextId | *any* | nextId, used as startFrom parameter of next page request, will not be returned if record sets are exhausted |
|
||||
maxItems | integer | maxItems sent in request, default is 100 |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List Zone Changes"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List Zone Changes
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "List / Search Zones"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# List / Search Zone
|
||||
@ -32,7 +32,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
zones | Array of [Zones](../apidocs/zone-model#zone-attributes) | An array of the zones found. The zones are sorted alphabetically by zone name. |
|
||||
zones | Array of [Zones](../api/zone-model#zone-attributes) | An array of the zones found. The zones are sorted alphabetically by zone name. |
|
||||
startFrom | *any* | (optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent |
|
||||
nextId | *any* | (optional) The identifier to be passed in as the *startFrom* parameter to retrieve the next page of results. If there are no results left, this field will not be present.
|
||||
maxItems | int | The maxItems parameter that was sent in on the HTTP request. This will be 100 if not sent. |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Membership Model"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Membership Model
|
||||
@ -16,12 +16,12 @@ section: "apidocs"
|
||||
#### MEMBERSHIP BREAKDOWN
|
||||
|
||||
Every zone can be connected to by only one group in VinylDNS. That initial group will be the admin group for that zone,
|
||||
which can be changed later on in a [Zone Update](../apidocs/update-zone). Every member of the admin group
|
||||
which can be changed later on in a [Zone Update](../api/update-zone). Every member of the admin group
|
||||
will be an admin of that zone, and can preform zone syncs, zone updates, zone deletes, and record set changes regardless
|
||||
of any Access Control Rules set on them.
|
||||
<br><br>
|
||||
While users in the admin group will have complete zone access, further users can be given limited membership through [Zone
|
||||
ACL Rules](../apidocs/zone-model/#zone-acl-rule-attr)
|
||||
ACL Rules](../api/zone-model/#zone-acl-rule-attr)
|
||||
|
||||
#### GROUP ATTRIBUTES <a id="group-attributes"></a>
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "RecordSet Model"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# RecordSet Model
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Sync Zone"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Sync Zone
|
||||
@ -41,7 +41,7 @@ Code | description |
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
status | string | sync status |
|
||||
zone | map | refer to [zone model](../apidocs/zone-model) |
|
||||
zone | map | refer to [zone model](../api/zone-model) |
|
||||
created | string | the time (GMT) the sync was initiated |
|
||||
changeType | string | type of change requested (Create, Update, Sync, Delete); in this case Sync |
|
||||
userId | string | the user id that initiated the change |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Update Group"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Update Group
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Update RecordSet"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Update RecordSet
|
||||
@ -22,7 +22,7 @@ id | string | yes | the id of the recordset being upda
|
||||
name | string | yes | the name of the recordset being updated |
|
||||
type | string | yes | the type of recordset |
|
||||
ttl | integer | yes | the TTL in seconds |
|
||||
records | array of record data | yes | record data for recordset, see [RecordSet Model](../apidocs/recordset-model) |
|
||||
records | array of record data | yes | record data for recordset, see [RecordSet Model](../api/recordset-model) |
|
||||
|
||||
#### EXAMPLE HTTP REQUEST
|
||||
```
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Update Zone"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Update Zone
|
||||
@ -14,7 +14,7 @@ Updates an existing zone that has already been connected to. Used to update the
|
||||
|
||||
#### HTTP REQUEST PARAMS
|
||||
|
||||
**zone fields**, refer to [zone model](../apidocs/zone-model) |
|
||||
**zone fields**, refer to [zone model](../api/zone-model) |
|
||||
|
||||
#### EXAMPLE HTTP REQUEST
|
||||
|
||||
@ -54,7 +54,7 @@ Code | description |
|
||||
|
||||
name | type | description |
|
||||
------------ | ------------- | :---------- |
|
||||
zone | map | zone sent with update request, refer to [zone model](../apidocs/zone-model) |
|
||||
zone | map | zone sent with update request, refer to [zone model](../api/zone-model) |
|
||||
userId | string | the user id that initiated the change |
|
||||
changeType | string | type of change requested (Create, Update, Sync, Delete); in this case Update |
|
||||
created | string | the time (GMT) the change was initiated |
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Zone Model"
|
||||
section: "apidocs"
|
||||
section: "api"
|
||||
---
|
||||
|
||||
# Zone Model
|
||||
@ -110,7 +110,7 @@ key | string | The TSIG secret key used to sign requests when com
|
||||
#### ZONE ACL RULE ATTRIBUTES <a id="zone-acl-rule-attr"></a>
|
||||
ACL Rules are used to govern user and group access to record operations on a zone. ACL Rules can be associated with a specific user, or all users in a specified group. If neither a user _or_ a group is attached to an ACL rule, then the rule applies to _all_ users in the system.
|
||||
<br><br>
|
||||
Use the [Zone Update](../apidocs/update-zone) endpoint to update the **acl** attribute of the zone
|
||||
Use the [Zone Update](../api/update-zone) endpoint to update the **acl** attribute of the zone
|
||||
|
||||
> **Important!** If a user is mentioned on an ACL Rule directly, or is a member of a group that is mentioned on an ACL Rule, that user will be able to see the zone.
|
||||
|
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "API Documentation"
|
||||
section: "apidocs"
|
||||
position: 4
|
||||
---
|
||||
|
||||
# Welcome
|
||||
|
||||
VinylDNS is a DNS Management Platform that provides safe and convenient access
|
||||
for your DNS needs.
|
||||
|
||||
Features Include:
|
||||
|
||||
- Connect to an _existing_ DNS zone
|
||||
- Define permissions to govern record access for your zone(s)
|
||||
- Create, Update, Delete DNS records in your zone(s)
|
||||
- Search for Records in your zone(s)
|
||||
- View every change to every record in your zone(s)
|
||||
- Manage Groups and Members
|
||||
- Synchronize VinylDNS with records from DNS
|
||||
|
||||
[Click Here to Get Started!](../apidocs/basics)
|
@ -1,7 +1,8 @@
|
||||
---
|
||||
layout: docs
|
||||
layout: page
|
||||
title: "FAQ"
|
||||
section: "apidocs"
|
||||
section: "user_menu"
|
||||
position: 6
|
||||
---
|
||||
|
||||
# VinylDNS FAQ
|
||||
@ -82,4 +83,4 @@ name servers that are not in this list, you will not be able to use VinylDNS to
|
||||
After logging in to the portal, click your username at the top right and select *Download API Credentials*.
|
||||
|
||||
### 9. How are requests authenticated to the VinylDNS API? <a id="9"></a>
|
||||
Refer to [API Authentication](../apidocs/auth-mechanism).
|
||||
Refer to [API Authentication](../api/auth-mechanism).
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
layout: page
|
||||
title: "Getting Help"
|
||||
section: "apidocs"
|
||||
position: 7
|
||||
---
|
||||
|
||||
# Getting Help
|
@ -21,5 +21,3 @@ Features Include:
|
||||
- View every change to every record in your zone(s)
|
||||
- Manage Groups and Members
|
||||
- Synchronize VinylDNS with records from DNS
|
||||
|
||||
[Click Here to Get Started!](./apidocs/basics)
|
||||
|
8
modules/docs/src/main/tut/operator/index.md
Normal file
8
modules/docs/src/main/tut/operator/index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Operator Guide"
|
||||
section: "operator_menu"
|
||||
position: 3
|
||||
---
|
||||
|
||||
## Operator Guide
|
13
modules/docs/src/main/tut/apidocs/basics.md → modules/docs/src/main/tut/portal.md
Executable file → Normal file
13
modules/docs/src/main/tut/apidocs/basics.md → modules/docs/src/main/tut/portal.md
Executable file → Normal file
@ -1,16 +1,11 @@
|
||||
---
|
||||
layout: docs
|
||||
title: "Basics"
|
||||
section: "apidocs"
|
||||
title: "Portal Guide"
|
||||
section: "user_menu"
|
||||
position: 2
|
||||
---
|
||||
|
||||
# VinylDNS Basics
|
||||
|
||||
VinylDNS makes DNS self-service safe and convenient. It provides the following features:
|
||||
|
||||
- A user interface for viewing and managing DNS records
|
||||
- Complete audit trail of all changes that have ever been performed through VinylDNS
|
||||
- Fine grained security for DNS records
|
||||
## Portal documentation
|
||||
|
||||
#### Table of contents
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
layout: page
|
||||
title: "Tools"
|
||||
section: "apidocs"
|
||||
position: 5
|
||||
---
|
||||
|
||||
# VinylDNS Tools
|
Loading…
x
Reference in New Issue
Block a user