Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
@Naarcha-AWS @natebower
Naarcha-AWS and natebower authored Dec 23, 2024
1 parent c715058 commit d289c67
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions spec/namespaces/cat.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ paths:
operationId: cat.aliases.1
x-operation-group: cat.aliases
x-version-added: '1.0'
description: Shows information about currently configured aliases to indexes including filter and routing information.
description: Shows information about aliases currently configured to indexes, including filter and routing information.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
parameters:
Expand Down Expand Up @@ -585,7 +585,7 @@ paths:
operationId: cat.shards.0
x-operation-group: cat.shards
x-version-added: '1.0'
description: Lists the state of all primary and replica shards and how they are distributed.
description: Lists the states of all primary and replica shards and how they are distributed.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/
parameters:
Expand Down Expand Up @@ -1643,7 +1643,7 @@ components:
cat.master::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -1753,7 +1753,7 @@ components:
cat.nodeattrs::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -1876,7 +1876,7 @@ components:
cat.pending_tasks::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -1913,7 +1913,7 @@ components:
schema:
type: boolean
default: false
description: Returns local information, but does not retrieve the state from cluster-manager node.
description: Returns local information but does not retrieve the state from the cluster manager node.
cat.pending_tasks::query.master_timeout:
name: master_timeout
in: query
Expand Down Expand Up @@ -2002,7 +2002,7 @@ components:
cat.plugins::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2043,7 +2043,7 @@ components:
cat.plugins::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2156,7 +2156,7 @@ components:
cat.recovery::query.time:
name: time
in: query
description: Specifies the units for time. For example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).

Check failure on line 2159 in spec/namespaces/cat.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.

Raw Output:
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.", "location": {"path": "spec/namespaces/cat.yaml", "range": {"start": {"line": 2159, "column": 125}}}, "severity": "ERROR"}

Check failure on line 2159 in spec/namespaces/cat.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'opensearch.org'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'opensearch.org'.", "location": {"path": "spec/namespaces/cat.yaml", "range": {"start": {"line": 2159, "column": 125}}}, "severity": "ERROR"}
schema:
$ref: '../schemas/_common.yaml#/components/schemas/TimeUnit'
cat.recovery::query.v:
Expand All @@ -2170,7 +2170,7 @@ components:
cat.repositories::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2211,7 +2211,7 @@ components:
cat.repositories::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2264,7 +2264,7 @@ components:
description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified.
schema:
type: boolean
description: Whether to ignore the index if a wildcard index expression resolves into no concrete indexes. This includes the `_all` string or when no indexes have been specified.
description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified.
cat.segment_replication::query.bytes:
name: bytes
in: query
Expand All @@ -2290,7 +2290,7 @@ components:
cat.segment_replication::query.expand_wildcards:
name: expand_wildcards
in: query
description: Whether to expand the wildcard expression to concrete indexes that are open, closed, or both.
description: Whether to expand the wildcard expression to include concrete indexes that are open, closed, or both.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
cat.segment_replication::query.format:
Expand Down Expand Up @@ -2411,7 +2411,7 @@ components:
cat.segments::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2444,7 +2444,7 @@ components:
cat.segments::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2490,7 +2490,7 @@ components:
cat.shards::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2531,7 +2531,7 @@ components:
cat.shards::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2588,7 +2588,7 @@ components:
cat.snapshots::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2629,7 +2629,7 @@ components:
cat.snapshots::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2708,7 +2708,7 @@ components:
in: query
description: |-
A comma-separated list of node IDs or names used to limit the returned information.
Use `_local` to return information from the node you’re connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes.
style: form
schema:
type: array
Expand Down Expand Up @@ -2762,7 +2762,7 @@ components:
cat.templates::query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-added: '2.0'
Expand Down Expand Up @@ -2803,7 +2803,7 @@ components:
cat.templates::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down Expand Up @@ -2882,7 +2882,7 @@ components:
cat.thread_pool::query.master_timeout:
name: master_timeout
in: query
description: A timeout for connection to the cluster manager node.
description: The amount of time allowed to establish a connection to the cluster manager node.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
x-version-deprecated: '2.0'
Expand Down

0 comments on commit d289c67

Please sign in to comment.