Global RecordSet Search documentation (#945)

* Add record set search portal docs and update non-DNS change images.
* Add API documentation for global record set search.

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

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
 

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"
+}
+```

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)