Update every description (testing).

Signed-off-by: dblock <[email protected]>
opensearch-project · Oct 21, 2024 · 7f11933 · 7f11933
1 parent 397c572
commit 7f11933
Show file tree

Hide file tree

Showing 128 changed files with 3,967 additions and 3,967 deletions.
diff --git a/spec/_global_parameters.yaml b/spec/_global_parameters.yaml
@@ -7,34 +7,34 @@ components:
     pretty:
       name: pretty
       in: query
-      description: Whether to pretty format the returned JSON response.
+      description: (UPDATED) Whether to pretty format the returned JSON response.
       schema:
         type: boolean
       default: false
     human:
       name: human
       in: query
-      description: Whether to return human readable values for statistics.
+      description: (UPDATED) Whether to return human readable values for statistics.
       schema:
         type: boolean
       default: true
     error_trace:
       name: error_trace
       in: query
-      description: Whether to include the stack trace of returned errors.
+      description: (UPDATED) Whether to include the stack trace of returned errors.
       schema:
         type: boolean
       default: false
     source:
       name: source
       in: query
-      description: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
+      description: (UPDATED) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
       schema:
         type: string
     filter_path:
       name: filter_path
       in: query
-      description: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
+      description: (UPDATED) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
       schema:
         oneOf:
           - type: string

diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
diff --git a/spec/namespaces/asynchronous_search.yaml b/spec/namespaces/asynchronous_search.yaml
@@ -1,15 +1,15 @@
 openapi: 3.1.0
 info:
   title: OpenSearch Asynchronous Search API
-  description: OpenSearch Asynchronous Search API.
+  description: (UPDATED) OpenSearch Asynchronous Search API.
   version: 1.0.0
 paths:
   /_plugins/_asynchronous_search:
     post:
       operationId: asynchronous_search.search.0
       x-operation-group: asynchronous_search.search
       x-version-added: '1.0'
-      description: Perform an asynchronous search.
+      description: (UPDATED) Perform an asynchronous search.
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api
       parameters:
@@ -27,7 +27,7 @@ paths:
       operationId: asynchronous_search.get.0
       x-operation-group: asynchronous_search.get
       x-version-added: '1.0'
-      description: Get partial responses from asynchronous search.
+      description: (UPDATED) Get partial responses from asynchronous search.
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results
       parameters:
@@ -39,7 +39,7 @@ paths:
       operationId: asynchronous_search.delete.0
       x-operation-group: asynchronous_search.delete
       x-version-added: '1.0'
-      description: Delete asynchronous search.
+      description: (UPDATED) Delete asynchronous search.
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results
       parameters:
@@ -52,7 +52,7 @@ paths:
       operationId: asynchronous_search.stats.0
       x-operation-group: asynchronous_search.stats
       x-version-added: '1.0'
-      description: Monitoring of asynchronous searches that are running, completed, and/or persisted.
+      description: (UPDATED) Monitoring of asynchronous searches that are running, completed, and/or persisted.
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats
       responses:
@@ -64,25 +64,25 @@ components:
     asynchronous_search.search::query.wait_for_completion_timeout:
       name: wait_for_completion_timeout
       in: query
-      description: The amount of time that you plan to wait for the results.
+      description: (UPDATED) The amount of time that you plan to wait for the results.
       schema:
         type: string
     asynchronous_search.search::query.keep_on_completion:
       name: keep_on_completion
       in: query
-      description: Whether you want to save the results in the cluster after the search is complete.
+      description: (UPDATED) Whether you want to save the results in the cluster after the search is complete.
       schema:
         type: boolean
     asynchronous_search.search::query.keep_alive:
       name: keep_alive
       in: query
-      description: The amount of time that the result is saved in the cluster.
+      description: (UPDATED) The amount of time that the result is saved in the cluster.
       schema:
         type: string
     asynchronous_search.search::query.index:
       name: index
       in: query
-      description: The name of the index to be searched.
+      description: (UPDATED) The name of the index to be searched.
       schema:
         type: string
     asynchronous_search.get::path.id: