diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 0f9c523429..8b27c30337 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -7151,7 +7151,7 @@ export type AutoscalingPutAutoscalingPolicyResponse = AcknowledgedResponseBase export type CatCatAnomalyDetectorColumn = 'assignment_explanation' | 'ae' | 'buckets.count' | 'bc' | 'bucketsCount' | 'buckets.time.exp_avg' | 'btea' | 'bucketsTimeExpAvg' | 'buckets.time.exp_avg_hour' | 'bteah' | 'bucketsTimeExpAvgHour' | 'buckets.time.max' | 'btmax' | 'bucketsTimeMax' | 'buckets.time.min' | 'btmin' | 'bucketsTimeMin' | 'buckets.time.total' | 'btt' | 'bucketsTimeTotal' | 'data.buckets' | 'db' | 'dataBuckets' | 'data.earliest_record' | 'der' | 'dataEarliestRecord' | 'data.empty_buckets' | 'deb' | 'dataEmptyBuckets' | 'data.input_bytes' | 'dib' | 'dataInputBytes' | 'data.input_fields' | 'dif' | 'dataInputFields' | 'data.input_records' | 'dir' | 'dataInputRecords' | 'data.invalid_dates' | 'did' | 'dataInvalidDates' | 'data.last' | 'dl' | 'dataLast' | 'data.last_empty_bucket' | 'dleb' | 'dataLastEmptyBucket' | 'data.last_sparse_bucket' | 'dlsb' | 'dataLastSparseBucket' | 'data.latest_record' | 'dlr' | 'dataLatestRecord' | 'data.missing_fields' | 'dmf' | 'dataMissingFields' | 'data.out_of_order_timestamps' | 'doot' | 'dataOutOfOrderTimestamps' | 'data.processed_fields' | 'dpf' | 'dataProcessedFields' | 'data.processed_records' | 'dpr' | 'dataProcessedRecords' | 'data.sparse_buckets' | 'dsb' | 'dataSparseBuckets' | 'forecasts.memory.avg' | 'fmavg' | 'forecastsMemoryAvg' | 'forecasts.memory.max' | 'fmmax' | 'forecastsMemoryMax' | 'forecasts.memory.min' | 'fmmin' | 'forecastsMemoryMin' | 'forecasts.memory.total' | 'fmt' | 'forecastsMemoryTotal' | 'forecasts.records.avg' | 'fravg' | 'forecastsRecordsAvg' | 'forecasts.records.max' | 'frmax' | 'forecastsRecordsMax' | 'forecasts.records.min' | 'frmin' | 'forecastsRecordsMin' | 'forecasts.records.total' | 'frt' | 'forecastsRecordsTotal' | 'forecasts.time.avg' | 'ftavg' | 'forecastsTimeAvg' | 'forecasts.time.max' | 'ftmax' | 'forecastsTimeMax' | 'forecasts.time.min' | 'ftmin' | 'forecastsTimeMin' | 'forecasts.time.total' | 'ftt' | 'forecastsTimeTotal' | 'forecasts.total' | 'ft' | 'forecastsTotal' | 'id' | 'model.bucket_allocation_failures' | 'mbaf' | 'modelBucketAllocationFailures' | 'model.by_fields' | 'mbf' | 'modelByFields' | 'model.bytes' | 'mb' | 'modelBytes' | 'model.bytes_exceeded' | 'mbe' | 'modelBytesExceeded' | 'model.categorization_status' | 'mcs' | 'modelCategorizationStatus' | 'model.categorized_doc_count' | 'mcdc' | 'modelCategorizedDocCount' | 'model.dead_category_count' | 'mdcc' | 'modelDeadCategoryCount' | 'model.failed_category_count' | 'mdcc' | 'modelFailedCategoryCount' | 'model.frequent_category_count' | 'mfcc' | 'modelFrequentCategoryCount' | 'model.log_time' | 'mlt' | 'modelLogTime' | 'model.memory_limit' | 'mml' | 'modelMemoryLimit' | 'model.memory_status' | 'mms' | 'modelMemoryStatus' | 'model.over_fields' | 'mof' | 'modelOverFields' | 'model.partition_fields' | 'mpf' | 'modelPartitionFields' | 'model.rare_category_count' | 'mrcc' | 'modelRareCategoryCount' | 'model.timestamp' | 'mt' | 'modelTimestamp' | 'model.total_category_count' | 'mtcc' | 'modelTotalCategoryCount' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'opened_time' | 'ot' | 'state' | 's' -export type CatCatAnonalyDetectorColumns = CatCatAnomalyDetectorColumn | CatCatAnomalyDetectorColumn[] +export type CatCatAnomalyDetectorColumns = CatCatAnomalyDetectorColumn | CatCatAnomalyDetectorColumn[] export type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buckets.count' | 'bucketsCount' | 'id' | 'na' | 'node.address' | 'nodeAddress' | 'ne' | 'node.ephemeral_id' | 'nodeEphemeralId' | 'ni' | 'node.id' | 'nodeId' | 'nn' | 'node.name' | 'nodeName' | 'sba' | 'search.bucket_avg' | 'searchBucketAvg' | 'sc' | 'search.count' | 'searchCount' | 'seah' | 'search.exp_avg_hour' | 'searchExpAvgHour' | 'st' | 'search.time' | 'searchTime' | 's' | 'state' @@ -8009,8 +8009,8 @@ export interface CatMlJobsRequest extends CatCatRequestBase { job_id?: Id allow_no_match?: boolean bytes?: Bytes - h?: CatCatAnonalyDetectorColumns - s?: CatCatAnonalyDetectorColumns + h?: CatCatAnomalyDetectorColumns + s?: CatCatAnomalyDetectorColumns time?: TimeUnit } diff --git a/specification/cat/_types/CatBase.ts b/specification/cat/_types/CatBase.ts index 8c3860b5a0..5a5242a6b8 100644 --- a/specification/cat/_types/CatBase.ts +++ b/specification/cat/_types/CatBase.ts @@ -399,7 +399,7 @@ export enum CatAnomalyDetectorColumn { */ state } -export type CatAnonalyDetectorColumns = +export type CatAnomalyDetectorColumns = | CatAnomalyDetectorColumn | CatAnomalyDetectorColumn[] export enum CatDatafeedColumn { @@ -683,7 +683,7 @@ export enum CatNodeColumn { * The bound HTTP address. * @aliases http */ - 'http_address', + http_address, /** * The identifier for the node. * @aliases nodeId @@ -743,17 +743,17 @@ export enum CatNodeColumn { * The most recent load average. For example: `0.22`. * @aliases l */ - 'load_1m', + load_1m, /** * The load average for the last five minutes. For example: `0.78`. * @aliases l */ - 'load_5m', + load_5m, /** * The load average for the last fifteen minutes. For example: `1.24`. * @aliases l */ - 'load_15m', + load_15m, /** * The number of mappings, including runtime and object fields. * @aliases mtc, mappingsTotalCount @@ -1041,27 +1041,27 @@ export enum CatRecoveryColumn { * The host address the index is moving from. * @aliases shost */ - 'source_host', + source_host, /** * The node name the index is moving from. * @aliases snode */ - 'source_node', + source_node, /** * The host address the index is moving to. * @aliases thost */ - 'target_host', + target_host, /** * The node name the index is moving to. * @aliases tnode */ - 'target_node', + target_node, /** * The name of the repository being used. if not relevant 'n/a'. * @aliases tnode */ - 'repository', + repository, /** * The name of the snapshot being used. if not relevant 'n/a'. * @aliases snap @@ -1076,17 +1076,17 @@ export enum CatRecoveryColumn { * The number of files currently recovered. * @aliases fr */ - 'files_recovered', + files_recovered, /** * The percentage of files currently recovered. * @aliases fp */ - 'files_percent', + files_percent, /** * The total number of files. * @aliases tf */ - 'files_total', + files_total, /** * The total number of bytes to recover. * @aliases b @@ -1096,52 +1096,52 @@ export enum CatRecoveryColumn { * Total number of bytes currently recovered. * @aliases br */ - 'bytes_recovered', + bytes_recovered, /** * The percentage of bytes currently recovered. * @aliases bp */ - 'bytes_percent', + bytes_percent, /** * The total number of bytes. * @aliases tb */ - 'bytes_total', + bytes_total, /** * The total number of translog ops to recover. * @aliases to */ - 'translog_ops', + translog_ops, /** * The total number of translog ops currently recovered. * @aliases tor */ - 'translog_ops_recovered', + translog_ops_recovered, /** * The percentage of translog ops currently recovered. * @aliases top */ - 'translog_ops_percent', + translog_ops_percent, /** * The start time of the recovery operation. * @aliases start */ - 'start_time', + start_time, /** * The start time of the recovery operation in eopch milliseconds. * @aliases start_millis */ - 'start_time_millis', + start_time_millis, /** * The end time of the recovery operation. If ongoing '1970-01-01T00:00:00.000Z' * @aliases stop */ - 'stop_time', + stop_time, /** * The end time of the recovery operation in eopch milliseconds. If ongoing '0' * @aliases stop_millis */ - 'stop_time_millis' + stop_time_millis } /** @non_exhaustive */ @@ -1232,22 +1232,22 @@ export enum CatSnapshotsColumn { * The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process started. * @aliases ste, startEpoch */ - 'start_epoch', + start_epoch, /** * 'HH:MM:SS' time at which the snapshot process started. * @aliases sti, startTime */ - 'start_time', + start_time, /** * The [unix epoch time](https://en.wikipedia.org/wiki/Unix_time) at which the snapshot process ended. * @aliases ete, endEpoch */ - 'end_epoch', + end_epoch, /** * 'HH:MM:SS' time at which the snapshot process ended. * @aliases eti, endTime */ - 'end_time', + end_time, /** * The time it took the snapshot process to complete in [time units](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units). * @aliases dur @@ -1262,17 +1262,17 @@ export enum CatSnapshotsColumn { * The number of successful shards in the snapshot. * @aliases ss */ - 'successful_shards', + successful_shards, /** * The number of failed shards in the snapshot. * @aliases fs */ - 'failed_shards', + failed_shards, /** * The total number of shards in the snapshot. * @aliases ts */ - 'total_shards', + total_shards, /** * The reason for any snapshot failures. * @aliases r @@ -1280,12 +1280,208 @@ export enum CatSnapshotsColumn { reason } +/** @non_exhaustive */ +export enum CatAliasesColumn { + /** + * The name of the alias. + * @aliases a + */ + alias, + /** + * The name of the index the alias points to. + * @aliases i, idx + */ + index, + /** + * The filter applied to the alias. + * @aliases f, fi + */ + filter, + /** + * Index routing value for the alias. + * @aliases ri, routingIndex + */ + 'routing.index', + /** + * Search routing value for the alias. + * @aliases rs, routingSearch + */ + 'routing.search', + /** + * Indicates if the index is the write index for the alias. + * @aliases w, isWriteIndex + */ + is_write_index +} + +/** @non_exhaustive */ +export enum CatAllocationColumn { + /** + * The number of shards on the node. + * @aliases s + */ + shards, + /** + * The number of shards scheduled to be moved elsewhere in the cluster. + */ + 'shards.undesired', + /** + * The sum of index write load forecasts. + * @aliases wlf, writeLoadForecast + */ + 'write_load.forecast', + /** + * The sum of shard size forecasts. + * @aliases dif, diskIndicesForecast + */ + 'disk.indices.forecast', + /** + * The disk space used by Elasticsearch indices. + * @aliases di, diskIndices + */ + 'disk.indices', + /** + * The total disk space used on the node. + * @aliases du,diskUsed + */ + 'disk.used', + /** + * The available disk space on the node. + * @aliases da, diskAvail + */ + 'disk.avail', + /** + * The total disk capacity of all volumes on the node. + * @aliases dt, diskTotal + */ + 'disk.total', + /** + * The percentage of disk space used on the node. + * @aliases dp, diskPercent + */ + 'disk.percent', + /** + * IThe host of the node. + * @aliases h + */ + host, + /** + * The IP address of the node. + */ + ip, + /** + * The name of the node. + * @aliases n + */ + node, + /** + * The roles assigned to the node. + * @aliases r, role, nodeRole + */ + 'node.role' +} + +/** @non_exhaustive */ +export enum CatComponentColumn { + /** + * The name of the component template. + * @aliases n + */ + name, + /** + * The version number of the component template. + * @aliases v + */ + version, + /** + * The number of aliases in the component template. + * @aliases a + */ + alias_count, + /** + * The number of mappings in the component template. + * @aliases m + */ + mapping_count, + /** + * The number of settings in the component template. + * @aliases s + */ + settings_count, + /** + * The number of metadata entries in the component template. + * @aliases me + */ + metadata_count, + /** + * The index templates that include this component template. + * @aliases i + */ + included_in +} + +/** @non_exhaustive */ +export enum CatCountColumn { + /** + * The Unix epoch time in seconds since 1970-01-01 00:00:00. + * @aliases t,time + */ + epoch, + /** + * The current time in HH:MM:SS format. + * @aliases ts,hms,hhmmss + */ + timestamp, + /** + * The document count in the cluster or index. + * @aliases dc,docs.count,docsCount + */ + count +} + +/** @non_exhaustive */ +export enum CatFieldDataColumn { + /** + * The node ID. + */ + id, + /** + * The host name of the node. + * @aliases h + */ + host, + /** + * The IP address of the node. + */ + ip, + /** + * The node name. + * @aliases n + */ + node, + /** + * The field name. + * @aliases f + */ + field, + /** + * The field data usage. + * @aliases s + */ + size +} + export type CatDfaColumns = CatDfaColumn | CatDfaColumn[] export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[] export type CatNodeColumns = CatNodeColumn | CatNodeColumn[] export type CatRecoveryColumns = CatRecoveryColumn | CatRecoveryColumn[] export type CatSegmentsColumns = CatSegmentsColumn | CatSegmentsColumn[] export type CatSnapshotsColumns = CatSnapshotsColumn | CatSnapshotsColumn[] +export type CatAliasesColumns = CatAliasesColumn | CatAliasesColumn[] +export type CatAllocationColumns = CatAllocationColumn | CatAllocationColumn[] +export type CatComponentColumns = CatComponentColumn | CatComponentColumn[] +export type CatCountColumns = CatCountColumn | CatCountColumn[] +export type CatFieldDataColumns = CatFieldDataColumn | CatFieldDataColumn[] export enum CatTrainedModelsColumn { /** @@ -1594,7 +1790,7 @@ export enum CatShardColumn { * Number of documents in shard, for example: `25`. * @aliases d, dc */ - 'docs', + docs, /** * Fielddata cache evictions, for example: `0`. * @aliases fe, fielddataEvictions @@ -1867,7 +2063,7 @@ export enum CatShardColumn { * Name of the shard. * @aliases s, sh */ - 'shard', + shard, /** * Number of indexed [sparse vectors](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/sparse-vector). * @aliases svc, sparseVectorCount @@ -1881,12 +2077,12 @@ export enum CatShardColumn { * * `UNASSIGNED`: The shard is not assigned to any node. * @aliases st */ - 'state', + state, /** * Disk space used by the shard, for example: `5kb`. * @aliases sto */ - 'store', + store, /** * Number of current suggest operations, for example: `0`. * @aliases suc, suggestCurrent diff --git a/specification/cat/aliases/CatAliasesRequest.ts b/specification/cat/aliases/CatAliasesRequest.ts index 58770488a6..f68bd1a973 100644 --- a/specification/cat/aliases/CatAliasesRequest.ts +++ b/specification/cat/aliases/CatAliasesRequest.ts @@ -18,7 +18,7 @@ */ import { ExpandWildcards, Names } from '@_types/common' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatAliasesColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get aliases. @@ -50,9 +50,9 @@ export interface Request extends CatRequestBase { } query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatAliasesColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/allocation/CatAllocationRequest.ts b/specification/cat/allocation/CatAllocationRequest.ts index d440f98b58..0bec053b71 100644 --- a/specification/cat/allocation/CatAllocationRequest.ts +++ b/specification/cat/allocation/CatAllocationRequest.ts @@ -19,7 +19,7 @@ import { Bytes, Names, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatAllocationColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get shard allocation information. @@ -52,9 +52,9 @@ export interface Request extends CatRequestBase { /** The unit used to display byte values. */ bytes?: Bytes /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatAllocationColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/component_templates/CatComponentTemplatesRequest.ts b/specification/cat/component_templates/CatComponentTemplatesRequest.ts index 94da1f7b8d..7f131988b7 100644 --- a/specification/cat/component_templates/CatComponentTemplatesRequest.ts +++ b/specification/cat/component_templates/CatComponentTemplatesRequest.ts @@ -19,7 +19,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatComponentColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get component templates. @@ -55,9 +55,9 @@ export interface Request extends CatRequestBase { } query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatComponentColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/count/CatCountRequest.ts b/specification/cat/count/CatCountRequest.ts index 09ce105a51..a1b3b5f087 100644 --- a/specification/cat/count/CatCountRequest.ts +++ b/specification/cat/count/CatCountRequest.ts @@ -18,7 +18,7 @@ */ import { Indices, Names } from '@_types/common' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatCountColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get a document count. @@ -55,9 +55,9 @@ export interface Request extends CatRequestBase { } query_parameters: { /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatCountColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/fielddata/CatFielddataRequest.ts b/specification/cat/fielddata/CatFielddataRequest.ts index f2d1cd8525..c88438f3a7 100644 --- a/specification/cat/fielddata/CatFielddataRequest.ts +++ b/specification/cat/fielddata/CatFielddataRequest.ts @@ -18,7 +18,7 @@ */ import { Bytes, Fields, Names } from '@_types/common' -import { CatRequestBase } from '@cat/_types/CatBase' +import { CatFieldDataColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get field data cache information. @@ -57,9 +57,9 @@ export interface Request extends CatRequestBase { /** Comma-separated list of fields used to limit returned information. */ fields?: Fields /** - * List of columns to appear in the response. Supports simple wildcards. + * A comma-separated list of columns names to display. It supports simple wildcards. */ - h?: Names + h?: CatFieldDataColumns /** * List of columns that determine how the table should be sorted. * Sorting defaults to ascending and can be changed by setting `:asc` diff --git a/specification/cat/ml_jobs/CatJobsRequest.ts b/specification/cat/ml_jobs/CatJobsRequest.ts index 2df5435c34..e9c0eb1344 100644 --- a/specification/cat/ml_jobs/CatJobsRequest.ts +++ b/specification/cat/ml_jobs/CatJobsRequest.ts @@ -19,7 +19,7 @@ import { Bytes, Id } from '@_types/common' import { TimeUnit } from '@_types/Time' -import { CatAnonalyDetectorColumns, CatRequestBase } from '@cat/_types/CatBase' +import { CatAnomalyDetectorColumns, CatRequestBase } from '@cat/_types/CatBase' /** * Get anomaly detection jobs. @@ -78,9 +78,9 @@ export interface Request extends CatRequestBase { * Comma-separated list of column names to display. * @server_default buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state */ - h?: CatAnonalyDetectorColumns + h?: CatAnomalyDetectorColumns /** Comma-separated list of column names or column aliases used to sort the response. */ - s?: CatAnonalyDetectorColumns + s?: CatAnomalyDetectorColumns /** * The unit used to display time values. */