diff --git a/modules/docs/src/main/mdoc/api/create-zone.md b/modules/docs/src/main/mdoc/api/create-zone.md index be167a3b8..0232f36b0 100644 --- a/modules/docs/src/main/mdoc/api/create-zone.md +++ b/modules/docs/src/main/mdoc/api/create-zone.md @@ -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](zone-model.html) | +**Zone fields** - adminGroupId, name, and email are required. Refer to [zone model](zone-model.html). #### EXAMPLE HTTP REQUEST ```json @@ -40,8 +40,8 @@ Code | description | name | type | description | ------------ | ------------- | :---------- | -status | string | Status of zone change | -zone | map | Refer to [zone model](zone-model.html) | +status | string | Status of zone change | +zone | map | Refer to [zone model](zone-model.html) | created | string | The timestamp (UTC) 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 | diff --git a/modules/docs/src/main/mdoc/api/get-group-change.md b/modules/docs/src/main/mdoc/api/get-group-change.md index f63505051..50bd77c3a 100644 --- a/modules/docs/src/main/mdoc/api/get-group-change.md +++ b/modules/docs/src/main/mdoc/api/get-group-change.md @@ -25,8 +25,8 @@ Code | description | name | type | description | ----------------- | ------------- | :---------- | -newGroup | map | The new group as a result of the change, refer to [Membership Model](membership-model.html) | -oldGroup | map | The old group before the change, refer to [Membership Model](membership-model.html) | +newGroup | map | The new group as a result of the change. Refer to [Membership Model](membership-model.html) | +oldGroup | map | The old group before the change. Refer to [Membership Model](membership-model.html) | created | string | Millisecond timestamp that change was created userId | string | User Id of user who made the change | id | string | Id of the group change | diff --git a/modules/docs/src/main/mdoc/api/get-zone-by-id.md b/modules/docs/src/main/mdoc/api/get-zone-by-id.md index 788c44d82..626c4f18d 100644 --- a/modules/docs/src/main/mdoc/api/get-zone-by-id.md +++ b/modules/docs/src/main/mdoc/api/get-zone-by-id.md @@ -25,7 +25,7 @@ Code | description | name | type | description | ------------ | ------------- | :---------- | -zone | map | refer to [zone model](zone-model.html) | +zone | map | Refer to [zone model](zone-model.html) | #### EXAMPLE RESPONSE diff --git a/modules/docs/src/main/mdoc/api/get-zone-by-name.md b/modules/docs/src/main/mdoc/api/get-zone-by-name.md index d55d6339e..00e297443 100644 --- a/modules/docs/src/main/mdoc/api/get-zone-by-name.md +++ b/modules/docs/src/main/mdoc/api/get-zone-by-name.md @@ -25,7 +25,7 @@ Code | description | name | type | description | ------------ | ------------- | :---------- | -zone | map | refer to [zone model](zone-model.html) | +zone | map | Refer to [zone model](zone-model.html) | #### EXAMPLE RESPONSE diff --git a/modules/docs/src/main/mdoc/api/list-group-activity.md b/modules/docs/src/main/mdoc/api/list-group-activity.md index 671e58728..408663067 100644 --- a/modules/docs/src/main/mdoc/api/list-group-activity.md +++ b/modules/docs/src/main/mdoc/api/list-group-activity.md @@ -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](membership-model.html) | -oldGroup | map | The old group before the change, refer to [Membership Model](membership-model.html) | +newGroup | map | The new group as a result of the change. Refer to [Membership Model](membership-model.html) | +oldGroup | map | The old group before the change. Refer to [Membership Model](membership-model.html) | created | string | Millisecond timestamp that change was created userId | string | User Id of user who made the change | id | string | Id of the group change | diff --git a/modules/docs/src/main/mdoc/api/list-group-admins.md b/modules/docs/src/main/mdoc/api/list-group-admins.md index 9f75253bc..1a75eca5d 100644 --- a/modules/docs/src/main/mdoc/api/list-group-admins.md +++ b/modules/docs/src/main/mdoc/api/list-group-admins.md @@ -24,7 +24,7 @@ Code | description | name | type | description | ------------ | ------------- | :---------- | -admins | Array of Users | refer to [membership model](membership-model.html) | +admins | Array of Users | Refer to [membership model](membership-model.html) | #### EXAMPLE RESPONSE diff --git a/modules/docs/src/main/mdoc/api/list-zone-changes-failures.md b/modules/docs/src/main/mdoc/api/list-zone-changes-failures.md index 56428c2ac..00a4763b1 100644 --- a/modules/docs/src/main/mdoc/api/list-zone-changes-failures.md +++ b/modules/docs/src/main/mdoc/api/list-zone-changes-failures.md @@ -32,7 +32,7 @@ Code | description | name | type | description | ------------------ | ---------------------------- | :---------- | -failedZoneChanges | array of zone changes | array of failed zone changes sorted by created time in descending order. Refer to [Zone Change](#zone-change) | +failedZoneChanges | array of zone changes | Array of failed zone changes sorted by created time in descending order. Refer to [Zone Change](#zone-change) | startFrom | int | (optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent | nextId | int | (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 | @@ -41,7 +41,7 @@ maxItems | int | The maxItems parameter that name | type | description | ----------------- | ------------- | :---------- | -zone | map | refer to [zone model](zone-model.html) | +zone | map | Refer to [zone model](zone-model.html) | status | string | The status of the change. Either Pending, Failed or Synced | changeType | string | The type of change. Either Create, Update, Delete, Sync or AutomatedSync | systemMessage | string | (optional) A message regarding the change. Will not be present if the string is empty | diff --git a/modules/docs/src/main/mdoc/api/list-zone-changes.md b/modules/docs/src/main/mdoc/api/list-zone-changes.md index 16acb0e65..39c5e6a82 100644 --- a/modules/docs/src/main/mdoc/api/list-zone-changes.md +++ b/modules/docs/src/main/mdoc/api/list-zone-changes.md @@ -33,7 +33,7 @@ Code | description | name | type | description | ------------ | --------------------- | :---------- | zoneId | string | Id of zone used for request | -zoneChanges | array of zone changes | array of zone changes sorted by created time in descending order. Refer to [Zone Change](#zone-change) | +zoneChanges | array of zone changes | Array of zone changes sorted by created time in descending order. Refer to [Zone Change](#zone-change) | startFrom | string | (optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent | nextId | string | (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 | @@ -42,7 +42,7 @@ maxItems | int | The maxItems parameter that was sent in name | type | description | ----------------- | ------------- | :---------- | -zone | map | refer to [zone model](zone-model.html) | +zone | map | Refer to [zone model](zone-model.html) | status | string | The status of the change. Either Pending, Failed or Synced | changeType | string | The type of change. Either Create, Update, Delete, Sync or AutomatedSync | systemMessage | string | (optional) A message regarding the change. Will not be present if the string is empty | diff --git a/modules/docs/src/main/mdoc/api/update-zone.md b/modules/docs/src/main/mdoc/api/update-zone.md index ed3b92e51..77f500d67 100644 --- a/modules/docs/src/main/mdoc/api/update-zone.md +++ b/modules/docs/src/main/mdoc/api/update-zone.md @@ -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](zone-model.html) | +**Zone fields** - Refer to [zone model](zone-model.html). #### EXAMPLE HTTP REQUEST @@ -54,7 +54,7 @@ Code | description | name | type | description | ------------ | ------------- | :---------- | -zone | map | Zone sent with update request, refer to [zone model](zone-model.html) | +zone | map | Zone sent with update request. Refer to [zone model](zone-model.html) | 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 timestamp (UTC) the change was initiated |