From 32673b27c2aa33c616233c9648050a90939cae89 Mon Sep 17 00:00:00 2001 From: "Daniel (dB.) Doubrovkine" Date: Wed, 10 Jul 2024 22:42:24 -0500 Subject: [PATCH] Fix quotes in descriptions. (#402) * Fix: quote defaults. Signed-off-by: dblock * Use a regular quote. Signed-off-by: dblock --------- Signed-off-by: dblock --- spec/namespaces/_core.yaml | 10 +++++----- spec/namespaces/cluster.yaml | 4 ++-- spec/namespaces/indices.yaml | 10 +++++----- spec/namespaces/ingest.yaml | 2 +- spec/namespaces/transforms.yaml | 6 +++--- spec/schemas/_common.aggregations.yaml | 4 ++-- spec/schemas/_common.query_dsl.yaml | 16 ++++++++-------- spec/schemas/_core.bulk.yaml | 6 +++--- spec/schemas/_core.field_caps.yaml | 2 +- spec/schemas/_core.rank_eval.yaml | 4 ++-- spec/schemas/_core.scripts_painless_execute.yaml | 2 +- spec/schemas/_core.search.yaml | 2 +- spec/schemas/cat.allocation.yaml | 8 ++++---- spec/schemas/cat.shards.yaml | 4 ++-- spec/schemas/cluster.stats.yaml | 2 +- spec/schemas/indices._common.yaml | 12 ++++++------ spec/schemas/indices.data_streams_stats.yaml | 2 +- spec/schemas/ingest._common.yaml | 4 ++-- spec/schemas/nodes._common.yaml | 4 ++-- 19 files changed, 52 insertions(+), 52 deletions(-) diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index 3e8404ba5..d0e644341 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -3291,7 +3291,7 @@ components: bulk::query.require_alias: in: query name: require_alias - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. schema: type: boolean default: false @@ -3480,8 +3480,8 @@ components: name: index description: |- Name of the data stream or index to target. - If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. - If the target doesn’t exist and doesn’t match a data stream template, this request creates the index. + If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + If the target doesn't exist and doesn't match a data stream template, this request creates the index. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -5069,7 +5069,7 @@ components: name: slices description: |- The number of slices this task should be divided into. - Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + Defaults to 1 slice, meaning the task isn't sliced into subtasks. schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form @@ -5137,7 +5137,7 @@ components: scroll::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + description: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. schema: type: boolean default: false diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index f7b80fb3a..c968cdf51 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -1134,7 +1134,7 @@ components: 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. + 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' @@ -1388,7 +1388,7 @@ components: description: |- Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. - However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index a4b909b4d..da6edf888 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -1767,7 +1767,7 @@ components: analyzer: description: |- The name of the analyzer that should be applied to the provided `text`. - This could be a built-in analyzer, or an analyzer that’s been configured in the index. + This could be a built-in analyzer, or an analyzer that's been configured in the index. type: string attributes: description: Array of token attributes used to filter the output of the `explain` parameter. @@ -1849,9 +1849,9 @@ components: is_write_index: description: |- If `true`, sets the write index or data stream for the alias. - If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. - If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. - Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + If an alias points to multiple indices or data streams and `is_write_index` isn't set, the alias rejects write requests. + If an index alias points to one index and `is_write_index` isn't set, the index automatically acts as the write index. + Data stream aliases don't automatically set a write data stream, even if the alias points to one data stream. type: boolean routing: $ref: '../schemas/_common.yaml#/components/schemas/Routing' @@ -4121,7 +4121,7 @@ components: name: name description: |- Alias to update. - If the alias doesn’t exist, the request creates it. + If the alias doesn't exist, the request creates it. Index alias names support date math. required: true schema: diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml index a98463565..3fb5de00c 100644 --- a/spec/namespaces/ingest.yaml +++ b/spec/namespaces/ingest.yaml @@ -332,7 +332,7 @@ components: name: id description: |- Pipeline to test. - If you don’t specify a `pipeline` in the request body, this parameter is required. + If you don't specify a `pipeline` in the request body, this parameter is required. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' diff --git a/spec/namespaces/transforms.yaml b/spec/namespaces/transforms.yaml index ccd05560c..33dc3aa3c 100644 --- a/spec/namespaces/transforms.yaml +++ b/spec/namespaces/transforms.yaml @@ -225,7 +225,7 @@ components: transforms.search::query.size: name: size in: query - description: Specifies the number of transforms to return. Default is 10. + description: Specifies the number of transforms to return. Default is `10`. required: false schema: type: number @@ -233,7 +233,7 @@ components: transforms.search::query.from: name: from in: query - description: The starting transform to return. Default is 0. + description: The starting transform to return. Default is `0`. required: false schema: type: number @@ -257,7 +257,7 @@ components: transforms.search::query.sortDirection: name: sortDirection in: query - description: Specifies the direction to sort results in. Can be ASC or DESC. Default is ASC. + description: Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. required: false schema: type: string diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml index 539ea74ee..9f8d03072 100644 --- a/spec/schemas/_common.aggregations.yaml +++ b/spec/schemas/_common.aggregations.yaml @@ -1901,7 +1901,7 @@ components: format: description: |- `DecimalFormat` pattern for the output value. - If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + If specified, the formatted value is returned in the aggregation's `value_as_string` property. type: string gap_policy: $ref: '#/components/schemas/GapPolicy' @@ -2028,7 +2028,7 @@ components: properties: doc_count: description: |- - The total number of documents that initially created the expectations. It’s required to be greater + The total number of documents that initially created the expectations. It's required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated. type: number diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml index f74bff185..c02b11d8e 100644 --- a/spec/schemas/_common.query_dsl.yaml +++ b/spec/schemas/_common.query_dsl.yaml @@ -516,7 +516,7 @@ components: type: number missing: description: |- - Value used if the document doesn’t have that field. + Value used if the document doesn't have that field. The modifier and factor are still applied to it as though it were read from the document. type: number modifier: @@ -1303,7 +1303,7 @@ components: case_insensitive: description: |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean required: - value @@ -1520,7 +1520,7 @@ components: case_insensitive: description: |- Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. - When `false`, case sensitivity of matching depends on the underlying field’s mapping. + When `false`, case sensitivity of matching depends on the underlying field's mapping. type: boolean flags: description: Enables optional operators for the regular expression. @@ -1759,7 +1759,7 @@ components: properties: dist: description: |- - The number of tokens from within the include span that can’t have overlap with the exclude span. + The number of tokens from within the include span that can't have overlap with the exclude span. Equivalent to setting both `pre` and `post`. type: number exclude: @@ -1767,10 +1767,10 @@ components: include: $ref: '#/components/schemas/SpanQuery' post: - description: The number of tokens after the include span that can’t have overlap with the exclude span. + description: The number of tokens after the include span that can't have overlap with the exclude span. type: number pre: - description: The number of tokens before the include span that can’t have overlap with the exclude span. + description: The number of tokens before the include span that can't have overlap with the exclude span. type: number required: - exclude @@ -1818,7 +1818,7 @@ components: case_insensitive: description: |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + When `false`, the case sensitivity of matching depends on the underlying field's mapping. type: boolean required: - value @@ -1890,7 +1890,7 @@ components: - type: object properties: case_insensitive: - description: Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml index d4f725b21..90bac8a39 100644 --- a/spec/schemas/_core.bulk.yaml +++ b/spec/schemas/_core.bulk.yaml @@ -33,7 +33,7 @@ components: A map from the full name of fields to the name of dynamic templates. Defaults to an empty map. If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. - If a field is already defined in the mapping, then this parameter won’t be used. + If a field is already defined in the mapping, then this parameter won't be used. type: object additionalProperties: type: string @@ -44,7 +44,7 @@ components: If a final pipeline is configured it will always run, regardless of the value of this parameter. type: string require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean OperationBase: type: object @@ -73,7 +73,7 @@ components: - type: object properties: require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean retry_on_conflict: type: number diff --git a/spec/schemas/_core.field_caps.yaml b/spec/schemas/_core.field_caps.yaml index a56005b9e..f4cf82d15 100644 --- a/spec/schemas/_core.field_caps.yaml +++ b/spec/schemas/_core.field_caps.yaml @@ -43,7 +43,7 @@ components: metric_conflicts_indices: description: |- The list of indices where this field is present if these indices - don’t have the same `time_series_metric` value for this field. + don't have the same `time_series_metric` value for this field. type: array items: $ref: '_common.yaml#/components/schemas/IndexName' diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml index 466304f78..2be37ba41 100644 --- a/spec/schemas/_core.rank_eval.yaml +++ b/spec/schemas/_core.rank_eval.yaml @@ -45,7 +45,7 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' rating: - description: The document’s relevance with regard to this search request. + description: The document's relevance with regard to this search request. type: number required: - _id @@ -119,7 +119,7 @@ components: description: The metric_score in the details section shows the contribution of this query to the global quality metric score type: number unrated_docs: - description: The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + description: The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents type: array items: $ref: '#/components/schemas/UnratedDocument' diff --git a/spec/schemas/_core.scripts_painless_execute.yaml b/spec/schemas/_core.scripts_painless_execute.yaml index 9c631c3a9..5997842ff 100644 --- a/spec/schemas/_core.scripts_painless_execute.yaml +++ b/spec/schemas/_core.scripts_painless_execute.yaml @@ -10,7 +10,7 @@ components: type: object properties: document: - description: Document that’s temporarily indexed in-memory and accessible from the script. + description: Document that's temporarily indexed in-memory and accessible from the script. type: object index: $ref: '_common.yaml#/components/schemas/IndexName' diff --git a/spec/schemas/_core.search.yaml b/spec/schemas/_core.search.yaml index 6e3ed1f75..1011120e1 100644 --- a/spec/schemas/_core.search.yaml +++ b/spec/schemas/_core.search.yaml @@ -711,7 +711,7 @@ components: description: |- If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned - The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to lower value than the query setting. type: number no_match_size: description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml index a23183238..cfb016e91 100644 --- a/spec/schemas/cat.allocation.yaml +++ b/spec/schemas/cat.allocation.yaml @@ -14,7 +14,7 @@ components: type: string disk.indices: description: |- - Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. + Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. anyOf: - $ref: '_common.yaml#/components/schemas/ByteSize' @@ -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. anyOf: - $ref: '_common.yaml#/components/schemas/ByteSize' @@ -33,7 +33,7 @@ components: disk.avail: description: |- Free disk space available to OpenSearch. - OpenSearch retrieves this metric from the node’s operating system. + 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. anyOf: - $ref: '_common.yaml#/components/schemas/ByteSize' diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml index 649780d8d..65c9e94d2 100644 --- a/spec/schemas/cat.shards.yaml +++ b/spec/schemas/cat.shards.yaml @@ -66,11 +66,11 @@ components: `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. - `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. + `FORCED_EMPTY_PRIMARY`: The shard's allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. - `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. + `MANUAL_ALLOCATION`: The shard's allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml index 283ad1539..e8896812c 100644 --- a/spec/schemas/cluster.stats.yaml +++ b/spec/schemas/cluster.stats.yaml @@ -254,7 +254,7 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' scriptless_count: - description: Number of runtime fields that don’t declare a script. + description: Number of runtime fields that don't declare a script. type: number shadowed_count: description: Number of runtime fields that shadow an indexed field. diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index f2ace0b51..801f5333e 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -349,7 +349,7 @@ components: Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, - for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails. type: boolean step: $ref: '#/components/schemas/IndexSettingsLifecycleStep' @@ -622,8 +622,8 @@ components: properties: limit: description: |- - Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but - might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but + might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). type: number MappingLimitSettingsDimensionFields: @@ -849,7 +849,7 @@ components: description: If `true`, the data stream allows custom routing on write request. type: boolean generation: - description: Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1. type: number hidden: description: If `true`, the data stream is hidden. @@ -863,8 +863,8 @@ components: type: boolean indices: description: |- - Array of objects containing information about the data stream’s backing indices. - The last item in this array contains information about the stream’s current write index. + Array of objects containing information about the data stream's backing indices. + The last item in this array contains information about the stream's current write index. type: array items: $ref: '#/components/schemas/DataStreamIndex' diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml index e222125af..9c1954f55 100644 --- a/spec/schemas/indices.data_streams_stats.yaml +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -19,7 +19,7 @@ components: store_size: $ref: '_common.yaml#/components/schemas/ByteSize' store_size_bytes: - description: Total size, in bytes, of all shards for the data stream’s backing indices. + description: Total size, in bytes, of all shards for the data stream's backing indices. type: number required: - backing_indices diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml index 7a1b4c259..d3a96b0a3 100644 --- a/spec/schemas/ingest._common.yaml +++ b/spec/schemas/ingest._common.yaml @@ -536,7 +536,7 @@ components: items: type: string trace_match: - description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document's metadata with the index into the pattern found in `patterns` that matched. type: boolean required: - field @@ -795,7 +795,7 @@ components: - type: object properties: error_distance: - description: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + description: The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number field: $ref: '_common.yaml#/components/schemas/Field' diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index 127329630..8f795d129 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -40,7 +40,7 @@ components: description: Remote address for the HTTP connection. type: string last_uri: - description: The URI of the client’s most recent request. + description: The URI of the client's most recent request. type: string opened_time_millis: description: Time at which the client opened the connection. @@ -59,7 +59,7 @@ components: type: number x_opaque_id: description: |- - Value from the client’s `x-opaque-id` HTTP header. + Value from the client's `x-opaque-id` HTTP header. If unavailable, this property is not included in the response. type: string Ingest: