Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Point CAT API descriptions to shared schema when applicable. #804

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions spec/namespaces/cat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1063,16 +1063,14 @@ components:
parameters:
cat.aliases::path.name:
in: path
name: name
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
name: name
required: true
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Names'
style: simple
cat.aliases::query.expand_wildcards:
in: query
name: expand_wildcards
description: Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
style: form
Expand Down Expand Up @@ -1544,7 +1542,6 @@ components:
cat.indices::query.expand_wildcards:
in: query
name: expand_wildcards
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
style: form
Expand Down Expand Up @@ -2288,7 +2285,6 @@ components:
cat.segment_replication::query.expand_wildcards:
name: expand_wildcards
in: query
description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
cat.segment_replication::query.format:
Expand Down Expand Up @@ -2470,10 +2466,6 @@ components:
cat.shards::path.index:
in: path
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`.
required: true
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Indices'
Expand Down Expand Up @@ -2549,7 +2541,6 @@ components:
cat.shards::query.time:
name: time
in: query
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:
Expand Down
6 changes: 6 additions & 0 deletions spec/schemas/_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,10 @@ components:
- type: string
- $ref: '#/components/schemas/EpochTimeUnitMillis'
Indices:
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`.
oneOf:
- $ref: '#/components/schemas/IndexName'
- type: array
Expand Down Expand Up @@ -806,6 +810,7 @@ components:
required:
- found
Names:
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
oneOf:
- $ref: '#/components/schemas/Name'
- type: array
Expand Down Expand Up @@ -888,6 +893,7 @@ components:
description: Time of day, expressed as HH:MM:SS.
type: string
TimeUnit:
description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/).
oneOf:
- title: nanoseconds
type: string
Expand Down
Loading