Skip to content

Commit 38951da

Browse files
authored
Point CAT API descriptions to shared schema when applicable. (#804)
Signed-off-by: Archer <[email protected]>
1 parent 9e75335 commit 38951da

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

spec/namespaces/cat.yaml

+1-10
Original file line numberDiff line numberDiff line change
@@ -1063,16 +1063,14 @@ components:
10631063
parameters:
10641064
cat.aliases::path.name:
10651065
in: path
1066-
name: name
1067-
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
1066+
name: name
10681067
required: true
10691068
schema:
10701069
$ref: '../schemas/_common.yaml#/components/schemas/Names'
10711070
style: simple
10721071
cat.aliases::query.expand_wildcards:
10731072
in: query
10741073
name: expand_wildcards
1075-
description: Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
10761074
schema:
10771075
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
10781076
style: form
@@ -1544,7 +1542,6 @@ components:
15441542
cat.indices::query.expand_wildcards:
15451543
in: query
15461544
name: expand_wildcards
1547-
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
15481545
schema:
15491546
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
15501547
style: form
@@ -2288,7 +2285,6 @@ components:
22882285
cat.segment_replication::query.expand_wildcards:
22892286
name: expand_wildcards
22902287
in: query
2291-
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
22922288
schema:
22932289
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
22942290
cat.segment_replication::query.format:
@@ -2470,10 +2466,6 @@ components:
24702466
cat.shards::path.index:
24712467
in: path
24722468
name: index
2473-
description: |-
2474-
A comma-separated list of data streams, indexes, and aliases used to limit the request.
2475-
Supports wildcards (`*`).
2476-
To target all data streams and indexes, omit this parameter or use `*` or `_all`.
24772469
required: true
24782470
schema:
24792471
$ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -2549,7 +2541,6 @@ components:
25492541
cat.shards::query.time:
25502542
name: time
25512543
in: query
2552-
description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
25532544
schema:
25542545
$ref: '../schemas/_common.yaml#/components/schemas/TimeUnit'
25552546
cat.shards::query.v:

spec/schemas/_common.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,10 @@ components:
404404
- type: string
405405
- $ref: '#/components/schemas/EpochTimeUnitMillis'
406406
Indices:
407+
description: |-
408+
A comma-separated list of data streams, indexes, and aliases used to limit the request.
409+
Supports wildcards (`*`).
410+
To target all data streams and indexes, omit this parameter or use `*` or `_all`.
407411
oneOf:
408412
- $ref: '#/components/schemas/IndexName'
409413
- type: array
@@ -806,6 +810,7 @@ components:
806810
required:
807811
- found
808812
Names:
813+
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
809814
oneOf:
810815
- $ref: '#/components/schemas/Name'
811816
- type: array
@@ -888,6 +893,7 @@ components:
888893
description: Time of day, expressed as HH:MM:SS.
889894
type: string
890895
TimeUnit:
896+
description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
891897
oneOf:
892898
- title: nanoseconds
893899
type: string

0 commit comments

Comments
 (0)