From e357988609266813f64ad5b11ce30dbd7a8f4d93 Mon Sep 17 00:00:00 2001 From: David Turner Date: Tue, 16 Sep 2025 14:11:43 +0100 Subject: [PATCH 1/8] Add common cat API parameters for unit rendering Describes the `?bytes=`, `?size=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. --- specification/_spec_utils/behaviors.ts | 22 +++++++++++++++++++ .../cat/allocation/CatAllocationRequest.ts | 2 -- .../cat/fielddata/CatFielddataRequest.ts | 2 -- specification/cat/health/CatHealthRequest.ts | 4 ---- .../cat/indices/CatIndicesRequest.ts | 4 ---- .../CatDataFrameAnalyticsRequest.ts | 5 ----- .../cat/ml_datafeeds/CatDatafeedsRequest.ts | 4 ---- specification/cat/ml_jobs/CatJobsRequest.ts | 8 ------- .../CatTrainedModelsRequest.ts | 6 ----- specification/cat/nodes/CatNodesRequest.ts | 8 ------- .../pending_tasks/CatPendingTasksRequest.ts | 4 ---- .../cat/recovery/CatRecoveryRequest.ts | 8 ------- .../cat/segments/CatSegmentsRequest.ts | 4 ---- specification/cat/shards/CatShardsRequest.ts | 8 ------- .../cat/snapshots/CatSnapshotsRequest.ts | 4 ---- specification/cat/tasks/CatTasksRequest.ts | 4 ---- .../cat/thread_pool/CatThreadPoolRequest.ts | 4 ---- .../cat/transforms/CatTransformsRequest.ts | 4 ---- .../delete_node/ShutdownDeleteNodeRequest.ts | 4 ++-- .../get_node/ShutdownGetNodeRequest.ts | 2 +- .../put_node/ShutdownPutNodeRequest.ts | 4 ++-- 21 files changed, 27 insertions(+), 88 deletions(-) diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index 2ca26df4db..b4417c2b8c 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -97,6 +97,28 @@ export interface CommonCatQueryParameters { * @server_default false */ v?: boolean + /** + * Sets the units for columns that contain a byte-size value. + * Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + * If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + * If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + * Values that are not an exact multiple of the chosen unit are rounded down. + */ + bytes?: Bytes + /** + * Sets the units for columns that contain a size value which is not a byte-size value. + * If omitted, size values are rendered with a suffix such as `k`, `m`, or `g`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + * If given, size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + * Values that are not an exact multiple of the chosen unit are rounded down. + */ + size?: '' | 'k' | 'm' | 'g' | 't' | 'p' + /** + * Sets the units for columns that contain a time duration. + * If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + * If given, time duration values are rendered as an integer with no suffix. + * Values that are not an exact multiple of the chosen unit are rounded down. + */ + time?: TimeUnit } /** diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index 0bec053b71..8827d284da 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -49,8 +49,6 @@ export interface Request extends CatRequestBase { node_id?: NodeIds } query_parameters: { - /** The unit used to display byte values. */ - bytes?: Bytes /** * A comma-separated list of columns names to display. It supports simple wildcards. */ diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts index c88438f3a7..e7bd558750 100644 --- a/specification/cat/fielddata/CatFielddataRequest.ts +++ b/specification/cat/fielddata/CatFielddataRequest.ts @@ -52,8 +52,6 @@ export interface Request extends CatRequestBase { fields?: Fields } query_parameters: { - /** The unit used to display byte values. */ - bytes?: Bytes /** Comma-separated list of fields used to limit returned information. */ fields?: Fields /** diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index 8d5b200b90..6ac7011b08 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -47,10 +47,6 @@ export interface Request extends CatRequestBase { } ] query_parameters: { - /** - * The unit used to display time values. - */ - time?: TimeUnit /** * If true, returns `HH:MM:SS` and Unix epoch timestamps. * @server_default true diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 3604be33da..caaebf1b21 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -70,8 +70,6 @@ export interface Request extends CatRequestBase { index?: Indices } query_parameters: { - /** The unit used to display byte values. */ - bytes?: Bytes /** * The type of index that wildcard patterns can match. */ @@ -88,8 +86,6 @@ export interface Request extends CatRequestBase { * @server_default false */ pri?: boolean - /** The unit used to display time values. */ - time?: TimeUnit /** * Period to wait for a connection to the master node. * @server_default 30s diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index 0493849437..0293596acd 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -52,7 +52,6 @@ export interface Request extends CatRequestBase { } query_parameters: { allow_no_match?: boolean - bytes?: Bytes /** * Comma-separated list of column names to display. * @server_default create_time,id,state,type @@ -62,9 +61,5 @@ export interface Request extends CatRequestBase { * response. */ s?: CatDfaColumns - /** - * Unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts index a52925c415..77fa6fc93f 100644 --- a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts +++ b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts @@ -77,9 +77,5 @@ export interface Request extends CatRequestBase { h?: CatDatafeedColumns /** Comma-separated list of column names or column aliases used to sort the response. */ s?: CatDatafeedColumns - /** - * The unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/ml_jobs/CatJobsRequest.ts b/specification/cat/ml_jobs/CatJobsRequest.ts index e9c0eb1344..8c2e25f468 100644 --- a/specification/cat/ml_jobs/CatJobsRequest.ts +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -70,10 +70,6 @@ export interface Request extends CatRequestBase { * @server_default true */ allow_no_match?: boolean - /** - * The unit used to display byte values. - */ - bytes?: Bytes /** * Comma-separated list of column names to display. * @server_default buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state @@ -81,9 +77,5 @@ export interface Request extends CatRequestBase { h?: CatAnomalyDetectorColumns /** Comma-separated list of column names or column aliases used to sort the response. */ s?: CatAnomalyDetectorColumns - /** - * The unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index 1d6b2635ea..71db8a8886 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -62,8 +62,6 @@ export interface Request extends CatRequestBase { * @server_default true */ allow_no_match?: boolean - /** The unit used to display byte values. */ - bytes?: Bytes /** A comma-separated list of column names to display. */ h?: CatTrainedModelsColumns /** A comma-separated list of column names or aliases used to sort the response. */ @@ -72,9 +70,5 @@ export interface Request extends CatRequestBase { from?: integer /** The maximum number of transforms to display. */ size?: integer - /** - * Unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts index 4118521222..978d38a7a0 100644 --- a/specification/cat/nodes/CatNodesRequest.ts +++ b/specification/cat/nodes/CatNodesRequest.ts @@ -40,10 +40,6 @@ export interface Request extends CatRequestBase { } ] query_parameters: { - /** - * The unit used to display byte values. - */ - bytes?: Bytes /** * If `true`, return the full node ID. If `false`, return the shortened node ID. * @server_default false @@ -71,9 +67,5 @@ export interface Request extends CatRequestBase { * @server_default 30s */ master_timeout?: Duration - /** - * The unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index b49dd64921..5be17b27c0 100644 --- a/specification/cat/pending_tasks/CatPendingTasksRequest.ts +++ b/specification/cat/pending_tasks/CatPendingTasksRequest.ts @@ -63,9 +63,5 @@ export interface Request extends CatRequestBase { * @server_default 30s */ master_timeout?: Duration - /** - * Unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index 6ee0ebb8c5..9182ef9990 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -59,10 +59,6 @@ export interface Request extends CatRequestBase { * @server_default false */ active_only?: boolean - /** - * The unit used to display byte values. - */ - bytes?: Bytes /** * If `true`, the response includes detailed information about shard recoveries. * @server_default false @@ -84,9 +80,5 @@ export interface Request extends CatRequestBase { * or `:desc` as a suffix to the column name. */ s?: Names - /** - * The unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts index 9bdb64e5c0..51ff9a18c1 100644 --- a/specification/cat/segments/CatSegmentsRequest.ts +++ b/specification/cat/segments/CatSegmentsRequest.ts @@ -54,10 +54,6 @@ export interface Request extends CatRequestBase { index?: Indices } query_parameters: { - /** - * The unit used to display byte values. - */ - bytes?: Bytes /** * A comma-separated list of columns names to display. * It supports simple wildcards. diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts index dd3aa69801..213f867c81 100644 --- a/specification/cat/shards/CatShardsRequest.ts +++ b/specification/cat/shards/CatShardsRequest.ts @@ -54,10 +54,6 @@ export interface Request extends CatRequestBase { index?: Indices } query_parameters: { - /** - * The unit used to display byte values. - */ - bytes?: Bytes /** * List of columns to appear in the response. Supports simple wildcards. */ @@ -73,9 +69,5 @@ export interface Request extends CatRequestBase { * @server_default 30s */ master_timeout?: Duration - /** - * The unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts index 7d0461353e..b1e456ea2b 100644 --- a/specification/cat/snapshots/CatSnapshotsRequest.ts +++ b/specification/cat/snapshots/CatSnapshotsRequest.ts @@ -76,9 +76,5 @@ export interface Request extends CatRequestBase { * @server_default 30s */ master_timeout?: Duration - /** - * Unit used to display time values. - */ - time?: TimeUnit } } diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index b9ef1df77f..87c90a8ba7 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -63,10 +63,6 @@ export interface Request extends CatRequestBase { * or `:desc` as a suffix to the column name. */ s?: Names - /** - * Unit used to display time values. - */ - time?: TimeUnit /** * Period to wait for a response. * If no response is received before the timeout expires, the request fails and returns an error. diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts index 6acf6b5f3d..08066d409b 100644 --- a/specification/cat/thread_pool/CatThreadPoolRequest.ts +++ b/specification/cat/thread_pool/CatThreadPoolRequest.ts @@ -62,10 +62,6 @@ export interface Request extends CatRequestBase { * or `:desc` as a suffix to the column name. */ s?: Names - /** - * The unit used to display time values. - */ - time?: TimeUnit /** * If `true`, the request computes the list of selected nodes from the * local cluster state. If `false` the list of selected nodes are computed diff --git a/specification/cat/transforms/CatTransformsRequest.ts b/specification/cat/transforms/CatTransformsRequest.ts index f4e9bcbdfb..109a17b4d7 100644 --- a/specification/cat/transforms/CatTransformsRequest.ts +++ b/specification/cat/transforms/CatTransformsRequest.ts @@ -76,10 +76,6 @@ export interface Request extends CatRequestBase { /** Comma-separated list of column names or column aliases used to sort the response. */ s?: CatTransformColumns - /** - * The unit used to display time values. - */ - time?: TimeUnit /** * The maximum number of transforms to obtain. * @server_default 100 diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index bcd8c633c6..a65f049406 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -51,11 +51,11 @@ export interface Request extends RequestBase { * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ - master_timeout?: TimeUnit + master_timeout?: Duration /** * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ - timeout?: TimeUnit + timeout?: Duration } } diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index 46ba2dc1a9..1618562d44 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -54,6 +54,6 @@ export interface Request extends RequestBase { * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ - master_timeout?: TimeUnit + master_timeout?: Duration } } diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index 12cee1aba8..e5e098af7b 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -66,13 +66,13 @@ export interface Request extends RequestBase { * If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ - master_timeout?: TimeUnit + master_timeout?: Duration /** * The period to wait for a response. * If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ - timeout?: TimeUnit + timeout?: Duration } body: { /** From 250c1f7d3a18b91478ffe1f59c5738629029910f Mon Sep 17 00:00:00 2001 From: David Turner Date: Tue, 16 Sep 2025 16:09:01 +0100 Subject: [PATCH 2/8] Missing imports --- specification/_spec_utils/behaviors.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index b4417c2b8c..8062c007d1 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -17,6 +17,9 @@ * under the License. */ +import { Bytes } from '@_types/common' +import { TimeUnit } from '@_types/Time' + /** * In some places in the specification an object consists of the union of a set of known properties * and a set of runtime injected properties. Meaning that object should theoretically extend Dictionary but expose From 23eb76f75fe04adbf06dca2b0c3fee35919a9ced Mon Sep 17 00:00:00 2001 From: David Turner Date: Tue, 16 Sep 2025 16:14:52 +0100 Subject: [PATCH 3/8] Clean up imports --- specification/cat/allocation/CatAllocationRequest.ts | 2 +- specification/cat/fielddata/CatFielddataRequest.ts | 2 +- specification/cat/health/CatHealthRequest.ts | 1 - specification/cat/indices/CatIndicesRequest.ts | 2 +- .../ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts | 3 +-- specification/cat/ml_datafeeds/CatDatafeedsRequest.ts | 1 - specification/cat/ml_jobs/CatJobsRequest.ts | 3 +-- .../cat/ml_trained_models/CatTrainedModelsRequest.ts | 3 +-- specification/cat/nodes/CatNodesRequest.ts | 4 ++-- specification/cat/pending_tasks/CatPendingTasksRequest.ts | 2 +- specification/cat/recovery/CatRecoveryRequest.ts | 3 +-- specification/cat/segments/CatSegmentsRequest.ts | 2 +- specification/cat/shards/CatShardsRequest.ts | 4 ++-- specification/cat/snapshots/CatSnapshotsRequest.ts | 2 +- specification/cat/tasks/CatTasksRequest.ts | 2 +- specification/cat/thread_pool/CatThreadPoolRequest.ts | 2 +- specification/cat/transforms/CatTransformsRequest.ts | 1 - .../shutdown/delete_node/ShutdownDeleteNodeRequest.ts | 1 - specification/shutdown/get_node/ShutdownGetNodeRequest.ts | 1 - specification/shutdown/put_node/ShutdownPutNodeRequest.ts | 1 - 20 files changed, 16 insertions(+), 26 deletions(-) diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index 8827d284da..559ab8f238 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -17,7 +17,7 @@ * under the License. */ -import { Bytes, Names, NodeIds } from '@_types/common' +import { Names, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' import { CatAllocationColumns, CatRequestBase } from '@cat/_types/CatBase' diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts index e7bd558750..5cf2f58b39 100644 --- a/specification/cat/fielddata/CatFielddataRequest.ts +++ b/specification/cat/fielddata/CatFielddataRequest.ts @@ -17,7 +17,7 @@ * under the License. */ -import { Bytes, Fields, Names } from '@_types/common' +import { Fields, Names } from '@_types/common' import { CatFieldDataColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/health/CatHealthRequest.ts b/specification/cat/health/CatHealthRequest.ts index 6ac7011b08..e2d25331ee 100644 --- a/specification/cat/health/CatHealthRequest.ts +++ b/specification/cat/health/CatHealthRequest.ts @@ -18,7 +18,6 @@ */ import { Names } from '@_types/common' -import { TimeUnit } from '@_types/Time' import { CatHealthColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index caaebf1b21..b2157777d6 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -24,7 +24,7 @@ import { Indices, Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Duration } from '@_types/Time' import { CatIndicesColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts index 0293596acd..fd2183fa6e 100644 --- a/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts +++ b/specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts @@ -17,8 +17,7 @@ * under the License. */ -import { Bytes, Id } from '@_types/common' -import { TimeUnit } from '@_types/Time' +import { Id } from '@_types/common' import { CatDfaColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts index 77fa6fc93f..c7628c2aa8 100644 --- a/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts +++ b/specification/cat/ml_datafeeds/CatDatafeedsRequest.ts @@ -18,7 +18,6 @@ */ import { Id } from '@_types/common' -import { TimeUnit } from '@_types/Time' import { CatDatafeedColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/ml_jobs/CatJobsRequest.ts b/specification/cat/ml_jobs/CatJobsRequest.ts index 8c2e25f468..34e4d543fc 100644 --- a/specification/cat/ml_jobs/CatJobsRequest.ts +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -17,8 +17,7 @@ * under the License. */ -import { Bytes, Id } from '@_types/common' -import { TimeUnit } from '@_types/Time' +import { Id } from '@_types/common' import { CatAnomalyDetectorColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts index 71db8a8886..a91198199e 100644 --- a/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts +++ b/specification/cat/ml_trained_models/CatTrainedModelsRequest.ts @@ -17,9 +17,8 @@ * under the License. */ -import { Bytes, Id } from '@_types/common' +import { Id } from '@_types/common' import { integer } from '@_types/Numeric' -import { TimeUnit } from '@_types/Time' import { CatRequestBase, CatTrainedModelsColumns } from '@cat/_types/CatBase' /** diff --git a/specification/cat/nodes/CatNodesRequest.ts b/specification/cat/nodes/CatNodesRequest.ts index 978d38a7a0..86a1905270 100644 --- a/specification/cat/nodes/CatNodesRequest.ts +++ b/specification/cat/nodes/CatNodesRequest.ts @@ -17,8 +17,8 @@ * under the License. */ -import { Bytes, Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Names } from '@_types/common' +import { Duration } from '@_types/Time' import { CatNodeColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/pending_tasks/CatPendingTasksRequest.ts b/specification/cat/pending_tasks/CatPendingTasksRequest.ts index 5be17b27c0..80eb0494b7 100644 --- a/specification/cat/pending_tasks/CatPendingTasksRequest.ts +++ b/specification/cat/pending_tasks/CatPendingTasksRequest.ts @@ -18,7 +18,7 @@ */ import { Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Duration } from '@_types/Time' import { CatPendingTasksColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/recovery/CatRecoveryRequest.ts b/specification/cat/recovery/CatRecoveryRequest.ts index 9182ef9990..0ffa203307 100644 --- a/specification/cat/recovery/CatRecoveryRequest.ts +++ b/specification/cat/recovery/CatRecoveryRequest.ts @@ -17,8 +17,7 @@ * under the License. */ -import { Bytes, Indices, Names } from '@_types/common' -import { TimeUnit } from '@_types/Time' +import { Indices, Names } from '@_types/common' import { CatRecoveryColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/cat/segments/CatSegmentsRequest.ts b/specification/cat/segments/CatSegmentsRequest.ts index 51ff9a18c1..d8d18f0858 100644 --- a/specification/cat/segments/CatSegmentsRequest.ts +++ b/specification/cat/segments/CatSegmentsRequest.ts @@ -17,7 +17,7 @@ * under the License. */ -import { Bytes, Indices, Names } from '@_types/common' +import { Indices, Names } from '@_types/common' import { Duration } from '@_types/Time' import { CatRequestBase, CatSegmentsColumns } from '@cat/_types/CatBase' diff --git a/specification/cat/shards/CatShardsRequest.ts b/specification/cat/shards/CatShardsRequest.ts index 213f867c81..2aef08af36 100644 --- a/specification/cat/shards/CatShardsRequest.ts +++ b/specification/cat/shards/CatShardsRequest.ts @@ -17,8 +17,8 @@ * under the License. */ -import { Bytes, Indices, Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Indices, Names } from '@_types/common' +import { Duration } from '@_types/Time' import { CatRequestBase, CatShardColumns } from '@cat/_types/CatBase' /** diff --git a/specification/cat/snapshots/CatSnapshotsRequest.ts b/specification/cat/snapshots/CatSnapshotsRequest.ts index b1e456ea2b..28f230f617 100644 --- a/specification/cat/snapshots/CatSnapshotsRequest.ts +++ b/specification/cat/snapshots/CatSnapshotsRequest.ts @@ -18,7 +18,7 @@ */ import { Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Duration } from '@_types/Time' import { CatRequestBase, CatSnapshotsColumns } from '@cat/_types/CatBase' /** diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index 87c90a8ba7..e956aed1d0 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -18,7 +18,7 @@ */ import { Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Duration } from '@_types/Time' import { CatRequestBase, CatTasksColumns } from '@cat/_types/CatBase' /** diff --git a/specification/cat/thread_pool/CatThreadPoolRequest.ts b/specification/cat/thread_pool/CatThreadPoolRequest.ts index 08066d409b..f83d447f53 100644 --- a/specification/cat/thread_pool/CatThreadPoolRequest.ts +++ b/specification/cat/thread_pool/CatThreadPoolRequest.ts @@ -18,7 +18,7 @@ */ import { Names } from '@_types/common' -import { Duration, TimeUnit } from '@_types/Time' +import { Duration } from '@_types/Time' import { CatRequestBase, CatThreadPoolColumns } from '@cat/_types/CatBase' /** diff --git a/specification/cat/transforms/CatTransformsRequest.ts b/specification/cat/transforms/CatTransformsRequest.ts index 109a17b4d7..5d8b01947c 100644 --- a/specification/cat/transforms/CatTransformsRequest.ts +++ b/specification/cat/transforms/CatTransformsRequest.ts @@ -19,7 +19,6 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' -import { TimeUnit } from '@_types/Time' import { CatRequestBase, CatTransformColumns } from '@cat/_types/CatBase' /** diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index a65f049406..c0f477df89 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -19,7 +19,6 @@ import { RequestBase } from '@_types/Base' import { NodeId } from '@_types/common' -import { TimeUnit } from '@_types/Time' /** * Cancel node shutdown preparations. diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index 1618562d44..08342bfe66 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -19,7 +19,6 @@ import { RequestBase } from '@_types/Base' import { NodeIds } from '@_types/common' -import { TimeUnit } from '@_types/Time' /** * Get the shutdown status. diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index e5e098af7b..ed9f14f312 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -19,7 +19,6 @@ import { RequestBase } from '@_types/Base' import { NodeId } from '@_types/common' -import { TimeUnit } from '@_types/Time' import { Type } from '../_types/types' /** From c0c9a7ddfa2a3614e13f8e1e4125cf5c9b74bde7 Mon Sep 17 00:00:00 2001 From: David Turner Date: Tue, 16 Sep 2025 16:19:09 +0100 Subject: [PATCH 4/8] Moar imports --- specification/cat/indices/CatIndicesRequest.ts | 1 - specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts | 1 + specification/shutdown/get_node/ShutdownGetNodeRequest.ts | 1 + specification/shutdown/put_node/ShutdownPutNodeRequest.ts | 1 + 4 files changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index b2157777d6..7a89664181 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -18,7 +18,6 @@ */ import { - Bytes, ExpandWildcards, HealthStatus, Indices, diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index c0f477df89..6828edce69 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -19,6 +19,7 @@ import { RequestBase } from '@_types/Base' import { NodeId } from '@_types/common' +import { Duration } from '@_types/Time' /** * Cancel node shutdown preparations. diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index 08342bfe66..811baaff50 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -19,6 +19,7 @@ import { RequestBase } from '@_types/Base' import { NodeIds } from '@_types/common' +import { Duration } from '@_types/Time' /** * Get the shutdown status. diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index ed9f14f312..fddf19e9f7 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -20,6 +20,7 @@ import { RequestBase } from '@_types/Base' import { NodeId } from '@_types/common' import { Type } from '../_types/types' +import { Duration } from '@_types/Time' /** * Prepare a node to be shut down. From b05beffc2e0dac55de055695719bf840f2c2879c Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Wed, 17 Sep 2025 10:30:45 +0400 Subject: [PATCH 5/8] Run make spec-format-fix --- specification/cat/indices/CatIndicesRequest.ts | 9 ++------- .../shutdown/put_node/ShutdownPutNodeRequest.ts | 2 +- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/specification/cat/indices/CatIndicesRequest.ts b/specification/cat/indices/CatIndicesRequest.ts index 7a89664181..f0f181d1b2 100644 --- a/specification/cat/indices/CatIndicesRequest.ts +++ b/specification/cat/indices/CatIndicesRequest.ts @@ -17,13 +17,8 @@ * under the License. */ -import { - ExpandWildcards, - HealthStatus, - Indices, - Names -} from '@_types/common' -import { Duration } from '@_types/Time' +import { ExpandWildcards, HealthStatus, Indices, Names } from '@_types/common' +import { Duration } from '@_types/Time' import { CatIndicesColumns, CatRequestBase } from '@cat/_types/CatBase' /** diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index fddf19e9f7..c178209373 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -19,8 +19,8 @@ import { RequestBase } from '@_types/Base' import { NodeId } from '@_types/common' -import { Type } from '../_types/types' import { Duration } from '@_types/Time' +import { Type } from '../_types/types' /** * Prepare a node to be shut down. From cedb1eaa1a6d109a57234475481a8d173ebcd596 Mon Sep 17 00:00:00 2001 From: David Turner Date: Wed, 17 Sep 2025 07:58:32 +0100 Subject: [PATCH 6/8] Drop unnecessary size param --- specification/_spec_utils/behaviors.ts | 7 ------- 1 file changed, 7 deletions(-) diff --git a/specification/_spec_utils/behaviors.ts b/specification/_spec_utils/behaviors.ts index 8062c007d1..d6542e6c41 100644 --- a/specification/_spec_utils/behaviors.ts +++ b/specification/_spec_utils/behaviors.ts @@ -108,13 +108,6 @@ export interface CommonCatQueryParameters { * Values that are not an exact multiple of the chosen unit are rounded down. */ bytes?: Bytes - /** - * Sets the units for columns that contain a size value which is not a byte-size value. - * If omitted, size values are rendered with a suffix such as `k`, `m`, or `g`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. - * If given, size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. - * Values that are not an exact multiple of the chosen unit are rounded down. - */ - size?: '' | 'k' | 'm' | 'g' | 't' | 'p' /** * Sets the units for columns that contain a time duration. * If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. From 2c0f5bc4b5ce09f5b89ca9ab52d66a2bb8abeb28 Mon Sep 17 00:00:00 2001 From: David Turner Date: Wed, 17 Sep 2025 08:13:19 +0100 Subject: [PATCH 7/8] make contrib --- output/openapi/elasticsearch-openapi.json | 377 ------------------ .../elasticsearch-serverless-openapi.json | 183 --------- output/schema/schema.json | 366 +++-------------- output/schema/validation-errors.json | 119 +++++- output/typescript/types.ts | 36 +- 5 files changed, 176 insertions(+), 905 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d57293d893..4245b1d855 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -865,9 +865,6 @@ "description": "Get a snapshot of the number of shards allocated to each data node and their disk space.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "cat-allocation", "parameters": [ - { - "$ref": "#/components/parameters/cat.allocation-bytes" - }, { "$ref": "#/components/parameters/cat.allocation-h" }, @@ -907,9 +904,6 @@ { "$ref": "#/components/parameters/cat.allocation-node_id" }, - { - "$ref": "#/components/parameters/cat.allocation-bytes" - }, { "$ref": "#/components/parameters/cat.allocation-h" }, @@ -1084,9 +1078,6 @@ "description": "Get the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "cat-fielddata", "parameters": [ - { - "$ref": "#/components/parameters/cat.fielddata-bytes" - }, { "$ref": "#/components/parameters/cat.fielddata-fields_" }, @@ -1123,9 +1114,6 @@ { "$ref": "#/components/parameters/cat.fielddata-fields" }, - { - "$ref": "#/components/parameters/cat.fielddata-bytes" - }, { "$ref": "#/components/parameters/cat.fielddata-fields_" }, @@ -1159,16 +1147,6 @@ "description": "IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "cat-health", "parameters": [ - { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, { "in": "query", "name": "ts", @@ -1268,9 +1246,6 @@ "description": "Get high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\n## Required authorization\n\n* Index privileges: `monitor`\n* Cluster privileges: `monitor`\n", "operationId": "cat-indices", "parameters": [ - { - "$ref": "#/components/parameters/cat.indices-bytes" - }, { "$ref": "#/components/parameters/cat.indices-expand_wildcards" }, @@ -1283,9 +1258,6 @@ { "$ref": "#/components/parameters/cat.indices-pri" }, - { - "$ref": "#/components/parameters/cat.indices-time" - }, { "$ref": "#/components/parameters/cat.indices-master_timeout" }, @@ -1322,9 +1294,6 @@ { "$ref": "#/components/parameters/cat.indices-index" }, - { - "$ref": "#/components/parameters/cat.indices-bytes" - }, { "$ref": "#/components/parameters/cat.indices-expand_wildcards" }, @@ -1337,9 +1306,6 @@ { "$ref": "#/components/parameters/cat.indices-pri" }, - { - "$ref": "#/components/parameters/cat.indices-time" - }, { "$ref": "#/components/parameters/cat.indices-master_timeout" }, @@ -1456,17 +1422,11 @@ { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-bytes" - }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-h" }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-s" - }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-time" } ], "responses": { @@ -1498,17 +1458,11 @@ { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-bytes" - }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-h" }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-s" - }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-time" } ], "responses": { @@ -1542,9 +1496,6 @@ }, { "$ref": "#/components/parameters/cat.ml_datafeeds-s" - }, - { - "$ref": "#/components/parameters/cat.ml_datafeeds-time" } ], "responses": { @@ -1581,9 +1532,6 @@ }, { "$ref": "#/components/parameters/cat.ml_datafeeds-s" - }, - { - "$ref": "#/components/parameters/cat.ml_datafeeds-time" } ], "responses": { @@ -1612,17 +1560,11 @@ { "$ref": "#/components/parameters/cat.ml_jobs-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_jobs-bytes" - }, { "$ref": "#/components/parameters/cat.ml_jobs-h" }, { "$ref": "#/components/parameters/cat.ml_jobs-s" - }, - { - "$ref": "#/components/parameters/cat.ml_jobs-time" } ], "responses": { @@ -1654,17 +1596,11 @@ { "$ref": "#/components/parameters/cat.ml_jobs-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_jobs-bytes" - }, { "$ref": "#/components/parameters/cat.ml_jobs-h" }, { "$ref": "#/components/parameters/cat.ml_jobs-s" - }, - { - "$ref": "#/components/parameters/cat.ml_jobs-time" } ], "responses": { @@ -1693,9 +1629,6 @@ { "$ref": "#/components/parameters/cat.ml_trained_models-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-bytes" - }, { "$ref": "#/components/parameters/cat.ml_trained_models-h" }, @@ -1707,9 +1640,6 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models-size" - }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-time" } ], "responses": { @@ -1741,9 +1671,6 @@ { "$ref": "#/components/parameters/cat.ml_trained_models-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-bytes" - }, { "$ref": "#/components/parameters/cat.ml_trained_models-h" }, @@ -1755,9 +1682,6 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models-size" - }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-time" } ], "responses": { @@ -1869,16 +1793,6 @@ "description": "Get information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "cat-nodes", "parameters": [ - { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, { "in": "query", "name": "full_id", @@ -1935,16 +1849,6 @@ "$ref": "#/components/schemas/_types.Duration" }, "style": "form" - }, - { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" } ], "responses": { @@ -2031,16 +1935,6 @@ "$ref": "#/components/schemas/_types.Duration" }, "style": "form" - }, - { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" } ], "responses": { @@ -2175,9 +2069,6 @@ { "$ref": "#/components/parameters/cat.recovery-active_only" }, - { - "$ref": "#/components/parameters/cat.recovery-bytes" - }, { "$ref": "#/components/parameters/cat.recovery-detailed" }, @@ -2189,9 +2080,6 @@ }, { "$ref": "#/components/parameters/cat.recovery-s" - }, - { - "$ref": "#/components/parameters/cat.recovery-time" } ], "responses": { @@ -2223,9 +2111,6 @@ { "$ref": "#/components/parameters/cat.recovery-active_only" }, - { - "$ref": "#/components/parameters/cat.recovery-bytes" - }, { "$ref": "#/components/parameters/cat.recovery-detailed" }, @@ -2237,9 +2122,6 @@ }, { "$ref": "#/components/parameters/cat.recovery-s" - }, - { - "$ref": "#/components/parameters/cat.recovery-time" } ], "responses": { @@ -2345,9 +2227,6 @@ "description": "Get low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.\n\n## Required authorization\n\n* Index privileges: `monitor`\n* Cluster privileges: `monitor`\n", "operationId": "cat-segments", "parameters": [ - { - "$ref": "#/components/parameters/cat.segments-bytes" - }, { "$ref": "#/components/parameters/cat.segments-h" }, @@ -2387,9 +2266,6 @@ { "$ref": "#/components/parameters/cat.segments-index" }, - { - "$ref": "#/components/parameters/cat.segments-bytes" - }, { "$ref": "#/components/parameters/cat.segments-h" }, @@ -2426,9 +2302,6 @@ "description": "Get information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.\n\n## Required authorization\n\n* Index privileges: `monitor`\n* Cluster privileges: `monitor`\n", "operationId": "cat-shards", "parameters": [ - { - "$ref": "#/components/parameters/cat.shards-bytes" - }, { "$ref": "#/components/parameters/cat.shards-h" }, @@ -2437,9 +2310,6 @@ }, { "$ref": "#/components/parameters/cat.shards-master_timeout" - }, - { - "$ref": "#/components/parameters/cat.shards-time" } ], "responses": { @@ -2468,9 +2338,6 @@ { "$ref": "#/components/parameters/cat.shards-index" }, - { - "$ref": "#/components/parameters/cat.shards-bytes" - }, { "$ref": "#/components/parameters/cat.shards-h" }, @@ -2479,9 +2346,6 @@ }, { "$ref": "#/components/parameters/cat.shards-master_timeout" - }, - { - "$ref": "#/components/parameters/cat.shards-time" } ], "responses": { @@ -2518,9 +2382,6 @@ }, { "$ref": "#/components/parameters/cat.snapshots-master_timeout" - }, - { - "$ref": "#/components/parameters/cat.snapshots-time" } ], "responses": { @@ -2560,9 +2421,6 @@ }, { "$ref": "#/components/parameters/cat.snapshots-master_timeout" - }, - { - "$ref": "#/components/parameters/cat.snapshots-time" } ], "responses": { @@ -2654,16 +2512,6 @@ }, "style": "form" }, - { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, { "in": "query", "name": "timeout", @@ -2805,9 +2653,6 @@ { "$ref": "#/components/parameters/cat.thread_pool-s" }, - { - "$ref": "#/components/parameters/cat.thread_pool-time" - }, { "$ref": "#/components/parameters/cat.thread_pool-local" }, @@ -2847,9 +2692,6 @@ { "$ref": "#/components/parameters/cat.thread_pool-s" }, - { - "$ref": "#/components/parameters/cat.thread_pool-time" - }, { "$ref": "#/components/parameters/cat.thread_pool-local" }, @@ -2892,9 +2734,6 @@ { "$ref": "#/components/parameters/cat.transforms-s" }, - { - "$ref": "#/components/parameters/cat.transforms-time" - }, { "$ref": "#/components/parameters/cat.transforms-size" } @@ -2937,9 +2776,6 @@ { "$ref": "#/components/parameters/cat.transforms-s" }, - { - "$ref": "#/components/parameters/cat.transforms-time" - }, { "$ref": "#/components/parameters/cat.transforms-size" } @@ -71296,17 +71132,6 @@ } ] }, - "_types.Bytes": { - "type": "string", - "enum": [ - "b", - "kb", - "mb", - "gb", - "tb", - "pb" - ] - }, "cat._types.CatAllocationColumns": { "oneOf": [ { @@ -71780,18 +71605,6 @@ } } }, - "_types.TimeUnit": { - "type": "string", - "enum": [ - "nanos", - "micros", - "ms", - "s", - "m", - "h", - "d" - ] - }, "cat._types.CatHealthColumns": { "oneOf": [ { @@ -136003,16 +135816,6 @@ }, "style": "simple" }, - "cat.allocation-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.allocation-h": { "in": "query", "name": "h", @@ -136146,16 +135949,6 @@ }, "style": "simple" }, - "cat.fielddata-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.fielddata-fields_": { "in": "query", "name": "fields", @@ -136197,16 +135990,6 @@ }, "style": "simple" }, - "cat.indices-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.indices-expand_wildcards": { "in": "query", "name": "expand_wildcards", @@ -136247,16 +136030,6 @@ }, "style": "form" }, - "cat.indices-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.indices-master_timeout": { "in": "query", "name": "master_timeout", @@ -136308,16 +136081,6 @@ }, "style": "form" }, - "cat.ml_data_frame_analytics-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit in which to display byte values", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_data_frame_analytics-h": { "in": "query", "name": "h", @@ -136338,16 +136101,6 @@ }, "style": "form" }, - "cat.ml_data_frame_analytics-time": { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_datafeeds-datafeed_id": { "in": "path", "name": "datafeed_id", @@ -136389,16 +136142,6 @@ }, "style": "form" }, - "cat.ml_datafeeds-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_jobs-job_id": { "in": "path", "name": "job_id", @@ -136420,16 +136163,6 @@ }, "style": "form" }, - "cat.ml_jobs-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_jobs-h": { "in": "query", "name": "h", @@ -136450,16 +136183,6 @@ }, "style": "form" }, - "cat.ml_jobs-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_trained_models-model_id": { "in": "path", "name": "model_id", @@ -136481,16 +136204,6 @@ }, "style": "form" }, - "cat.ml_trained_models-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_trained_models-h": { "in": "query", "name": "h", @@ -136531,16 +136244,6 @@ }, "style": "form" }, - "cat.ml_trained_models-time": { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.recovery-index": { "in": "path", "name": "index", @@ -136562,16 +136265,6 @@ }, "style": "form" }, - "cat.recovery-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.recovery-detailed": { "in": "query", "name": "detailed", @@ -136612,16 +136305,6 @@ }, "style": "form" }, - "cat.recovery-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.segments-index": { "in": "path", "name": "index", @@ -136633,16 +136316,6 @@ }, "style": "simple" }, - "cat.segments-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.segments-h": { "in": "query", "name": "h", @@ -136694,16 +136367,6 @@ }, "style": "simple" }, - "cat.shards-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.shards-h": { "in": "query", "name": "h", @@ -136734,16 +136397,6 @@ }, "style": "form" }, - "cat.shards-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.snapshots-repository": { "in": "path", "name": "repository", @@ -136795,16 +136448,6 @@ }, "style": "form" }, - "cat.snapshots-time": { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.templates-name": { "in": "path", "name": "name", @@ -136887,16 +136530,6 @@ }, "style": "form" }, - "cat.thread_pool-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.thread_pool-local": { "in": "query", "name": "local", @@ -136968,16 +136601,6 @@ }, "style": "form" }, - "cat.transforms-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.transforms-size": { "in": "query", "name": "size", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 52abddffe1..aa7653efe9 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1032,9 +1032,6 @@ "description": "Get high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.\n\n## Required authorization\n\n* Index privileges: `monitor`\n* Cluster privileges: `monitor`\n", "operationId": "cat-indices", "parameters": [ - { - "$ref": "#/components/parameters/cat.indices-bytes" - }, { "$ref": "#/components/parameters/cat.indices-expand_wildcards" }, @@ -1047,9 +1044,6 @@ { "$ref": "#/components/parameters/cat.indices-pri" }, - { - "$ref": "#/components/parameters/cat.indices-time" - }, { "$ref": "#/components/parameters/cat.indices-master_timeout" }, @@ -1086,9 +1080,6 @@ { "$ref": "#/components/parameters/cat.indices-index" }, - { - "$ref": "#/components/parameters/cat.indices-bytes" - }, { "$ref": "#/components/parameters/cat.indices-expand_wildcards" }, @@ -1101,9 +1092,6 @@ { "$ref": "#/components/parameters/cat.indices-pri" }, - { - "$ref": "#/components/parameters/cat.indices-time" - }, { "$ref": "#/components/parameters/cat.indices-master_timeout" }, @@ -1140,17 +1128,11 @@ { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-bytes" - }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-h" }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-s" - }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-time" } ], "responses": { @@ -1182,17 +1164,11 @@ { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-bytes" - }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-h" }, { "$ref": "#/components/parameters/cat.ml_data_frame_analytics-s" - }, - { - "$ref": "#/components/parameters/cat.ml_data_frame_analytics-time" } ], "responses": { @@ -1226,9 +1202,6 @@ }, { "$ref": "#/components/parameters/cat.ml_datafeeds-s" - }, - { - "$ref": "#/components/parameters/cat.ml_datafeeds-time" } ], "responses": { @@ -1265,9 +1238,6 @@ }, { "$ref": "#/components/parameters/cat.ml_datafeeds-s" - }, - { - "$ref": "#/components/parameters/cat.ml_datafeeds-time" } ], "responses": { @@ -1296,17 +1266,11 @@ { "$ref": "#/components/parameters/cat.ml_jobs-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_jobs-bytes" - }, { "$ref": "#/components/parameters/cat.ml_jobs-h" }, { "$ref": "#/components/parameters/cat.ml_jobs-s" - }, - { - "$ref": "#/components/parameters/cat.ml_jobs-time" } ], "responses": { @@ -1338,17 +1302,11 @@ { "$ref": "#/components/parameters/cat.ml_jobs-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_jobs-bytes" - }, { "$ref": "#/components/parameters/cat.ml_jobs-h" }, { "$ref": "#/components/parameters/cat.ml_jobs-s" - }, - { - "$ref": "#/components/parameters/cat.ml_jobs-time" } ], "responses": { @@ -1377,9 +1335,6 @@ { "$ref": "#/components/parameters/cat.ml_trained_models-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-bytes" - }, { "$ref": "#/components/parameters/cat.ml_trained_models-h" }, @@ -1391,9 +1346,6 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models-size" - }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-time" } ], "responses": { @@ -1425,9 +1377,6 @@ { "$ref": "#/components/parameters/cat.ml_trained_models-allow_no_match" }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-bytes" - }, { "$ref": "#/components/parameters/cat.ml_trained_models-h" }, @@ -1439,9 +1388,6 @@ }, { "$ref": "#/components/parameters/cat.ml_trained_models-size" - }, - { - "$ref": "#/components/parameters/cat.ml_trained_models-time" } ], "responses": { @@ -1479,9 +1425,6 @@ { "$ref": "#/components/parameters/cat.transforms-s" }, - { - "$ref": "#/components/parameters/cat.transforms-time" - }, { "$ref": "#/components/parameters/cat.transforms-size" } @@ -1524,9 +1467,6 @@ { "$ref": "#/components/parameters/cat.transforms-s" }, - { - "$ref": "#/components/parameters/cat.transforms-time" - }, { "$ref": "#/components/parameters/cat.transforms-size" } @@ -47565,17 +47505,6 @@ "description": "Time of day, expressed as HH:MM:SS", "type": "string" }, - "_types.Bytes": { - "type": "string", - "enum": [ - "b", - "kb", - "mb", - "gb", - "tb", - "pb" - ] - }, "_types.HealthStatus": { "type": "string", "enum": [ @@ -47589,18 +47518,6 @@ "unavailable" ] }, - "_types.TimeUnit": { - "type": "string", - "enum": [ - "nanos", - "micros", - "ms", - "s", - "m", - "h", - "d" - ] - }, "cat._types.CatIndicesColumns": { "oneOf": [ { @@ -83465,16 +83382,6 @@ }, "style": "simple" }, - "cat.indices-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.indices-expand_wildcards": { "in": "query", "name": "expand_wildcards", @@ -83515,16 +83422,6 @@ }, "style": "form" }, - "cat.indices-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.indices-master_timeout": { "in": "query", "name": "master_timeout", @@ -83576,16 +83473,6 @@ }, "style": "form" }, - "cat.ml_data_frame_analytics-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit in which to display byte values", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_data_frame_analytics-h": { "in": "query", "name": "h", @@ -83606,16 +83493,6 @@ }, "style": "form" }, - "cat.ml_data_frame_analytics-time": { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_datafeeds-datafeed_id": { "in": "path", "name": "datafeed_id", @@ -83657,16 +83534,6 @@ }, "style": "form" }, - "cat.ml_datafeeds-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_jobs-job_id": { "in": "path", "name": "job_id", @@ -83688,16 +83555,6 @@ }, "style": "form" }, - "cat.ml_jobs-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_jobs-h": { "in": "query", "name": "h", @@ -83718,16 +83575,6 @@ }, "style": "form" }, - "cat.ml_jobs-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.ml_trained_models-model_id": { "in": "path", "name": "model_id", @@ -83749,16 +83596,6 @@ }, "style": "form" }, - "cat.ml_trained_models-bytes": { - "in": "query", - "name": "bytes", - "description": "The unit used to display byte values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Bytes" - }, - "style": "form" - }, "cat.ml_trained_models-h": { "in": "query", "name": "h", @@ -83799,16 +83636,6 @@ }, "style": "form" }, - "cat.ml_trained_models-time": { - "in": "query", - "name": "time", - "description": "Unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.transforms-transform_id": { "in": "path", "name": "transform_id", @@ -83860,16 +83687,6 @@ }, "style": "form" }, - "cat.transforms-time": { - "in": "query", - "name": "time", - "description": "The unit used to display time values.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "cat.transforms-size": { "in": "query", "name": "size", diff --git a/output/schema/schema.json b/output/schema/schema.json index 3ff1f52ce0..d01152299e 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -105594,18 +105594,6 @@ } ], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "name": "h", @@ -105657,7 +105645,7 @@ } } ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L78" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L76" }, { "kind": "response", @@ -106283,18 +106271,6 @@ } ], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "Comma-separated list of fields used to limit returned information.", "name": "fields", @@ -106332,7 +106308,7 @@ } } ], - "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L70" + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L68" }, { "kind": "response", @@ -106690,18 +106666,6 @@ }, "path": [], "query": [ - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, { "description": "If true, returns `HH:MM:SS` and Unix epoch timestamps.", "name": "ts", @@ -106740,7 +106704,7 @@ } } ], - "specLocation": "cat/health/CatHealthRequest.ts#L24-L70" + "specLocation": "cat/health/CatHealthRequest.ts#L23-L65" }, { "kind": "response", @@ -108940,18 +108904,6 @@ } ], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "The type of index that wildcard patterns can match.", "name": "expand_wildcards", @@ -109002,18 +108954,6 @@ } } }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, { "description": "Period to wait for a connection to the master node.", "name": "master_timeout", @@ -109052,7 +108992,7 @@ } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L30-L109" + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L99" }, { "kind": "response", @@ -109607,18 +109547,6 @@ } } }, - { - "description": "The unit in which to display byte values", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "Comma-separated list of column names to display.", "name": "h", @@ -109643,21 +109571,9 @@ "namespace": "cat._types" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L70" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L23-L64" }, { "kind": "response", @@ -109982,21 +109898,9 @@ "namespace": "cat._types" } } - }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L85" + "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L23-L80" }, { "kind": "response", @@ -111063,18 +110967,6 @@ } } }, - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "Comma-separated list of column names to display.", "name": "h", @@ -111099,21 +110991,9 @@ "namespace": "cat._types" } } - }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L89" + "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L23-L80" }, { "kind": "response", @@ -111218,18 +111098,6 @@ } } }, - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "A comma-separated list of column names to display.", "name": "h", @@ -111277,21 +111145,9 @@ "namespace": "_types" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L25-L80" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L73" }, { "kind": "response", @@ -113424,18 +113280,6 @@ }, "path": [], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "If `true`, return the full node ID. If `false`, return the shortened node ID.", "name": "full_id", @@ -113511,21 +113355,9 @@ "namespace": "_types" } } - }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L79" + "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L71" }, { "kind": "response", @@ -113729,21 +113561,9 @@ "namespace": "_types" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L24-L71" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L24-L67" }, { "kind": "response", @@ -114509,18 +114329,6 @@ } } }, - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "If `true`, the response includes detailed information about shard recoveries.", "name": "detailed", @@ -114570,21 +114378,9 @@ "namespace": "_types" } } - }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L92" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L83" }, { "kind": "response", @@ -114857,18 +114653,6 @@ } ], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "A comma-separated list of columns names to display.\nIt supports simple wildcards.", "name": "h", @@ -114921,7 +114705,7 @@ } } ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L87" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L83" }, { "kind": "response", @@ -115253,18 +115037,6 @@ } ], "query": [ - { - "description": "The unit used to display byte values.", - "name": "bytes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Bytes", - "namespace": "_types" - } - } - }, { "description": "List of columns to appear in the response. Supports simple wildcards.", "name": "h", @@ -115301,21 +115073,9 @@ "namespace": "_types" } } - }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L24-L81" + "specLocation": "cat/shards/CatShardsRequest.ts#L24-L73" }, { "kind": "response", @@ -116759,21 +116519,9 @@ "namespace": "_types" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L84" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L80" }, { "kind": "response", @@ -117177,18 +116925,6 @@ } } }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, { "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", @@ -117216,7 +116952,7 @@ } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L24-L82" + "specLocation": "cat/tasks/CatTasksRequest.ts#L24-L78" }, { "kind": "response", @@ -117819,18 +117555,6 @@ } } }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, { "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "name": "local", @@ -117858,7 +117582,7 @@ } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L83" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L79" }, { "kind": "response", @@ -118365,18 +118089,6 @@ } } }, - { - "description": "The unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, { "description": "The maximum number of transforms to obtain.", "name": "size", @@ -118391,7 +118103,7 @@ } } ], - "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L89" + "specLocation": "cat/transforms/CatTransformsRequest.ts#L24-L84" }, { "kind": "response", @@ -248236,7 +247948,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } @@ -248249,7 +247961,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } @@ -248500,7 +248212,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } @@ -248721,7 +248433,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } @@ -248734,7 +248446,7 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } @@ -276519,7 +276231,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L20-L28" + "specLocation": "_spec_utils/behaviors.ts#L23-L31" }, { "kind": "interface", @@ -276539,7 +276251,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L30-L39" + "specLocation": "_spec_utils/behaviors.ts#L33-L42" }, { "kind": "interface", @@ -276616,7 +276328,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L41-L75" + "specLocation": "_spec_utils/behaviors.ts#L44-L78" }, { "kind": "interface", @@ -276632,7 +276344,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L102-L108" + "specLocation": "_spec_utils/behaviors.ts#L120-L126" }, { "kind": "interface", @@ -276680,9 +276392,33 @@ "namespace": "_builtins" } } + }, + { + "description": "Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.", + "name": "bytes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Bytes", + "namespace": "_types" + } + } + }, + { + "description": "Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.", + "name": "time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "_spec_utils/behaviors.ts#L77-L100" + "specLocation": "_spec_utils/behaviors.ts#L80-L118" } ] } \ No newline at end of file diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 6d18a016b7..e54db8e4c4 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,5 +1,122 @@ { - "endpointErrors": {}, + "endpointErrors": { + "cat.aliases": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.allocation": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.component_templates": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.count": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.fielddata": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.health": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.master": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.ml_datafeeds": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.nodeattrs": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.pending_tasks": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.plugins": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.repositories": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.segments": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.snapshots": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.tasks": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.templates": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.thread_pool": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.transforms": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + } + }, "generalErrors": [ "Dangling type '_global.scripts_painless_execute:PainlessExecutionPosition'", "Dangling type '_global.scripts_painless_execute:PainlessScript'", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 42f9e5e800..1015816f85 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -7352,7 +7352,6 @@ export interface CatAllocationAllocationRecord { export interface CatAllocationRequest extends CatCatRequestBase { node_id?: NodeIds - bytes?: Bytes h?: CatCatAllocationColumns s?: Names local?: boolean @@ -7417,7 +7416,6 @@ export interface CatFielddataFielddataRecord { export interface CatFielddataRequest extends CatCatRequestBase { fields?: Fields - bytes?: Bytes h?: CatCatFieldDataColumns s?: Names } @@ -7478,7 +7476,6 @@ export interface CatHealthHealthRecord { } export interface CatHealthRequest extends CatCatRequestBase { - time?: TimeUnit ts?: boolean h?: CatCatHealthColumns s?: Names @@ -7785,12 +7782,10 @@ export interface CatIndicesIndicesRecord { export interface CatIndicesRequest extends CatCatRequestBase { index?: Indices - bytes?: Bytes expand_wildcards?: ExpandWildcards health?: HealthStatus include_unloaded_segments?: boolean pri?: boolean - time?: TimeUnit master_timeout?: Duration h?: CatCatIndicesColumns s?: Names @@ -7863,10 +7858,8 @@ export interface CatMlDataFrameAnalyticsDataFrameAnalyticsRecord { export interface CatMlDataFrameAnalyticsRequest extends CatCatRequestBase { id?: Id allow_no_match?: boolean - bytes?: Bytes h?: CatCatDfaColumns s?: CatCatDfaColumns - time?: TimeUnit } export type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[] @@ -7911,7 +7904,6 @@ export interface CatMlDatafeedsRequest extends CatCatRequestBase { allow_no_match?: boolean h?: CatCatDatafeedColumns s?: CatCatDatafeedColumns - time?: TimeUnit } export type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[] @@ -8096,10 +8088,8 @@ export interface CatMlJobsJobsRecord { export interface CatMlJobsRequest extends CatCatRequestBase { job_id?: Id allow_no_match?: boolean - bytes?: Bytes h?: CatCatAnomalyDetectorColumns s?: CatCatAnomalyDetectorColumns - time?: TimeUnit } export type CatMlJobsResponse = CatMlJobsJobsRecord[] @@ -8107,12 +8097,10 @@ export type CatMlJobsResponse = CatMlJobsJobsRecord[] export interface CatMlTrainedModelsRequest extends CatCatRequestBase { model_id?: Id allow_no_match?: boolean - bytes?: Bytes h?: CatCatTrainedModelsColumns s?: CatCatTrainedModelsColumns from?: integer size?: integer - time?: TimeUnit } export type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] @@ -8459,13 +8447,11 @@ export interface CatNodesNodesRecord { } export interface CatNodesRequest extends CatCatRequestBase { - bytes?: Bytes full_id?: boolean | string include_unloaded_segments?: boolean h?: CatCatNodeColumns s?: Names master_timeout?: Duration - time?: TimeUnit } export type CatNodesResponse = CatNodesNodesRecord[] @@ -8486,7 +8472,6 @@ export interface CatPendingTasksRequest extends CatCatRequestBase { s?: Names local?: boolean master_timeout?: Duration - time?: TimeUnit } export type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[] @@ -8576,11 +8561,9 @@ export interface CatRecoveryRecoveryRecord { export interface CatRecoveryRequest extends CatCatRequestBase { index?: Indices active_only?: boolean - bytes?: Bytes detailed?: boolean h?: CatCatRecoveryColumns s?: Names - time?: TimeUnit } export type CatRecoveryResponse = CatRecoveryRecoveryRecord[] @@ -8603,7 +8586,6 @@ export type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] export interface CatSegmentsRequest extends CatCatRequestBase { index?: Indices - bytes?: Bytes h?: CatCatSegmentsColumns s?: Names local?: boolean @@ -8656,11 +8638,9 @@ export interface CatSegmentsSegmentsRecord { export interface CatShardsRequest extends CatCatRequestBase { index?: Indices - bytes?: Bytes h?: CatCatShardColumns s?: Names master_timeout?: Duration - time?: TimeUnit } export type CatShardsResponse = CatShardsShardsRecord[] @@ -8886,7 +8866,6 @@ export interface CatSnapshotsRequest extends CatCatRequestBase { h?: CatCatSnapshotsColumns s?: Names master_timeout?: Duration - time?: TimeUnit } export type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[] @@ -8932,7 +8911,6 @@ export interface CatTasksRequest extends CatCatRequestBase { parent_task_id?: string h?: CatCatTasksColumns s?: Names - time?: TimeUnit timeout?: Duration wait_for_completion?: boolean } @@ -9002,7 +8980,6 @@ export interface CatThreadPoolRequest extends CatCatRequestBase { thread_pool_patterns?: Names h?: CatCatThreadPoolColumns s?: Names - time?: TimeUnit local?: boolean master_timeout?: Duration } @@ -9058,7 +9035,6 @@ export interface CatTransformsRequest extends CatCatRequestBase { from?: integer h?: CatCatTransformColumns s?: CatCatTransformColumns - time?: TimeUnit size?: integer } @@ -21155,8 +21131,8 @@ export type ShutdownType = 'restart' | 'remove' | 'replace' export interface ShutdownDeleteNodeRequest extends RequestBase { node_id: NodeId - master_timeout?: TimeUnit - timeout?: TimeUnit + master_timeout?: Duration + timeout?: Duration } export type ShutdownDeleteNodeResponse = AcknowledgedResponseBase @@ -21182,7 +21158,7 @@ export interface ShutdownGetNodePluginsStatus { export interface ShutdownGetNodeRequest extends RequestBase { node_id?: NodeIds - master_timeout?: TimeUnit + master_timeout?: Duration } export interface ShutdownGetNodeResponse { @@ -21199,8 +21175,8 @@ export type ShutdownGetNodeShutdownType = 'remove' | 'restart' export interface ShutdownPutNodeRequest extends RequestBase { node_id: NodeId - master_timeout?: TimeUnit - timeout?: TimeUnit + master_timeout?: Duration + timeout?: Duration body?: { type: ShutdownType reason: string @@ -23904,5 +23880,7 @@ export interface SpecUtilsCommonCatQueryParameters { format?: string help?: boolean v?: boolean + bytes?: Bytes + time?: TimeUnit } From 709884b53b76165104091f8a1a7a1c1e38822cfa Mon Sep 17 00:00:00 2001 From: David Turner Date: Wed, 17 Sep 2025 08:32:01 +0100 Subject: [PATCH 8/8] make contrib again --- output/schema/validation-errors.json | 116 +++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 34717a8197..05256be8e3 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -1,5 +1,121 @@ { "endpointErrors": { + "cat.aliases": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.allocation": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.component_templates": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.count": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.fielddata": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.health": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.master": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.ml_datafeeds": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.nodeattrs": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.pending_tasks": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.plugins": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.repositories": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.segments": { + "request": [ + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.snapshots": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.tasks": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.templates": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec", + "Request: query parameter 'time' does not exist in the json spec" + ], + "response": [] + }, + "cat.thread_pool": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, + "cat.transforms": { + "request": [ + "Request: query parameter 'bytes' does not exist in the json spec" + ], + "response": [] + }, "streams.status": { "request": [ "Request: query parameter 'master_timeout' does not exist in the json spec",