From 91908f1bd0db3ddbedbb9c97d8b9e679267fb164 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:16:49 -0600 Subject: [PATCH] Fix various errors. Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index b3c5a48b..e5e3a0f7 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -20,7 +20,7 @@ paths: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indexes including filter and routing info. + description: Shows information about currently configured aliases to indexes including filter and routing information. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: @@ -139,7 +139,7 @@ paths: operationId: cat.count.1 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indexes. + description: Provides quick access to the document count of the entire cluster or individual indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -215,7 +215,7 @@ paths: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indexes: number of primaries and replicas, document counts, disk size, ...' + description: Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: @@ -438,7 +438,7 @@ paths: operationId: cat.recovery.1 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns all completed and ongoing index shard recoveries. + description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -512,7 +512,9 @@ paths: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about active and last completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging. + description: |- + Returns information about active and last completed segment replication events on each replica shard, including related shard-level metrics. + These metrics provide information about how far behind the primary shard the replicas are lagging. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: @@ -1143,7 +1145,7 @@ components: cat.all_pit_segments::query.h: name: h in: query - description: A A comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array @@ -1173,11 +1175,11 @@ components: cat.all_pit_segments::query.v: name: v in: query - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. cat.allocation::path.node_id: in: path name: node_id @@ -1210,13 +1212,13 @@ components: cat.allocation::query.h: name: h in: query - description: A A comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: A A comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.allocation::query.help: name: help @@ -1866,11 +1868,11 @@ components: cat.nodes::query.v: name: v in: query - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. cat.pending_tasks::query.cluster_manager_timeout: name: cluster_manager_timeout in: query