Skip to content

Commit 85dea32

Browse files
authoredFeb 18, 2025··
Auto-generated API code (#2619)
1 parent 528dd6b commit 85dea32

File tree

4 files changed

+28
-8
lines changed

4 files changed

+28
-8
lines changed
 

‎docs/reference.asciidoc

+6
Original file line numberDiff line numberDiff line change
@@ -4895,6 +4895,9 @@ and its format can change at any time but it can give some insight into the perf
48954895
of each part of the query.
48964896
** *`tables` (Optional, Record<string, Record<string, { integer, keyword, long, double }>>)*: Tables to use with the LOOKUP operation. The top level key is the table
48974897
name and the next level key is the column name.
4898+
** *`include_ccs_metadata` (Optional, boolean)*: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
4899+
object with information about the clusters that participated in the search along with info such as shards
4900+
count.
48984901
** *`delimiter` (Optional, string)*: The character to use between values within a CSV row.
48994902
It is valid only for the CSV format.
49004903
** *`drop_null_columns` (Optional, boolean)*: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
@@ -4990,6 +4993,9 @@ and its format can change at any time but it can give some insight into the perf
49904993
of each part of the query.
49914994
** *`tables` (Optional, Record<string, Record<string, { integer, keyword, long, double }>>)*: Tables to use with the LOOKUP operation. The top level key is the table
49924995
name and the next level key is the column name.
4996+
** *`include_ccs_metadata` (Optional, boolean)*: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
4997+
object with information about the clusters that participated in the search along with info such as shards
4998+
count.
49934999
** *`format` (Optional, Enum("csv" | "json" | "tsv" | "txt" | "yaml" | "cbor" | "smile" | "arrow"))*: A short version of the Accept header, e.g. json, yaml.
49945000
** *`delimiter` (Optional, string)*: The character to use between values within a CSV row. Only valid for the CSV format.
49955001
** *`drop_null_columns` (Optional, boolean)*: Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?

‎src/api/api/esql.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export default class Esql {
5353
async asyncQuery (this: That, params: T.EsqlAsyncQueryRequest | TB.EsqlAsyncQueryRequest, options?: TransportRequestOptions): Promise<T.EsqlAsyncQueryResponse>
5454
async asyncQuery (this: That, params: T.EsqlAsyncQueryRequest | TB.EsqlAsyncQueryRequest, options?: TransportRequestOptions): Promise<any> {
5555
const acceptedPath: string[] = []
56-
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables']
56+
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables', 'include_ccs_metadata']
5757
const querystring: Record<string, any> = {}
5858
// @ts-expect-error
5959
const userBody: any = params?.body
@@ -158,7 +158,7 @@ export default class Esql {
158158
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptions): Promise<T.EsqlQueryResponse>
159159
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptions): Promise<any> {
160160
const acceptedPath: string[] = []
161-
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables']
161+
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables', 'include_ccs_metadata']
162162
const querystring: Record<string, any> = {}
163163
// @ts-expect-error
164164
const userBody: any = params?.body

‎src/api/types.ts

+10-3
Original file line numberDiff line numberDiff line change
@@ -10325,6 +10325,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
1032510325
profile?: boolean
1032610326
query: string
1032710327
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
10328+
include_ccs_metadata?: boolean
1032810329
}
1032910330

1033010331
export type EsqlAsyncQueryResponse = EsqlResult
@@ -10357,6 +10358,7 @@ export interface EsqlQueryRequest extends RequestBase {
1035710358
profile?: boolean
1035810359
query: string
1035910360
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
10361+
include_ccs_metadata?: boolean
1036010362
}
1036110363

1036210364
export type EsqlQueryResponse = EsqlResult
@@ -10674,7 +10676,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1067410676
age?: Duration
1067510677
failed_step?: Name
1067610678
failed_step_retry_count?: integer
10677-
index?: IndexName
10679+
index: IndexName
1067810680
index_creation_date?: DateTime
1067910681
index_creation_date_millis?: EpochTime<UnitMillis>
1068010682
is_auto_retryable_error?: boolean
@@ -10684,7 +10686,11 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1068410686
phase: Name
1068510687
phase_time?: DateTime
1068610688
phase_time_millis?: EpochTime<UnitMillis>
10687-
policy: Name
10689+
policy?: Name
10690+
previous_step_info?: Record<string, any>
10691+
repository_name?: string
10692+
snapshot_name?: string
10693+
shrink_index_name?: string
1068810694
step?: Name
1068910695
step_info?: Record<string, any>
1069010696
step_time?: DateTime
@@ -10694,6 +10700,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1069410700
}
1069510701

1069610702
export interface IlmExplainLifecycleLifecycleExplainPhaseExecution {
10703+
phase_definition?: IlmPhase
1069710704
policy: Name
1069810705
version: VersionNumber
1069910706
modified_date_in_millis: EpochTime<UnitMillis>
@@ -12673,7 +12680,7 @@ export interface InferenceInferenceResult {
1267312680

1267412681
export interface InferenceRankedDocument {
1267512682
index: integer
12676-
score: float
12683+
relevance_score: float
1267712684
text?: string
1267812685
}
1267912686

‎src/api/typesWithBodyKey.ts

+10-3
Original file line numberDiff line numberDiff line change
@@ -10498,6 +10498,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
1049810498
profile?: boolean
1049910499
query: string
1050010500
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
10501+
include_ccs_metadata?: boolean
1050110502
}
1050210503
}
1050310504

@@ -10533,6 +10534,7 @@ export interface EsqlQueryRequest extends RequestBase {
1053310534
profile?: boolean
1053410535
query: string
1053510536
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
10537+
include_ccs_metadata?: boolean
1053610538
}
1053710539
}
1053810540

@@ -10858,7 +10860,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1085810860
age?: Duration
1085910861
failed_step?: Name
1086010862
failed_step_retry_count?: integer
10861-
index?: IndexName
10863+
index: IndexName
1086210864
index_creation_date?: DateTime
1086310865
index_creation_date_millis?: EpochTime<UnitMillis>
1086410866
is_auto_retryable_error?: boolean
@@ -10868,7 +10870,11 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1086810870
phase: Name
1086910871
phase_time?: DateTime
1087010872
phase_time_millis?: EpochTime<UnitMillis>
10871-
policy: Name
10873+
policy?: Name
10874+
previous_step_info?: Record<string, any>
10875+
repository_name?: string
10876+
snapshot_name?: string
10877+
shrink_index_name?: string
1087210878
step?: Name
1087310879
step_info?: Record<string, any>
1087410880
step_time?: DateTime
@@ -10878,6 +10884,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
1087810884
}
1087910885

1088010886
export interface IlmExplainLifecycleLifecycleExplainPhaseExecution {
10887+
phase_definition?: IlmPhase
1088110888
policy: Name
1088210889
version: VersionNumber
1088310890
modified_date_in_millis: EpochTime<UnitMillis>
@@ -12913,7 +12920,7 @@ export interface InferenceInferenceResult {
1291312920

1291412921
export interface InferenceRankedDocument {
1291512922
index: integer
12916-
score: float
12923+
relevance_score: float
1291712924
text?: string
1291812925
}
1291912926

0 commit comments

Comments
 (0)
Please sign in to comment.