Automated commit by github action: 3943187736

static/api-specs/idn/v3/paths/search-aggregate.yaml

@@ -2,7 +2,10 @@ post:
   tags:
   - Search
   description: >-
-    Performs a search query aggregation and returns aggregation result.
+    Performs a search query aggregation and returns the aggregation result.
+    By default, you can page a maximum of 10,000 search result records. 
+    To page past 10,000 records, you can use searchAfter paging. 
+    Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. 
   operationId: searchAggregate
   summary: "Perform a Search Query Aggregation"
   parameters:
@@ -54,5 +57,11 @@ post:
           example: 5
     '400':
       $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
     '403':
       $ref: '../responses/403.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'

static/api-specs/idn/v3/paths/search-count.yaml

@@ -2,9 +2,9 @@ post:
   tags:
   - Search
   description: >-
-    Performs a search with provided query and returns count of results in the X-Total-Count header.
+    Performs a search with a provided query and returns the count of results in the X-Total-Count header.
   operationId: searchCount
-  summary: "Count the number of Documents satisfying a Query"
+  summary: "Count Documents Satisfying a Query"
   requestBody:
     content:
       application/json:
@@ -25,5 +25,11 @@ post:
           example: 5
     '400':
       $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
     '403':
       $ref: '../responses/403.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'

static/api-specs/idn/v3/paths/search-get.yaml

@@ -2,7 +2,7 @@ get:
   tags:
   - Search
   description: >-
-    Fetches a single document from the specified index using the specified document ID.
+    Fetches a single document from the specified index, using the specified document ID.
   operationId: searchGet
   summary: "Get a Document by ID"
   parameters:
@@ -26,7 +26,15 @@ get:
               $ref: '../schemas/search/documents/examples/identity.yaml'
             role:
               $ref: '../schemas/search/documents/examples/role.yaml'
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
     '403':
       $ref: '../responses/403.yaml'
     '404':
       $ref: '../responses/404.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'

static/api-specs/idn/v3/paths/search-post.yaml

@@ -3,6 +3,9 @@ post:
   - Search
   description: >-
     Performs a search with the provided query and returns a matching result collection.
+    By default, you can page a maximum of 10,000 search result records. 
+    To page past 10,000 records, you can use searchAfter paging. 
+    Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. 
   externalDocs:
     description: Learn more about search.
     url: https://documentation.sailpoint.com/saas/help/search/index.html