From a2425cc2adedea2c33de28dc1d4d7a942a239d4f Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Thu, 13 Jun 2024 00:44:55 +1200 Subject: [PATCH] Replace instances of `Opensearch` with `OpenSearch` (#335) * Replace instances of `Opensearch` with `OpenSearch` Signed-off-by: Thomas Farr * Add changelog entry Signed-off-by: Thomas Farr --------- Signed-off-by: Thomas Farr --- CHANGELOG.md | 1 + spec/namespaces/_core.yaml | 68 ++++++++++++++--------------- spec/namespaces/cat.yaml | 2 +- spec/namespaces/cluster.yaml | 8 ++-- spec/namespaces/indices.yaml | 10 ++--- spec/namespaces/ingest.yaml | 2 +- spec/namespaces/snapshot.yaml | 2 +- spec/schemas/_common.mapping.yaml | 6 +-- spec/schemas/_common.query_dsl.yaml | 2 +- spec/schemas/_common.yaml | 6 +-- spec/schemas/_core.msearch.yaml | 4 +- spec/schemas/cat.allocation.yaml | 8 ++-- spec/schemas/cat.nodes.yaml | 6 +-- spec/schemas/cat.segments.yaml | 6 +-- spec/schemas/cluster.stats.yaml | 8 ++-- spec/schemas/indices._common.yaml | 6 +-- spec/schemas/ingest._common.yaml | 2 +- spec/schemas/nodes._common.yaml | 32 +++++++------- 18 files changed, 90 insertions(+), 89 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b0db8178..6ce5d25ec 100644 --- 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 index a992acaed..a2c35ef50 100644 --- 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:,` 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 index 2392f08b5..335269825 100644 --- 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 index 62381a0b5..b380eb8c5 100644 --- 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 index 2e60f6c25..053cf10ae 100644 --- 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 index e905bc43c..3318160f1 100644 --- 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 index 8b4598fc0..f51431169 100644 --- 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 diff --git a/spec/schemas/_common.mapping.yaml b/spec/schemas/_common.mapping.yaml index 1fb513d24..8c6845266 100644 --- a/spec/schemas/_common.mapping.yaml +++ b/spec/schemas/_common.mapping.yaml @@ -414,7 +414,7 @@ components: split_queries_on_whitespace: type: boolean time_series_dimension: - description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean type: type: string @@ -840,7 +840,7 @@ components: script: $ref: '_common.yaml#/components/schemas/Script' time_series_dimension: - description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean type: type: string @@ -997,7 +997,7 @@ components: time_series_metric: $ref: '#/components/schemas/TimeSeriesMetricType' time_series_dimension: - description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean DoubleNumberProperty: allOf: diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml index 3e8ba0787..f74bff185 100644 --- a/spec/schemas/_common.query_dsl.yaml +++ b/spec/schemas/_common.query_dsl.yaml @@ -362,7 +362,7 @@ components: description: |- One or more query clauses. Returned documents must match one or more of these queries. - If a document matches multiple queries, Opensearch uses the highest relevance score. + If a document matches multiple queries, OpenSearch uses the highest relevance score. type: array items: $ref: '#/components/schemas/QueryContainer' diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 47de285c2..392b7fc68 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -313,7 +313,7 @@ components: DateTime: description: |- A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a - number of milliseconds since the Epoch. Opensearch accepts both as input, but will generally output a string + number of milliseconds since the Epoch. OpenSearch accepts both as input, but will generally output a string representation. oneOf: - type: string @@ -916,7 +916,7 @@ components: description: |- Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. - Opensearch reclaims the disk space of deleted Lucene documents when a segment is merged. + OpenSearch reclaims the disk space of deleted Lucene documents when a segment is merged. type: number required: - count @@ -1787,7 +1787,7 @@ components: type: number required: - failed_attempts - OpensearchVersionInfo: + OpenSearchVersionInfo: type: object properties: build_date: diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml index 289069488..4e820a3ce 100644 --- a/spec/schemas/_core.msearch.yaml +++ b/spec/schemas/_core.msearch.yaml @@ -50,7 +50,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 @@ -127,7 +127,7 @@ 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 + limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Defaults to 0, which does not terminate query execution early. type: number stats: diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml index 185e880d8..8c8913a44 100644 --- a/spec/schemas/cat.allocation.yaml +++ b/spec/schemas/cat.allocation.yaml @@ -23,8 +23,8 @@ components: disk.used: description: |- Total disk space in use. - Opensearch retrieves this metric from the node’s operating system (OS). - The metric includes disk space for: Opensearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. + OpenSearch retrieves this metric from the node’s operating system (OS). + The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. oneOf: - $ref: '_common.yaml#/components/schemas/ByteSize' @@ -32,8 +32,8 @@ components: type: string disk.avail: description: |- - Free disk space available to Opensearch. - Opensearch retrieves this metric from the node’s operating system. + Free disk space available to OpenSearch. + OpenSearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. oneOf: - $ref: '_common.yaml#/components/schemas/ByteSize' diff --git a/spec/schemas/cat.nodes.yaml b/spec/schemas/cat.nodes.yaml index f1d030400..fcad14054 100644 --- a/spec/schemas/cat.nodes.yaml +++ b/spec/schemas/cat.nodes.yaml @@ -26,13 +26,13 @@ components: version: $ref: '_common.yaml#/components/schemas/VersionString' flavor: - description: The Opensearch distribution flavor. + description: The OpenSearch distribution flavor. type: string type: - description: The Opensearch distribution type. + description: The OpenSearch distribution type. type: string build: - description: The Opensearch build hash. + description: The OpenSearch build hash. type: string jdk: description: The Java version. diff --git a/spec/schemas/cat.segments.yaml b/spec/schemas/cat.segments.yaml index 6c308c405..16ef0357a 100644 --- a/spec/schemas/cat.segments.yaml +++ b/spec/schemas/cat.segments.yaml @@ -28,7 +28,7 @@ components: generation: description: |- The segment generation number. - Opensearch increments this generation number for each segment written then uses this number to derive the segment name. + OpenSearch increments this generation number for each segment written then uses this number to derive the segment name. type: string docs.count: description: |- @@ -41,7 +41,7 @@ components: The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. - Also, Opensearch creates extra deleted documents to internally track the recent history of operations on a shard. + Also, OpenSearch creates extra deleted documents to internally track the recent history of operations on a shard. type: string size: $ref: '_common.yaml#/components/schemas/ByteSize' @@ -51,7 +51,7 @@ components: description: |- If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. - If `false`, the data from uncommitted segments is also stored in the transaction log so that Opensearch is able to replay changes on the next start. + If `false`, the data from uncommitted segments is also stored in the transaction log so that OpenSearch is able to replay changes on the next start. type: string searchable: description: |- diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml index 9de2156f3..283ad1539 100644 --- a/spec/schemas/cluster.stats.yaml +++ b/spec/schemas/cluster.stats.yaml @@ -319,7 +319,7 @@ components: os: $ref: '#/components/schemas/ClusterOperatingSystem' packaging_types: - description: Contains statistics about Opensearch distributions installed on selected nodes. + description: Contains statistics about OpenSearch distributions installed on selected nodes. type: array items: $ref: '#/components/schemas/NodePackagingType' @@ -333,7 +333,7 @@ components: process: $ref: '#/components/schemas/ClusterProcess' versions: - description: Array of Opensearch versions used on selected nodes. + description: Array of OpenSearch versions used on selected nodes. type: array items: $ref: '_common.yaml#/components/schemas/VersionString' @@ -402,7 +402,7 @@ components: description: |- Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. - This is the actual amount of free disk space the selected Opensearch nodes can use. + This is the actual amount of free disk space the selected OpenSearch nodes can use. type: number free_in_bytes: description: Total number of unallocated bytes in file stores across all selected nodes. @@ -670,7 +670,7 @@ components: description: Number of selected nodes using the distribution flavor and file type. type: number flavor: - description: Type of Opensearch distribution. This is always `default`. + description: Type of OpenSearch distribution. This is always `default`. type: string type: description: File type (such as `tar` or `zip`) used for the distribution package. diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index 3c6981851..20fc23cde 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -632,7 +632,7 @@ components: limit: description: |- [preview] This functionality is in technical preview and may be changed or removed in a future release. - Opensearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. type: number IndexingSlowlogSettings: type: object @@ -878,7 +878,7 @@ components: status: $ref: '_common.yaml#/components/schemas/HealthStatus' system: - description: If `true`, the data stream is created and managed by an Opensearch stack component and cannot be modified through normal user interaction. + description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction. type: boolean template: $ref: '_common.yaml#/components/schemas/Name' @@ -947,7 +947,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 _meta: $ref: '_common.yaml#/components/schemas/Metadata' diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml index b118be853..7a1b4c259 100644 --- a/spec/schemas/ingest._common.yaml +++ b/spec/schemas/ingest._common.yaml @@ -421,7 +421,7 @@ components: items: $ref: '#/components/schemas/UserAgentProperty' regex_file: - description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Opensearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting OpenSearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index 3837c67ea..06a0fe01d 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -357,13 +357,13 @@ components: description: |- Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. - This is the actual amount of free disk space the Opensearch node can utilise. + This is the actual amount of free disk space the OpenSearch node can utilise. type: string available_in_bytes: description: |- Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. - This is the actual amount of free disk space the Opensearch node can utilise. + This is the actual amount of free disk space the OpenSearch node can utilise. type: number free: description: Total unallocated disk space in all file stores. @@ -382,7 +382,7 @@ components: properties: devices: description: |- - Array of disk metrics for each device that is backing an Opensearch data path. + Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed. type: array items: @@ -396,19 +396,19 @@ components: description: The Linux device name. type: string operations: - description: The total number of read and write operations for the device completed since starting Opensearch. + description: The total number of read and write operations for the device completed since starting OpenSearch. type: number read_kilobytes: - description: The total number of kilobytes read for the device since starting Opensearch. + description: The total number of kilobytes read for the device since starting OpenSearch. type: number read_operations: - description: The total number of read operations for the device completed since starting Opensearch. + description: The total number of read operations for the device completed since starting OpenSearch. type: number write_kilobytes: - description: The total number of kilobytes written for the device since starting Opensearch. + description: The total number of kilobytes written for the device since starting OpenSearch. type: number write_operations: - description: The total number of write operations for the device completed since starting Opensearch. + description: The total number of write operations for the device completed since starting OpenSearch. type: number Jvm: type: object @@ -624,7 +624,7 @@ components: type: object properties: control_group: - description: The `cpuacct` control group to which the Opensearch process belongs. + description: The `cpuacct` control group to which the OpenSearch process belongs. type: string usage_nanos: $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' @@ -632,13 +632,13 @@ components: type: object properties: control_group: - description: The `cpu` control group to which the Opensearch process belongs. + description: The `cpu` control group to which the OpenSearch process belongs. type: string cfs_period_micros: - description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Opensearch process should have their access to CPU resources reallocated. + description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. type: number cfs_quota_micros: - description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the Opensearch process can run during one period `cfs_period_micros`. + description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. type: number stat: $ref: '#/components/schemas/CgroupCpuStat' @@ -649,7 +649,7 @@ components: description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. type: number number_of_times_throttled: - description: The number of times all tasks in the same cgroup as the Opensearch process have been throttled. + description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. type: number time_throttled_nanos: $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' @@ -657,17 +657,17 @@ components: type: object properties: control_group: - description: The `memory` control group to which the Opensearch process belongs. + description: The `memory` control group to which the OpenSearch process belongs. type: string limit_in_bytes: description: |- - The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Opensearch process. + The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. type: string usage_in_bytes: description: |- - The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Opensearch process. + The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. This value is stored as a string for consistency with `limit_in_bytes`. type: string Process: