From d289c670a43ba6edf6c0ae0760d4d10785fe0aaf Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 13:19:17 -0600 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 46 ++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 9da770cc..6b9c5ffb 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -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: @@ -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: @@ -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' @@ -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' @@ -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' @@ -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 @@ -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' @@ -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' @@ -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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.recovery::query.v: @@ -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' @@ -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' @@ -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 @@ -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: @@ -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' @@ -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' @@ -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' @@ -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' @@ -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' @@ -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' @@ -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 @@ -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' @@ -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' @@ -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'