diff --git a/modules/docs/src/main/resources/microsite/data/menu.yml b/modules/docs/src/main/resources/microsite/data/menu.yml index bbf67407a..42afb9856 100644 --- a/modules/docs/src/main/resources/microsite/data/menu.yml +++ b/modules/docs/src/main/resources/microsite/data/menu.yml @@ -14,6 +14,30 @@ options: menu_type: portal_menu menu_section: portal_section + - title: DNS Changes + url: portal/dns-changes + menu_type: portal_menu + menu_section: portal_section + nested_options: + - title: Manual Review & Scheduling + url: portal/manual-review-scheduling + menu_section: portal_section + + - title: RecordSet Search + url: portal/recordset-search + menu_type: portal_menu + menu_section: portal_section + + - title: Groups + url: portal/groups + menu_type: portal_menu + menu_section: portal_section + nested_options: + - title: Create a Group + url: portal/create-a-group + - title: Manage Membership + url: portal/manage-membership + - title: Zones url: portal/zones menu_type: portal_menu @@ -32,25 +56,6 @@ options: - title: Search Zones url: portal/search-zones - - title: Groups - url: portal/groups - menu_type: portal_menu - menu_section: portal_section - nested_options: - - title: Create a Group - url: portal/create-a-group - - title: Manage Membership - url: portal/manage-membership - - - title: DNS Changes - url: portal/dns-changes - menu_type: portal_menu - menu_section: portal_section - nested_options: - - title: Manual Review & Scheduling - url: portal/manual-review-scheduling - menu_section: portal_section - - title: Credentials url: portal/credentials menu_type: portal_menu @@ -153,8 +158,8 @@ options: - title: Get RecordSet url: api/get-recordset.html menu_section: recordsetapireference - - title: List / Search RecordSets - url: api/list-recordsets.html + - title: List / Search RecordSets by Zone + url: api/list-recordsets-by-zone.html menu_section: recordsetapireference - title: Get RecordSet Change url: api/get-recordset-change.html @@ -162,6 +167,9 @@ options: - title: List RecordSet Changes url: api/list-recordset-changes.html menu_section: recordsetapireference + - title: Global List / Search RecordSets + url: api/list-recordsets-global.html + menu_sectioon: recordsetapireference - title: Batch Change url: api/batchchange-model.html diff --git a/modules/docs/src/main/tut/api/list-recordsets.md b/modules/docs/src/main/tut/api/list-recordsets-by-zone.md similarity index 99% rename from modules/docs/src/main/tut/api/list-recordsets.md rename to modules/docs/src/main/tut/api/list-recordsets-by-zone.md index 24a951626..287f1c28e 100755 --- a/modules/docs/src/main/tut/api/list-recordsets.md +++ b/modules/docs/src/main/tut/api/list-recordsets-by-zone.md @@ -4,7 +4,7 @@ title: "List / Search RecordSets" section: "api" --- -# List / Search RecordSets +# List / Search RecordSets by Zone Retrieves a list of RecordSets from the zone diff --git a/modules/docs/src/main/tut/api/list-recordsets-global.md b/modules/docs/src/main/tut/api/list-recordsets-global.md new file mode 100644 index 000000000..6a0cb01f8 --- /dev/null +++ b/modules/docs/src/main/tut/api/list-recordsets-global.md @@ -0,0 +1,77 @@ +--- +layout: docs +title: "Global List / Search RecordSets" +section: "api" +--- + +# Global List / Search RecordSets + +Retrieves a list of RecordSets globally in the VinylDNS database based on search criteria. A minimum of two alpha-numeric characters is required. + +#### HTTP REQUEST + +> GET /recordsets?startFrom={response.nextId}&maxItems={1 - 100}&recordNameFilter={recordNameFilter}&recordTypeFilter={recordTypeFilter}&recordOwnerGroupFilter={recordOwnerGroupFilter}&nameSort={nameSort} + +#### HTTP REQUEST PARAMS + +name | type | required? | description | + ------------ | ------------- | ----------- | :---------- | +recordNameFilter | string | yes | Characters that are part of the record name to search for. The wildcard character `*` is supported, for example `www*`. Omit the wildcard when searching for an exact record name. At least two alphanumeric characters are **required** for searching. | +recordTypeFilter | Array of RecordType | no | An array of record types to filter for listing record sets. Refer to [recordset mode](../api/recordset-model) for supported types. Invalid record types will be ignored. If left empty or no valid record types are provided, then all record types will be returned. | +recordOwnerGroupFilter | string | no | Owner group ID for record set. | +nameSort | string | no | Name sort order for record sets returned by list record set response. Valid values are `ASC` (ascending; default) and `DESC` (descending). | +startFrom | *any* | no | In order to advance through pages of results, the startFrom is set to the `nextId` that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results | +maxItems | integer | no | The number of items to return in the page. Valid values are 1 to 100. Defaults to 100 if not provided. | + +#### HTTP RESPONSE TYPES + +Code | description | + ------------ | :---------- | +200 | **OK** - The record sets are returned in the response body | +422 | **Unprocessable Entity** - `recordNameFilter` was either omitted or provided but does not contain at least two alphanumeric characters | + +#### HTTP RESPONSE ATTRIBUTES + +name | type | description | + ------------ | ------------- | :---------- | +recordSets | Array of RecordSets | refer to [recordset model](../api/recordset-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 record sets are exhausted | +maxItems | integer | `maxItems` sent in request, default is 100 | +recordNameFilter | string | name filter sent in request | +recordTypeFilter | Array of RecordType | record type filter sent in request | +recordOwnerGroupFilter | string | record owner group sent in request | +nameSort | string | name sort order sent in request + +#### EXAMPLE RESPONSE + +``` +{ + "recordSets": [ + { + "type": "A", + "zoneId": "5f5304ba-c81f-456c-9d33-bb6179c8b1f1", + "name": "foo", + "ttl": 7200, + "status": "Active", + "created": "2019-04-26T17:15:35Z", + "records": [ + { + "address": "1.1.1.1" + } + ], + "id": "f802596f-4f0e-4e65-bb43-c7ca439d2608", + "account": "system", + "fqdn": "foo.example.com.", + "zoneName": "example.com.", + "zoneShared": true + } + ] + "maxItems": 100, + "recordNameFilter": "foo*", + "recordTypeFilter": [ + "A" + ], + "nameSort": "ASC" +} +``` diff --git a/modules/docs/src/main/tut/img/portal/change-history-annotated.png b/modules/docs/src/main/tut/img/portal/change-history-annotated.png index 8cfe3882e..2bb9e9a62 100644 Binary files a/modules/docs/src/main/tut/img/portal/change-history-annotated.png and b/modules/docs/src/main/tut/img/portal/change-history-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/connect-to-zone.png b/modules/docs/src/main/tut/img/portal/connect-to-zone.png index 6f05e05cd..d700995ae 100644 Binary files a/modules/docs/src/main/tut/img/portal/connect-to-zone.png and b/modules/docs/src/main/tut/img/portal/connect-to-zone.png differ diff --git a/modules/docs/src/main/tut/img/portal/create-group.png b/modules/docs/src/main/tut/img/portal/create-group.png index f574cdab5..10e62b6e3 100644 Binary files a/modules/docs/src/main/tut/img/portal/create-group.png and b/modules/docs/src/main/tut/img/portal/create-group.png differ diff --git a/modules/docs/src/main/tut/img/portal/credentials_annotated.png b/modules/docs/src/main/tut/img/portal/credentials_annotated.png index 95fd3dbf3..19f459499 100644 Binary files a/modules/docs/src/main/tut/img/portal/credentials_annotated.png and b/modules/docs/src/main/tut/img/portal/credentials_annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/group-membership.png b/modules/docs/src/main/tut/img/portal/group-membership.png index 0d092c521..b8aefd7d7 100644 Binary files a/modules/docs/src/main/tut/img/portal/group-membership.png and b/modules/docs/src/main/tut/img/portal/group-membership.png differ diff --git a/modules/docs/src/main/tut/img/portal/groups-listed-all.png b/modules/docs/src/main/tut/img/portal/groups-listed-all.png index cdb29bd0d..a92e09929 100644 Binary files a/modules/docs/src/main/tut/img/portal/groups-listed-all.png and b/modules/docs/src/main/tut/img/portal/groups-listed-all.png differ diff --git a/modules/docs/src/main/tut/img/portal/groups-listed.png b/modules/docs/src/main/tut/img/portal/groups-listed.png index fd47716b3..de1aa7ec1 100644 Binary files a/modules/docs/src/main/tut/img/portal/groups-listed.png and b/modules/docs/src/main/tut/img/portal/groups-listed.png differ diff --git a/modules/docs/src/main/tut/img/portal/groups-main-all.png b/modules/docs/src/main/tut/img/portal/groups-main-all.png index 2173b9c9e..d19e1d609 100644 Binary files a/modules/docs/src/main/tut/img/portal/groups-main-all.png and b/modules/docs/src/main/tut/img/portal/groups-main-all.png differ diff --git a/modules/docs/src/main/tut/img/portal/groups-main.png b/modules/docs/src/main/tut/img/portal/groups-main.png index a068cd737..d4bed070e 100644 Binary files a/modules/docs/src/main/tut/img/portal/groups-main.png and b/modules/docs/src/main/tut/img/portal/groups-main.png differ diff --git a/modules/docs/src/main/tut/img/portal/logout-annotated.png b/modules/docs/src/main/tut/img/portal/logout-annotated.png index ecc2a612d..850ac6d40 100644 Binary files a/modules/docs/src/main/tut/img/portal/logout-annotated.png and b/modules/docs/src/main/tut/img/portal/logout-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/main-annotated.png b/modules/docs/src/main/tut/img/portal/main-annotated.png index 8815bb3ef..f00ab63ef 100644 Binary files a/modules/docs/src/main/tut/img/portal/main-annotated.png and b/modules/docs/src/main/tut/img/portal/main-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/main.png b/modules/docs/src/main/tut/img/portal/main.png index cfc0d5bc0..ff986f3a5 100644 Binary files a/modules/docs/src/main/tut/img/portal/main.png and b/modules/docs/src/main/tut/img/portal/main.png differ diff --git a/modules/docs/src/main/tut/img/portal/manage-records-annotated.png b/modules/docs/src/main/tut/img/portal/manage-records-annotated.png index bb7085a02..03643f9ef 100644 Binary files a/modules/docs/src/main/tut/img/portal/manage-records-annotated.png and b/modules/docs/src/main/tut/img/portal/manage-records-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/manage-records-sort.png b/modules/docs/src/main/tut/img/portal/manage-records-sort.png index 7b93c3df3..0d8b657b3 100644 Binary files a/modules/docs/src/main/tut/img/portal/manage-records-sort.png and b/modules/docs/src/main/tut/img/portal/manage-records-sort.png differ diff --git a/modules/docs/src/main/tut/img/portal/manage-zone.png b/modules/docs/src/main/tut/img/portal/manage-zone.png index 47ef35f70..6614623b2 100644 Binary files a/modules/docs/src/main/tut/img/portal/manage-zone.png and b/modules/docs/src/main/tut/img/portal/manage-zone.png differ diff --git a/modules/docs/src/main/tut/img/portal/recordset-search-filters.png b/modules/docs/src/main/tut/img/portal/recordset-search-filters.png new file mode 100644 index 000000000..0244e1e02 Binary files /dev/null and b/modules/docs/src/main/tut/img/portal/recordset-search-filters.png differ diff --git a/modules/docs/src/main/tut/img/portal/recordset-search-info.png b/modules/docs/src/main/tut/img/portal/recordset-search-info.png new file mode 100644 index 000000000..b6c679deb Binary files /dev/null and b/modules/docs/src/main/tut/img/portal/recordset-search-info.png differ diff --git a/modules/docs/src/main/tut/img/portal/recordset-search-main.png b/modules/docs/src/main/tut/img/portal/recordset-search-main.png new file mode 100644 index 000000000..56fc20bb3 Binary files /dev/null and b/modules/docs/src/main/tut/img/portal/recordset-search-main.png differ diff --git a/modules/docs/src/main/tut/img/portal/recordset-search-name-filter.png b/modules/docs/src/main/tut/img/portal/recordset-search-name-filter.png new file mode 100644 index 000000000..b068f0216 Binary files /dev/null and b/modules/docs/src/main/tut/img/portal/recordset-search-name-filter.png differ diff --git a/modules/docs/src/main/tut/img/portal/search-zones-all-zones.png b/modules/docs/src/main/tut/img/portal/search-zones-all-zones.png index 2e6806c31..f42b7ac71 100644 Binary files a/modules/docs/src/main/tut/img/portal/search-zones-all-zones.png and b/modules/docs/src/main/tut/img/portal/search-zones-all-zones.png differ diff --git a/modules/docs/src/main/tut/img/portal/search-zones-my-zones.png b/modules/docs/src/main/tut/img/portal/search-zones-my-zones.png index cdf3a9ef4..f9c006f97 100644 Binary files a/modules/docs/src/main/tut/img/portal/search-zones-my-zones.png and b/modules/docs/src/main/tut/img/portal/search-zones-my-zones.png differ diff --git a/modules/docs/src/main/tut/img/portal/sync-zones-annotated.png b/modules/docs/src/main/tut/img/portal/sync-zones-annotated.png index 8605e493b..efa10a4af 100644 Binary files a/modules/docs/src/main/tut/img/portal/sync-zones-annotated.png and b/modules/docs/src/main/tut/img/portal/sync-zones-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/zone-list.png b/modules/docs/src/main/tut/img/portal/zone-list.png index 3eb79dd34..8c1d33ed6 100644 Binary files a/modules/docs/src/main/tut/img/portal/zone-list.png and b/modules/docs/src/main/tut/img/portal/zone-list.png differ diff --git a/modules/docs/src/main/tut/img/portal/zone-main.png b/modules/docs/src/main/tut/img/portal/zone-main.png index b4a3a3fd4..ab55a9201 100644 Binary files a/modules/docs/src/main/tut/img/portal/zone-main.png and b/modules/docs/src/main/tut/img/portal/zone-main.png differ diff --git a/modules/docs/src/main/tut/img/portal/zone-records-annotated.png b/modules/docs/src/main/tut/img/portal/zone-records-annotated.png index b120494b9..339d04776 100644 Binary files a/modules/docs/src/main/tut/img/portal/zone-records-annotated.png and b/modules/docs/src/main/tut/img/portal/zone-records-annotated.png differ diff --git a/modules/docs/src/main/tut/img/portal/zones-all-zones.png b/modules/docs/src/main/tut/img/portal/zones-all-zones.png index 1692a03a1..08ae43192 100644 Binary files a/modules/docs/src/main/tut/img/portal/zones-all-zones.png and b/modules/docs/src/main/tut/img/portal/zones-all-zones.png differ diff --git a/modules/docs/src/main/tut/img/portal/zones-my-zones.png b/modules/docs/src/main/tut/img/portal/zones-my-zones.png index 3eb79dd34..8c1d33ed6 100644 Binary files a/modules/docs/src/main/tut/img/portal/zones-my-zones.png and b/modules/docs/src/main/tut/img/portal/zones-my-zones.png differ diff --git a/modules/docs/src/main/tut/portal/recordset-search.md b/modules/docs/src/main/tut/portal/recordset-search.md new file mode 100644 index 000000000..7c73991b2 --- /dev/null +++ b/modules/docs/src/main/tut/portal/recordset-search.md @@ -0,0 +1,21 @@ +--- +layout: docs +title: "RecordSet Search" +section: "portal_menu" +--- + +## RecordSet Search +RecordSet Search provides a view to lookup the state of DNS records within VinylDNS without requiring +access to the specific zone. To use the search, a search term containing at least two alphanumeric characters must +be entered. + +[![RecordSet Search main page screenshot](../img/portal/recordset-search-main.png){: .screenshot}](../img/portal/recordset-search-main.png) +[![RecordSet Search name filter screenshot](../img/portal/recordset-search-name-filter.png){: .screenshot}](../img/portal/recordset-search-name-filter.png) + +Record type and/or record owner group to further filter the search results. + +[![RecordSet Search filters screenshot](../img/portal/recordset-search-filters.png){: .screenshot}](../img/portal/recordset-search-filters.png) + +There is also a collapsible help section that provides further information regarding search querying tips. + +[![RecordSet Search info screenshot](../img/portal/recordset-search-info.png){: .screenshot}](../img/portal/recordset-search-info.png)