Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc Vale fixes. #682

Merged
merged 1 commit into from
Nov 19, 2024
+215 −215
Merged

Misc Vale fixes. #682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions spec/namespaces/_core.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4197,7 +4197,7 @@ components:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
delete_script::query.timeout:
in: query
name: timeout
Expand Down Expand Up @@ -4659,7 +4659,7 @@ components:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
get_source::path.id:
in: path
name: id
Expand Down Expand Up @@ -4965,7 +4965,7 @@ components:
msearch::query.rest_total_hits_as_int:
in: query
name: rest_total_hits_as_int
description: If `true`, hits.total are returned as an integer in the response. Defaults to false, which returns an object.
description: If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object.
schema:
type: boolean
default: false
Expand Down Expand Up @@ -5188,7 +5188,7 @@ components:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
put_script::query.timeout:
in: query
name: timeout
Expand Down Expand Up @@ -5947,7 +5947,7 @@ components:
search_template::query.rest_total_hits_as_int:
in: query
name: rest_total_hits_as_int
description: If `true`, hits.total are rendered as an integer in the response.
description: If `true`, `hits.total` are rendered as an integer in the response.
schema:
type: boolean
default: false
Expand Down
32 changes: 16 additions & 16 deletions spec/namespaces/cat.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ paths:
operationId: cat.fielddata.0
x-operation-group: cat.fielddata
x-version-added: '1.0'
description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
description: Shows how much heap memory is currently being used by field data on every data node in the cluster.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
parameters:
Expand All @@ -176,7 +176,7 @@ paths:
operationId: cat.fielddata.1
x-operation-group: cat.fielddata
x-version-added: '1.0'
description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
description: Shows how much heap memory is currently being used by field data on every data node in the cluster.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/
parameters:
Expand Down Expand Up @@ -1237,7 +1237,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.allocation::query.s:
name: s
Expand Down Expand Up @@ -1306,7 +1306,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.cluster_manager::query.s:
name: s
Expand Down Expand Up @@ -1598,7 +1598,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.indices::query.pri:
in: query
Expand Down Expand Up @@ -1682,7 +1682,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.master::query.s:
name: s
Expand Down Expand Up @@ -1751,7 +1751,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.nodeattrs::query.s:
name: s
Expand Down Expand Up @@ -1840,7 +1840,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.nodes::query.s:
name: s
Expand Down Expand Up @@ -1915,7 +1915,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.pending_tasks::query.s:
name: s
Expand Down Expand Up @@ -2041,7 +2041,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.plugins::query.s:
name: s
Expand Down Expand Up @@ -2205,7 +2205,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.repositories::query.s:
name: s
Expand Down Expand Up @@ -2430,7 +2430,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.segments::query.s:
name: s
Expand Down Expand Up @@ -2517,7 +2517,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.shards::query.s:
name: s
Expand Down Expand Up @@ -2604,7 +2604,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.snapshots::query.s:
name: s
Expand Down Expand Up @@ -2775,7 +2775,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.templates::query.s:
name: s
Expand Down Expand Up @@ -2854,7 +2854,7 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
cat.thread_pool::query.s:
name: s
Expand Down
34 changes: 17 additions & 17 deletions spec/namespaces/cluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.get_component_template::path.name:
in: path
name: name
Expand Down Expand Up @@ -945,7 +945,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.get_decommission_awareness::path.awareness_attribute_name:
name: awareness_attribute_name
in: path
Expand Down Expand Up @@ -988,7 +988,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.get_settings::query.timeout:
in: query
name: timeout
Expand Down Expand Up @@ -1059,7 +1059,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.health::query.timeout:
in: query
name: timeout
Expand All @@ -1084,14 +1084,14 @@
cluster.health::query.wait_for_no_initializing_shards:
in: query
name: wait_for_no_initializing_shards
description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
schema:
type: boolean
style: form
cluster.health::query.wait_for_no_relocating_shards:
in: query
name: wait_for_no_relocating_shards
description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

Check failure on line 1094 in spec/namespaces/cluster.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: relocations. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: relocations. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "spec/namespaces/cluster.yaml", "range": {"start": {"line": 1094, "column": 129}}}, "severity": "ERROR"}
schema:
type: boolean
style: form
Expand Down Expand Up @@ -1139,13 +1139,13 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.post_voting_config_exclusions::query.node_ids:
in: query
name: node_ids
description: |-
A comma-separated list of the persistent ids of the nodes to exclude
from the voting configuration. If specified, you may not also specify node_names.
from the voting configuration. If specified, you may not also specify `node_names`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Ids'
style: form
Expand All @@ -1154,7 +1154,7 @@
name: node_names
description: |-
A comma-separated list of the names of the nodes to exclude from the
voting configuration. If specified, you may not also specify node_ids.
voting configuration. If specified, you may not also specify `node_ids`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Names'
style: form
Expand Down Expand Up @@ -1208,7 +1208,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.put_component_template::query.timeout:
name: timeout
in: query
Expand Down Expand Up @@ -1255,7 +1255,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.put_settings::query.timeout:
in: query
name: timeout
Expand Down Expand Up @@ -1301,7 +1301,7 @@
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.reroute::query.metric:
in: query
name: metric
Expand Down Expand Up @@ -1392,24 +1392,24 @@
cluster.state::query.master_timeout:
in: query
name: master_timeout
description: Specify timeout for connection to master
description: Specify timeout for connection to cluster manager.
deprecated: true
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead.
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
cluster.state::query.wait_for_metadata_version:
in: query
name: wait_for_metadata_version
description: Wait for the metadata version to be equal or greater than the specified metadata version
description: Wait for the metadata version to be equal or greater than the specified metadata version.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/VersionNumber'
style: form
cluster.state::query.wait_for_timeout:
in: query
name: wait_for_timeout
description: The maximum time to wait for wait_for_metadata_version before timing out
description: The maximum time to wait for `wait_for_metadata_version` before timing out.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
Expand All @@ -1426,7 +1426,7 @@
cluster.stats::path.metric:
in: path
name: metric
description: Limit the information returned to the specified metrics
description: Limit the information returned to the specified metrics.
required: true
schema:
type: array
Expand Down
Loading
Loading