From 6b589f9ad88d0bf09fec884beefa8f5475a7551f Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 20 Dec 2024 10:54:33 -0600 Subject: [PATCH 01/10] Update cat namespace descriptions Updates all cat namespace descriptions to add automation. Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 587 ++++++++++++++++++++------------------- 1 file changed, 301 insertions(+), 286 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index ca981bbd..223fd52f 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 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: @@ -122,7 +122,7 @@ paths: operationId: cat.count.0 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: @@ -241,7 +241,7 @@ paths: operationId: cat.indices.1 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: @@ -314,7 +314,7 @@ paths: operationId: cat.nodes.0 x-operation-group: cat.nodes x-version-added: '1.0' - description: Returns basic statistics about performance of cluster nodes. + description: Returns basic statistics about the performance of cluster nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ parameters: @@ -337,7 +337,7 @@ paths: operationId: cat.pending_tasks.0 x-operation-group: cat.pending_tasks x-version-added: '1.0' - description: Returns a concise representation of the cluster pending tasks. + description: Returns a concise representation of the cluster's pending tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: @@ -358,7 +358,7 @@ paths: operationId: cat.pit_segments.0 x-operation-group: cat.pit_segments x-version-added: '2.4' - description: List segments for one or several PITs. + description: List one or several CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -378,7 +378,7 @@ paths: operationId: cat.all_pit_segments.0 x-operation-group: cat.all_pit_segments x-version-added: '2.4' - description: Lists all active point-in-time segments. + description: Lists all active CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -396,7 +396,7 @@ paths: operationId: cat.plugins.0 x-operation-group: cat.plugins x-version-added: '1.0' - description: Returns information about installed plugins across nodes node. + description: Returns information about the names, components, and versions of the installed plugins. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -416,7 +416,7 @@ paths: operationId: cat.recovery.0 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -438,7 +438,7 @@ paths: operationId: cat.recovery.1 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: Returns all completed and ongoing index shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -461,7 +461,7 @@ paths: operationId: cat.repositories.0 x-operation-group: cat.repositories x-version-added: '1.0' - description: Returns information about snapshot repositories registered in the cluster. + description: Returns information about all snapshot repositories for a cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: @@ -481,7 +481,9 @@ paths: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + 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: @@ -510,7 +512,7 @@ paths: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + 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: @@ -581,7 +583,7 @@ paths: operationId: cat.shards.0 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: Lists the state of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -603,7 +605,7 @@ paths: operationId: cat.shards.1 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: Lists the state of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -626,7 +628,7 @@ paths: operationId: cat.snapshots.0 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: Lists all of the snapshots in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -648,7 +650,7 @@ paths: operationId: cat.snapshots.1 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: Lists all of the snapshots in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -671,7 +673,7 @@ paths: operationId: cat.tasks.0 x-operation-group: cat.tasks x-version-added: '1.0' - description: Returns information about the tasks currently executing on one or more nodes in the cluster. + description: Lists the progress of all tasks currently running on your cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: @@ -693,7 +695,7 @@ paths: operationId: cat.templates.0 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -713,7 +715,7 @@ paths: operationId: cat.templates.1 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -736,7 +738,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue and rejected statistics are returned for all thread pools. + By default the active, queue, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -759,7 +761,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue and rejected statistics are returned for all thread pools. + By default the active, queue, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -1128,26 +1130,26 @@ components: cat.all_pit_segments::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.all_pit_segments::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.all_pit_segments::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.all_pit_segments::query.help: name: help @@ -1160,22 +1162,22 @@ components: cat.all_pit_segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.all_pit_segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.allocation::path.node_id: in: path name: node_id @@ -1208,13 +1210,13 @@ components: cat.allocation::query.h: name: h in: query - description: A comma-separated list of column names to display. + description: A A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: A comma-separated list of column names to display. + description: A A comma-separated list of column names to display. explode: true cat.allocation::query.help: name: help @@ -1296,11 +1298,11 @@ components: cat.cluster_manager::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Return local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.cluster_manager::query.master_timeout: name: master_timeout in: query @@ -1342,20 +1344,20 @@ components: cat.count::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.count::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.count::query.help: name: help @@ -1368,27 +1370,27 @@ components: cat.count::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.count::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.fielddata::path.fields: in: path name: fields description: |- - Comma-separated list of fields used to limit returned information. + A comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. required: true schema: @@ -1397,34 +1399,34 @@ components: cat.fielddata::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.fielddata::query.fields: in: query name: fields - description: Comma-separated list of fields used to limit returned information. + description: A comma-separated list of fields used to limit returned information. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form cat.fielddata::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.fielddata::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.fielddata::query.help: name: help @@ -1437,39 +1439,39 @@ components: cat.fielddata::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.fielddata::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.health::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.health::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.health::query.help: name: help @@ -1482,13 +1484,13 @@ components: cat.health::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.health::query.time: in: query @@ -1500,7 +1502,7 @@ components: cat.health::query.ts: in: query name: ts - description: If `true`, returns `HH:MM:SS` and Unix epoch timestamps. + description: When `true`, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true @@ -1508,17 +1510,17 @@ components: cat.health::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.indices::path.index: in: path name: index description: |- - Comma-separated list of data streams, indexes, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter, or use `*` or `_all`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -1526,14 +1528,14 @@ components: cat.indices::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.indices::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' @@ -1547,25 +1549,25 @@ components: cat.indices::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.indices::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.indices::query.health: in: query name: health - description: The health status used to limit returned indexes. By default, the response includes indexes of any health status. + description: Limit indexes based on their health status. Supported values are `green`, `yellow`, and `red`. schema: $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' style: form @@ -1580,7 +1582,7 @@ components: cat.indices::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If `true`, the response includes information from segments that are not loaded into memory. + description: Whether to include information from segments not loaded into memory. schema: type: boolean default: false @@ -1588,15 +1590,15 @@ components: cat.indices::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.indices::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1605,7 +1607,7 @@ components: cat.indices::query.pri: in: query name: pri - description: If `true`, the response only includes information from primary shards. + description: When `true`, whether to return information only from the primary shards. schema: type: boolean default: false @@ -1613,53 +1615,53 @@ components: cat.indices::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.indices::query.time: in: query name: time - description: The unit used to display time values. + description: Specifies the units for time. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' style: form cat.indices::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.master::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.master::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.master::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.master::query.help: name: help @@ -1672,15 +1674,15 @@ components: cat.master::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.master::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1689,46 +1691,46 @@ components: cat.master::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.master::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.nodeattrs::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.nodeattrs::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodeattrs::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.nodeattrs::query.help: name: help @@ -1741,15 +1743,15 @@ components: cat.nodeattrs::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.nodeattrs::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1758,47 +1760,47 @@ components: cat.nodeattrs::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodeattrs::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.nodes::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.nodes::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.nodes::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodes::query.full_id: in: query name: full_id - description: If `true`, return the full node ID. If `false`, return the shortened node ID. + description: When `true`, return the full node ID. When `false`, returns the shortened node ID. schema: anyOf: - type: boolean @@ -1808,13 +1810,13 @@ components: cat.nodes::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.nodes::query.help: name: help @@ -1827,18 +1829,18 @@ components: cat.nodes::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. deprecated: true x-version-deprecated: '1.0' x-deprecation-message: This parameter does not cause this API to act locally. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.nodes::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1847,52 +1849,52 @@ components: cat.nodes::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodes::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.nodes::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.pending_tasks::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.pending_tasks::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pending_tasks::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.pending_tasks::query.help: name: help @@ -1905,15 +1907,15 @@ components: cat.pending_tasks::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.pending_tasks::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1922,51 +1924,51 @@ components: cat.pending_tasks::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pending_tasks::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.pending_tasks::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.pit_segments::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.pit_segments::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pit_segments::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.pit_segments::query.help: name: help @@ -1979,46 +1981,46 @@ components: cat.pit_segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pit_segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.plugins::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.plugins::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.plugins::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.plugins::query.help: name: help @@ -2031,15 +2033,15 @@ components: cat.plugins::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.plugins::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2048,22 +2050,22 @@ components: cat.plugins::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.plugins::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.recovery::path.index: in: path name: index @@ -2085,14 +2087,14 @@ components: cat.recovery::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.recovery::query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: When `true`, includes detailed information about shard recoveries. schema: type: boolean default: false @@ -2100,20 +2102,20 @@ components: cat.recovery::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.recovery::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.recovery::query.help: name: help @@ -2126,63 +2128,65 @@ components: cat.recovery::query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.recovery::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.recovery::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.recovery::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.repositories::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.repositories::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.repositories::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.repositories::query.help: name: help @@ -2195,15 +2199,15 @@ components: cat.repositories::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.repositories::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2212,92 +2216,96 @@ components: cat.repositories::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.repositories::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.segment_replication::path.index: name: index in: path - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. schema: type: array - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. items: type: string required: true cat.segment_replication::query.active_only: name: active_only in: query - description: If `true`, the response only includes ongoing segment replication events. + description: When `true`, the response only includes ongoing segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes ongoing segment replication events. + description: When `true`, the response only includes ongoing segment replication events. cat.segment_replication::query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + 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. schema: type: boolean - description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + 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. cat.segment_replication::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.segment_replication::query.completed_only: name: completed_only in: query - description: If `true`, the response only includes latest completed segment replication events. + description: When `true`, the response only includes the latest completed segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes latest completed segment replication events. + description: When `true`, the response only includes the latest completed segment replication events. cat.segment_replication::query.detailed: name: detailed in: query - description: If `true`, the response includes detailed information about segment replications. + description: When `true`, the response includes additional metrics for each stage of a segment replication event. schema: type: boolean default: false - description: If `true`, the response includes detailed information about segment replications. + description: When `true`, the response includes additional metrics for each stage of a segment replication event. cat.segment_replication::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. + description: Whether to expand the wildcard expression to concrete indexes that are open, closed, or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' cat.segment_replication::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segment_replication::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.segment_replication::query.help: name: help @@ -2310,70 +2318,74 @@ components: cat.segment_replication::query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. cat.segment_replication::query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + description: Whether the specified concrete indexes should be ignored when missing or closed. schema: type: boolean - description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + description: Whether the specified concrete indexes should be ignored when missing or closed. cat.segment_replication::query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.segment_replication::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segment_replication::query.shards: name: shards in: query - description: Comma-separated list of shards to display. + description: A comma-separated list of shards to display.. style: form schema: type: array items: type: string - description: Comma-separated list of shards to display. + description: A comma-separated list of shards to display.. explode: true cat.segment_replication::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.segment_replication::query.timeout: name: timeout in: query - description: Operation timeout. + description: An operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' cat.segment_replication::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.segments::path.index: in: path name: index @@ -2388,47 +2400,47 @@ components: cat.segments::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.segments::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.segments::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segments::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.segments::query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.segments::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2437,22 +2449,22 @@ components: cat.segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.shards::path.index: in: path name: index @@ -2467,34 +2479,34 @@ components: cat.shards::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.shards::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.shards::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.shards::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.shards::query.help: name: help @@ -2507,15 +2519,15 @@ components: cat.shards::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.shards::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2524,28 +2536,28 @@ components: cat.shards::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.shards::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.shards::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.snapshots::query.repository: in: query name: repository @@ -2572,27 +2584,27 @@ components: cat.snapshots::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.snapshots::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.snapshots::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.snapshots::query.help: name: help @@ -2605,7 +2617,7 @@ components: cat.snapshots::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, the response does not include information from unavailable snapshots. + description: When `true`, the response does not include information from unavailable snapshots. schema: type: boolean default: false @@ -2613,7 +2625,7 @@ components: cat.snapshots::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2622,32 +2634,32 @@ components: cat.snapshots::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.snapshots::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.snapshots::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.tasks::query.actions: in: query name: actions - description: The task action names, which are used to limit the response. + description: The task action names used to limit the response. schema: type: array items: @@ -2664,20 +2676,20 @@ components: cat.tasks::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.tasks::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.tasks::query.help: name: help @@ -2690,14 +2702,17 @@ components: cat.tasks::query.nodes: name: nodes in: query - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: |- + A comma-separated list of node IDs or names 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. style: form schema: type: array items: type: string - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - explode: true + description: |- + A comma-separated list of node IDs or names 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. cat.tasks::query.parent_task_id: in: query name: parent_task_id @@ -2708,28 +2723,28 @@ components: cat.tasks::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.tasks::query.time: name: time in: query - description: The unit in which to display time values. + 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/). schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.tasks::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.templates::path.name: in: path name: name @@ -2743,27 +2758,27 @@ components: cat.templates::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.templates::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.templates::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.templates::query.help: name: help @@ -2776,15 +2791,15 @@ components: cat.templates::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.templates::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2793,22 +2808,22 @@ components: cat.templates::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.templates::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.thread_pool::path.thread_pool_patterns: in: path name: thread_pool_patterns @@ -2822,27 +2837,27 @@ components: cat.thread_pool::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.thread_pool::query.format: name: format in: query - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header (for example, `json`, `yaml`). + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.thread_pool::query.h: name: h in: query - description: 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: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.thread_pool::query.help: name: help @@ -2855,15 +2870,15 @@ components: cat.thread_pool::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information, but does not retrieve the state from cluster-manager node. cat.thread_pool::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2872,13 +2887,13 @@ components: cat.thread_pool::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.thread_pool::query.size: name: size @@ -2891,8 +2906,8 @@ components: cat.thread_pool::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. From 0f2e5cb471db0b24fe51290ce18e5c8ccfc3f8e7 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:07:38 -0600 Subject: [PATCH 02/10] Fix linting error Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 223fd52f..b3c5a48b 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -2135,8 +2135,8 @@ components: items: type: string description: |- - A comma-separated list of data streams, indexes, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.recovery::query.s: name: s 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 03/10] 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 From a61038fdd69eedea99c887e049aad2f8340a3a55 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:22:15 -0600 Subject: [PATCH 04/10] Fix remaining linting errors Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index e5e3a0f7..674f1b04 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1639,7 +1639,7 @@ components: schema: type: boolean default: false - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. cat.master::query.cluster_manager_timeout: name: cluster_manager_timeout in: query @@ -1943,11 +1943,11 @@ components: cat.pending_tasks::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.pit_segments::query.bytes: name: bytes in: query @@ -1994,11 +1994,11 @@ components: cat.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.plugins::query.cluster_manager_timeout: name: cluster_manager_timeout in: query @@ -2063,11 +2063,11 @@ components: cat.plugins::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.recovery::path.index: in: path name: index @@ -2130,7 +2130,9 @@ components: cat.recovery::query.index: name: index in: query - description: + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array @@ -2233,7 +2235,7 @@ components: schema: type: boolean default: false - description: Enables verbose mode, which displays column headers. + description: Enables verbose mode, which displays column headers. cat.segment_replication::path.index: name: index in: path @@ -2335,8 +2337,8 @@ components: name: index in: query description: |- - A comma-separated list of data streams, indexes, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array @@ -2462,11 +2464,11 @@ components: cat.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.shards::path.index: in: path name: index @@ -2821,11 +2823,11 @@ components: cat.templates::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.thread_pool::path.thread_pool_patterns: in: path name: thread_pool_patterns From c715058716e1223f8b1f78bc45d95de2fe398285 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 13:12:43 -0600 Subject: [PATCH 05/10] 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 | 110 +++++++++++++++++++-------------------- 1 file changed, 55 insertions(+), 55 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 674f1b04..9da770cc 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 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: @@ -122,7 +122,7 @@ paths: operationId: cat.count.0 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 of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ 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 of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -358,7 +358,7 @@ paths: operationId: cat.pit_segments.0 x-operation-group: cat.pit_segments x-version-added: '2.4' - description: List one or several CAT point-in-time segments. + description: Lists one or several CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -482,7 +482,7 @@ paths: 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. + 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/ @@ -513,7 +513,7 @@ paths: 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. + 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/ @@ -607,7 +607,7 @@ paths: operationId: cat.shards.1 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: @@ -630,7 +630,7 @@ paths: operationId: cat.snapshots.0 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Lists all of the snapshots in a specific repository. + description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -652,7 +652,7 @@ paths: operationId: cat.snapshots.1 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Lists all of the snapshots in a specific repository. + description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -675,7 +675,7 @@ paths: operationId: cat.tasks.0 x-operation-group: cat.tasks x-version-added: '1.0' - description: Lists the progress of all tasks currently running on your cluster. + description: Lists the progress of all tasks currently running on the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: @@ -740,7 +740,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue, and rejected statistics are returned for all thread pools. + By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -763,7 +763,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue, and rejected statistics are returned for all thread pools. + By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -1300,11 +1300,11 @@ components: cat.cluster_manager::query.local: name: local in: query - description: Return 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. 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.cluster_manager::query.master_timeout: name: master_timeout in: query @@ -1392,7 +1392,7 @@ components: in: path name: fields description: |- - A comma-separated list of fields used to limit returned information. + A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. required: true schema: @@ -1408,7 +1408,7 @@ components: cat.fielddata::query.fields: in: query name: fields - description: A comma-separated list of fields used to limit returned information. + description: A comma-separated list of fields used to limit the amount of returned information. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form @@ -1522,7 +1522,7 @@ components: name: index description: |- A comma-separated list of data streams, indexes, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indexes, omit this parameter, or use `*` or `_all`. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -1537,7 +1537,7 @@ components: cat.indices::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' @@ -1569,7 +1569,7 @@ components: cat.indices::query.health: in: query name: health - description: Limit indexes based on their health status. Supported values are `green`, `yellow`, and `red`. + description: Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. schema: $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' style: form @@ -1592,15 +1592,15 @@ components: cat.indices::query.local: name: local in: query - 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. 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.indices::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' @@ -1628,7 +1628,7 @@ components: cat.indices::query.time: in: query name: time - description: Specifies the units for time. + description: Specifies the time units. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' style: form @@ -1676,11 +1676,11 @@ components: cat.master::query.local: name: local in: query - 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. 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.master::query.master_timeout: name: master_timeout in: query @@ -1745,11 +1745,11 @@ components: cat.nodeattrs::query.local: name: local in: query - 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. 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.nodeattrs::query.master_timeout: name: master_timeout in: query @@ -1802,7 +1802,7 @@ components: cat.nodes::query.full_id: in: query name: full_id - description: When `true`, return the full node ID. When `false`, returns the shortened node ID. + description: When `true`, returns the full node ID. When `false`, returns the shortened node ID. schema: anyOf: - type: boolean @@ -1831,14 +1831,14 @@ components: cat.nodes::query.local: name: local in: query - 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. deprecated: true x-version-deprecated: '1.0' x-deprecation-message: This parameter does not cause this API to act locally. 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.nodes::query.master_timeout: name: master_timeout in: query @@ -1862,7 +1862,7 @@ components: cat.nodes::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.nodes::query.v: @@ -1909,7 +1909,7 @@ components: cat.pending_tasks::query.local: name: local in: query - 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. schema: type: boolean default: false @@ -1937,7 +1937,7 @@ components: cat.pending_tasks::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.pending_tasks::query.v: @@ -2035,11 +2035,11 @@ components: cat.plugins::query.local: name: local in: query - 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. 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.plugins::query.master_timeout: name: master_timeout in: query @@ -2203,11 +2203,11 @@ components: cat.repositories::query.local: name: local in: query - 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. 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.repositories::query.master_timeout: name: master_timeout in: query @@ -2261,7 +2261,7 @@ components: cat.segment_replication::query.allow_no_indices: name: allow_no_indices in: query - 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. 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. @@ -2274,11 +2274,11 @@ components: cat.segment_replication::query.completed_only: name: completed_only in: query - description: When `true`, the response only includes the latest completed segment replication events. + description: When `true`, the response only includes the last-completed segment replication events. schema: type: boolean default: false - description: When `true`, the response only includes the latest completed segment replication events. + description: When `true`, the response only includes the last-completed segment replication events. cat.segment_replication::query.detailed: name: detailed in: query @@ -2362,18 +2362,18 @@ components: cat.segment_replication::query.shards: name: shards in: query - description: A comma-separated list of shards to display.. + description: A comma-separated list of shards to display. style: form schema: type: array items: type: string - description: A comma-separated list of shards to display.. + description: A comma-separated list of shards to display. explode: true cat.segment_replication::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.segment_replication::query.timeout: @@ -2523,11 +2523,11 @@ components: cat.shards::query.local: name: local in: query - 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. 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.shards::query.master_timeout: name: master_timeout in: query @@ -2551,7 +2551,7 @@ components: cat.shards::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.shards::query.v: @@ -2649,7 +2649,7 @@ components: cat.snapshots::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.snapshots::query.v: @@ -2707,7 +2707,7 @@ components: name: nodes in: query description: |- - A comma-separated list of node IDs or names to limit the returned information. + 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. style: form schema: @@ -2715,8 +2715,8 @@ components: items: type: string description: |- - A comma-separated list of node IDs or names 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. + A comma-separated list of node IDs or names used to limit the returned information. + 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. cat.tasks::query.parent_task_id: in: query name: parent_task_id @@ -2738,7 +2738,7 @@ components: cat.tasks::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.tasks::query.v: @@ -2795,11 +2795,11 @@ components: cat.templates::query.local: name: local in: query - 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. 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.templates::query.master_timeout: name: master_timeout in: query @@ -2874,11 +2874,11 @@ components: cat.thread_pool::query.local: name: local in: query - 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. 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.thread_pool::query.master_timeout: name: master_timeout in: query 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 06/10] 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' From 9270c4194d67f8ddc62ecc28090672e711c28653 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 13:29:51 -0600 Subject: [PATCH 07/10] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 6b9c5ffb..3cf9a519 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1609,7 +1609,7 @@ components: cat.indices::query.pri: in: query name: pri - description: When `true`, whether to return information only from the primary shards. + description: When `true`, returns information only from the primary shards. schema: type: boolean default: false From 33cfa06b446fbed595c49e07ac8708326c258b63 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 13:30:21 -0600 Subject: [PATCH 08/10] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 3cf9a519..f5004984 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -2379,7 +2379,7 @@ components: cat.segment_replication::query.timeout: name: timeout in: query - description: An operation timeout. + description: The operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' cat.segment_replication::query.v: From e29d827659e4f92cad7e1f77bf822e8b05c800dc Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 13:31:08 -0600 Subject: [PATCH 09/10] Update spec/namespaces/cat.yaml Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index f5004984..8bd3b056 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1842,7 +1842,7 @@ components: cat.nodes::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' From b76fc2fb23fc7214131ac6c2f0edc3edd6f8678c Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 23 Dec 2024 15:12:36 -0600 Subject: [PATCH 10/10] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- spec/namespaces/cat.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 8bd3b056..0ea69092 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1684,7 +1684,7 @@ components: cat.master::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' @@ -1712,7 +1712,7 @@ components: cat.nodeattrs::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' @@ -1788,7 +1788,7 @@ components: cat.nodes::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' @@ -1917,7 +1917,7 @@ components: cat.pending_tasks::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'