Replace instances of Opensearch with OpenSearch (#335)

* Replace instances of `Opensearch` with `OpenSearch` Signed-off-by: Thomas Farr <[email protected]> * Add changelog entry Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]>
opensearch-project · Jun 12, 2024 · a2425cc · a2425cc
1 parent ababab0
commit a2425cc
Show file tree

Hide file tree

Showing 18 changed files with 90 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,6 +26,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Replaced Smithy with a native OpenAPI spec ([#189](https://github.com/opensearch-project/opensearch-api-specification/issues/189))
 - Refactored spec tester internals to improve reusability ([#302](https://github.com/opensearch-project/opensearch-api-specification/pull/302))
 - Renamed `main` release tag to `main-latest` ([#321](https://github.com/opensearch-project/opensearch-api-specification/pull/321))
+- Replaced usages of `Opensearch` with `OpenSearch` ([#335](https://github.com/opensearch-project/opensearch-api-specification/pull/335))
 
 ### Deprecated
 

diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
@@ -2379,7 +2379,7 @@ components:
                 description: If true, returns detailed information about score computation as part of a hit.
                 type: boolean
               ext:
-                description: Configuration of search extensions defined by Opensearch plugins.
+                description: Configuration of search extensions defined by OpenSearch plugins.
                 type: object
                 additionalProperties:
                   type: object
@@ -2469,11 +2469,11 @@ components:
               terminate_after:
                 description: |-
                   Maximum number of documents to collect for each shard.
-                  If a query reaches this limit, Opensearch terminates the query early.
-                  Opensearch collects documents before sorting.
+                  If a query reaches this limit, OpenSearch terminates the query early.
+                  OpenSearch collects documents before sorting.
                   Use with caution.
-                  Opensearch applies this parameter to each shard handling the request.
-                  When possible, let Opensearch perform early termination automatically.
+                  OpenSearch applies this parameter to each shard handling the request.
+                  When possible, let OpenSearch perform early termination automatically.
                   Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
                   If set to `0` (default), the query does not terminate early.
                 type: number
@@ -2903,7 +2903,7 @@ components:
               tagline:
                 type: string
               version:
-                $ref: '../schemas/_common.yaml#/components/schemas/OpensearchVersionInfo'
+                $ref: '../schemas/_common.yaml#/components/schemas/OpenSearchVersionInfo'
             required:
               - cluster_name
               - cluster_uuid
@@ -3275,7 +3275,7 @@ components:
       in: query
       name: refresh
       description: |-
-        If `true`, Opensearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
+        If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
         Valid values: `true`, `false`, `wait_for`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Refresh'
@@ -3453,8 +3453,8 @@ components:
       name: terminate_after
       description: |-
         Maximum number of documents to collect for each shard.
-        If a query reaches this limit, Opensearch terminates the query early.
-        Opensearch collects documents before sorting.
+        If a query reaches this limit, OpenSearch terminates the query early.
+        OpenSearch collects documents before sorting.
       schema:
         type: number
       style: form
@@ -3491,7 +3491,7 @@ components:
       in: query
       name: refresh
       description: |-
-        If `true`, Opensearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
+        If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
         Valid values: `true`, `false`, `wait_for`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Refresh'
@@ -3618,7 +3618,7 @@ components:
       in: query
       name: refresh
       description: |-
-        If `true`, Opensearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
+        If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
         Valid values: `true`, `false`, `wait_for`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Refresh'
@@ -3814,7 +3814,7 @@ components:
     delete_by_query::query.refresh:
       in: query
       name: refresh
-      description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes.
+      description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes.
       schema:
         type: boolean
       style: form
@@ -3914,11 +3914,11 @@ components:
       name: terminate_after
       description: |-
         Maximum number of documents to collect for each shard.
-        If a query reaches this limit, Opensearch terminates the query early.
-        Opensearch collects documents before sorting.
+        If a query reaches this limit, OpenSearch terminates the query early.
+        OpenSearch collects documents before sorting.
         Use with caution.
-        Opensearch applies this parameter to each shard handling the request.
-        When possible, let Opensearch perform early termination automatically.
+        OpenSearch applies this parameter to each shard handling the request.
+        When possible, let OpenSearch perform early termination automatically.
         Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
       schema:
         type: number
@@ -4066,7 +4066,7 @@ components:
     exists::query.refresh:
       in: query
       name: refresh
-      description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes.
+      description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes.
       schema:
         type: boolean
       style: form
@@ -4162,7 +4162,7 @@ components:
     exists_source::query.refresh:
       in: query
       name: refresh
-      description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes.
+      description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes.
       schema:
         type: boolean
       style: form
@@ -4400,7 +4400,7 @@ components:
     get::query.refresh:
       in: query
       name: refresh
-      description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
+      description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
       schema:
         type: boolean
       style: form
@@ -4515,7 +4515,7 @@ components:
     get_source::query.refresh:
       in: query
       name: refresh
-      description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
+      description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
       schema:
         type: boolean
       style: form
@@ -4597,7 +4597,7 @@ components:
       in: query
       name: refresh
       description: |-
-        If `true`, Opensearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
+        If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.
         Valid values: `true`, `false`, `wait_for`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Refresh'
@@ -5361,7 +5361,7 @@ components:
       name: preference
       description: |-
         Nodes and shards used for the search.
-        By default, Opensearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
+        By default, OpenSearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
         `_only_local` to run the search only on shards on the local node;
         `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
         `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
@@ -5377,7 +5377,7 @@ components:
       name: q
       description: |-
         Query in the Lucene query string syntax using query parameter search.
-        Query parameter searches do not support the full Opensearch Query DSL but are handy for testing.
+        Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing.
       schema:
         type: string
       style: form
@@ -5517,11 +5517,11 @@ components:
       name: terminate_after
       description: |-
         Maximum number of documents to collect for each shard.
-        If a query reaches this limit, Opensearch terminates the query early.
-        Opensearch collects documents before sorting.
+        If a query reaches this limit, OpenSearch terminates the query early.
+        OpenSearch collects documents before sorting.
         Use with caution.
-        Opensearch applies this parameter to each shard handling the request.
-        When possible, let Opensearch perform early termination automatically.
+        OpenSearch applies this parameter to each shard handling the request.
+        When possible, let OpenSearch perform early termination automatically.
         Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
         If set to `0` (default), the query does not terminate early.
       schema:
@@ -5912,7 +5912,7 @@ components:
       in: query
       name: refresh
       description: |-
-        If 'true', Opensearch refreshes the affected shards to make this operation
+        If 'true', OpenSearch refreshes the affected shards to make this operation
         visible to search, if 'wait_for' then wait for a refresh to make this operation
         visible to search, if 'false' do nothing with refreshes.
       schema:
@@ -5946,7 +5946,7 @@ components:
       name: timeout
       description: |-
         Period to wait for dynamic mapping updates and active shards.
-        This guarantees Opensearch waits for at least the timeout before failing.
+        This guarantees OpenSearch waits for at least the timeout before failing.
         The actual wait time could be longer, particularly when multiple waits occur.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Duration'
@@ -6124,7 +6124,7 @@ components:
     update_by_query::query.refresh:
       in: query
       name: refresh
-      description: If `true`, Opensearch refreshes affected shards to make the operation visible to search.
+      description: If `true`, OpenSearch refreshes affected shards to make the operation visible to search.
       schema:
         type: boolean
       style: form
@@ -6218,11 +6218,11 @@ components:
       name: terminate_after
       description: |-
         Maximum number of documents to collect for each shard.
-        If a query reaches this limit, Opensearch terminates the query early.
-        Opensearch collects documents before sorting.
+        If a query reaches this limit, OpenSearch terminates the query early.
+        OpenSearch collects documents before sorting.
         Use with caution.
-        Opensearch applies this parameter to each shard handling the request.
-        When possible, let Opensearch perform early termination automatically.
+        OpenSearch applies this parameter to each shard handling the request.
+        When possible, let OpenSearch perform early termination automatically.
         Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
       schema:
         type: number

diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -2491,7 +2491,7 @@ components:
         A comma-separated list of snapshot repositories used to limit the request.
         Accepts wildcard expressions.
         `_all` returns all repositories.
-        If any repository fails during the request, Opensearch returns an error.
+        If any repository fails during the request, OpenSearch returns an error.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Names'

diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml
@@ -1131,10 +1131,10 @@ components:
       name: name
       description: |-
         Name of the component template to create.
-        Opensearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.
-        Opensearch Agent uses these templates to configure backing indices for its data streams.
-        If you use Opensearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
-        If you don’t use Opensearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.
+        OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.
+        OpenSearch Agent uses these templates to configure backing indices for its data streams.
+        If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
+        If you don’t use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Name'

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -1880,7 +1880,7 @@ components:
                   Priority to determine index template precedence when a new data stream or index is created.
                   The index template with the highest priority is chosen.
                   If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
-                  This number is not automatically generated by Opensearch.
+                  This number is not automatically generated by OpenSearch.
                 type: number
               version:
                 $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber'
@@ -1973,7 +1973,7 @@ components:
                 $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping'
               order:
                 description: |-
-                  Order in which Opensearch applies this template if index
+                  Order in which OpenSearch applies this template if index
                   matches multiple templates.
 
                   Templates with lower 'order' values are merged first. Templates with higher
@@ -2062,7 +2062,7 @@ components:
                   Priority to determine index template precedence when a new data stream or index is created.
                   The index template with the highest priority is chosen.
                   If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
-                  This number is not automatically generated by Opensearch.
+                  This number is not automatically generated by OpenSearch.
                 type: number
               version:
                 $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber'
@@ -3438,7 +3438,7 @@ components:
       name: wait_if_ongoing
       description: |-
         If `true`, the flush operation blocks until execution when another flush operation is running.
-        If `false`, Opensearch returns an error if you request a flush when another flush operation is running.
+        If `false`, OpenSearch returns an error if you request a flush when another flush operation is running.
       schema:
         type: boolean
         default: true
@@ -4374,7 +4374,7 @@ components:
       in: query
       name: order
       description: |-
-        Order in which Opensearch applies this template if index
+        Order in which OpenSearch applies this template if index
         matches multiple templates.
 
         Templates with lower 'order' values are merged first. Templates with higher

diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml
@@ -151,7 +151,7 @@ components:
                 description: Description of the ingest pipeline.
                 type: string
               on_failure:
-                description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Opensearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Opensearch will not attempt to run the pipeline's remaining processors.
+                description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, OpenSearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. OpenSearch will not attempt to run the pipeline's remaining processors.
                 type: array
                 items:
                   $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer'

diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml
@@ -743,7 +743,7 @@ components:
     snapshot.get::query.verbose:
       in: query
       name: verbose
-      description: If true, returns additional information about each snapshot such as the version of Opensearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
+      description: If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
       schema:
         type: boolean
       style: form