Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

198 changes: 197 additions & 1 deletion specification/cat/_types/CatBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ export enum CatAnomalyDetectorColumn {
*/
state
}
export type CatAnonalyDetectorColumns =
export type CatAnomalyDetectorColumns =
| CatAnomalyDetectorColumn
| CatAnomalyDetectorColumn[]
export enum CatDatafeedColumn {
Expand Down Expand Up @@ -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 {
/**
Expand Down
6 changes: 3 additions & 3 deletions specification/cat/aliases/CatAliasesRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

import { ExpandWildcards, Names } from '@_types/common'
import { Duration } from '@_types/Time'
import { CatRequestBase } from '@cat/_types/CatBase'
import { CatAliasesColumns, CatRequestBase } from '@cat/_types/CatBase'

/**
* Get aliases.
Expand Down Expand Up @@ -51,9 +51,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`
Expand Down
6 changes: 3 additions & 3 deletions specification/cat/allocation/CatAllocationRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions specification/cat/count/CatCountRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions specification/cat/fielddata/CatFielddataRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions specification/cat/ml_jobs/CatJobsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
*/
Expand Down