Skip to content

[DOCS] Clean up more duplicated enum values #4458

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
10 changes: 9 additions & 1 deletion docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,12 @@ actions:
- target: "$.components['schemas']['_types.aggregations.RandomSamplerAggregation']"
description: Add x-model
update:
x-model: true
x-model: true
# Remove long lists of enum values
- target: "$.components['schemas']['cat._types.CatNodeColumn'].anyOf"
description: Remove anyOf from cat nodes
remove: true
- target: "$.components['schemas']['cat._types.CatNodeColumn']"
description: Add basic string data type for cat node columns
update:
type: string
14 changes: 13 additions & 1 deletion docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1090,5 +1090,17 @@ actions:
- $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml"
# Remove long lists of enum values
- target: "$.components['schemas']['cat._types.CatAnomalyDetectorColumn'].enum"
description: Remove enum array
description: Remove enum array from cat detectors
remove: true
- target: "$.components['schemas']['cat._types.CatDfaColumn'].enum"
description: Remove enum array from cat data frame analytics
remove: true
- target: "$.components['schemas']['cat._types.CatDatafeedColumn'].enum"
description: Remove enum array from cat datafeeds
remove: true
- target: "$.components['schemas']['cat._types.CatTrainedModelsColumn'].enum"
description: Remove enum array from cat trained models
remove: true
- target: "$.components['schemas']['cat._types.CatTransformColumn'].enum"
description: Remove enum array from cat transforms
remove: true
52 changes: 26 additions & 26 deletions output/openapi/elasticsearch-openapi.json

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions output/openapi/elasticsearch-serverless-openapi.json

Large diffs are not rendered by default.

102 changes: 51 additions & 51 deletions output/schema/schema.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export interface Request extends RequestBase {
/**
* The type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* It supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* It supports comma-separated values, such as `open,hidden`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/_global/search_shards/SearchShardsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ export interface Request extends RequestBase {
* The type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
*/
expand_wildcards?: ExpandWildcards
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,6 @@ export interface Request extends RequestBase {
* The type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* It supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
*/
expand_wildcards?: ExpandWildcards
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/close/CloseIndexRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/delete/IndicesDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/exists/IndicesExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/flush/IndicesFlushRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/get_alias/IndicesGetAliasRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export interface Request extends RequestBase {
/**
* Type of data stream that wildcard patterns can match.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ export interface Request extends RequestBase {
/**
* Type of data stream that wildcard patterns can match.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/open/IndicesOpenRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export interface Request extends RequestBase {
/**
* Type of data stream that wildcard patterns can match.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `hidden`, `open`, `closed`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ export interface Request extends RequestBase {
/**
* Type of data stream that wildcard patterns can match.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `hidden`, `open`, `closed`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/refresh/IndicesRefreshRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
* options to the `_resolve/cluster` API endpoint that takes no index expression.
* @server_default open
Expand Down
1 change: 0 additions & 1 deletion specification/indices/resolve_index/ResolveIndexRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
1 change: 0 additions & 1 deletion specification/indices/segments/IndicesSegmentsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ export interface Request extends RequestBase {
* Type of index that wildcard patterns can match.
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
* Supports comma-separated values, such as `open,hidden`.
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
8 changes: 1 addition & 7 deletions specification/ml/put_job/MlPutJobRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,7 @@ export interface Request extends RequestBase {
allow_no_indices?: boolean
/**
* Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
* whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:
*
* * `all`: Match any data stream or index, including hidden ones.
* * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* * `none`: Wildcard patterns are not accepted.
* * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.
* whether wildcard expressions match hidden data streams. Supports comma-separated values.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,7 @@ export interface Request extends RequestBase {
allow_no_indices?: boolean
/**
* Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
* whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:
*
* * `all`: Match any data stream or index, including hidden ones.
* * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
* * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
* * `none`: Wildcard patterns are not accepted.
* * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.
* whether wildcard expressions match hidden data streams. Supports comma-separated values.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down