Skip to content

Commit 0ef666b

Browse files
Auto-generated API code
1 parent 9ee3a11 commit 0ef666b

File tree

7 files changed

+269
-59
lines changed

7 files changed

+269
-59
lines changed

docs/reference.asciidoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2097,7 +2097,7 @@ client.indices.deleteDataStream({ name })
20972097
==== delete_index_template
20982098
Deletes an index template.
20992099

2100-
{ref}/indices-templates.html[Endpoint documentation]
2100+
{ref}/indices-delete-template.html[Endpoint documentation]
21012101
[source,ts]
21022102
----
21032103
client.indices.deleteIndexTemplate({ name })
@@ -2167,7 +2167,7 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
21672167
==== exists_index_template
21682168
Returns information about whether a particular index template exists.
21692169

2170-
{ref}/indices-templates.html[Endpoint documentation]
2170+
{ref}/index-templates.html[Endpoint documentation]
21712171
[source,ts]
21722172
----
21732173
client.indices.existsIndexTemplate({ name })
@@ -2300,7 +2300,7 @@ Supports a list of values, such as `open,hidden`.
23002300
==== get_index_template
23012301
Returns an index template.
23022302

2303-
{ref}/indices-templates.html[Endpoint documentation]
2303+
{ref}/indices-get-template.html[Endpoint documentation]
23042304
[source,ts]
23052305
----
23062306
client.indices.getIndexTemplate({ ... })
@@ -2483,7 +2483,7 @@ If no response is received before the timeout expires, the request fails and ret
24832483
==== put_index_template
24842484
Creates or updates an index template.
24852485

2486-
{ref}/indices-templates.html[Endpoint documentation]
2486+
{ref}/indices-put-template.html[Endpoint documentation]
24872487
[source,ts]
24882488
----
24892489
client.indices.putIndexTemplate({ name })
@@ -2539,7 +2539,7 @@ a new date field is added instead of string.
25392539
not used at all by Elasticsearch, but can be used to store
25402540
application-specific metadata.
25412541
** *`numeric_detection` (Optional, boolean)*: Automatically map strings into numeric data types for all fields.
2542-
** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, dims, similarity, index, index_options } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type }>)*: Mapping for a field. For new fields, this mapping can include:
2542+
** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, dims, similarity, index, index_options } | { type } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type }>)*: Mapping for a field. For new fields, this mapping can include:
25432543

25442544
- Field name
25452545
- Field data type
@@ -2600,7 +2600,7 @@ error.
26002600
==== put_template
26012601
Creates or updates an index template.
26022602

2603-
{ref}/indices-templates.html[Endpoint documentation]
2603+
{ref}/indices-templates-v1.html[Endpoint documentation]
26042604
[source,ts]
26052605
----
26062606
client.indices.putTemplate({ name })
@@ -2718,7 +2718,7 @@ Set to all or any positive integer up to the total number of shards in the index
27182718
==== simulate_index_template
27192719
Simulate matching the given index name against the index templates in the system
27202720

2721-
{ref}/indices-templates.html[Endpoint documentation]
2721+
{ref}/indices-simulate-index.html[Endpoint documentation]
27222722
[source,ts]
27232723
----
27242724
client.indices.simulateIndexTemplate({ name })
@@ -2761,7 +2761,7 @@ before the timeout expires, the request fails and returns an error.
27612761
==== simulate_template
27622762
Simulate resolving the given template name or body
27632763

2764-
{ref}/indices-templates.html[Endpoint documentation]
2764+
{ref}/indices-simulate-template.html[Endpoint documentation]
27652765
[source,ts]
27662766
----
27672767
client.indices.simulateTemplate({ ... })
@@ -2930,7 +2930,7 @@ client.ingest.simulate({ ... })
29302930
** *`id` (Optional, string)*: Pipeline to test.
29312931
If you don’t specify a `pipeline` in the request body, this parameter is required.
29322932
** *`docs` (Optional, { _id, _index, _source }[])*: Sample documents to test in the pipeline.
2933-
** *`pipeline` (Optional, { description, on_failure, processors, version })*: Pipeline to test.
2933+
** *`pipeline` (Optional, { description, on_failure, processors, version, _meta })*: Pipeline to test.
29342934
If you don’t specify the `pipeline` request path parameter, this parameter is required.
29352935
If you specify both this and the request path parameter, the API only uses the request path parameter.
29362936
** *`verbose` (Optional, boolean)*: If `true`, the response includes output data for each processor in the executed pipeline.
@@ -2980,14 +2980,14 @@ Retrieves Logstash Pipelines used by Central Management
29802980
{ref}/logstash-api-get-pipeline.html[Endpoint documentation]
29812981
[source,ts]
29822982
----
2983-
client.logstash.getPipeline({ id })
2983+
client.logstash.getPipeline({ ... })
29842984
----
29852985

29862986
[discrete]
29872987
==== Arguments
29882988

29892989
* *Request (object):*
2990-
** *`id` (string | string[])*: List of pipeline identifiers.
2990+
** *`id` (Optional, string | string[])*: List of pipeline identifiers.
29912991

29922992
[discrete]
29932993
==== put_pipeline
@@ -3004,7 +3004,7 @@ client.logstash.putPipeline({ id })
30043004

30053005
* *Request (object):*
30063006
** *`id` (string)*: Identifier for the pipeline.
3007-
** *`pipeline` (Optional, { description, on_failure, processors, version })*
3007+
** *`pipeline` (Optional, { description, on_failure, processors, version, _meta })*
30083008

30093009
[discrete]
30103010
=== ml
@@ -4434,7 +4434,7 @@ client.queryRuleset.put({ ruleset_id, rules })
44344434
==== delete
44354435
Deletes a search application.
44364436

4437-
{ref}/put-search-application.html[Endpoint documentation]
4437+
{ref}/delete-search-application.html[Endpoint documentation]
44384438
[source,ts]
44394439
----
44404440
client.searchApplication.delete({ name })
@@ -5000,6 +5000,8 @@ client.transform.deleteTransform({ transform_id })
50005000
** *`transform_id` (string)*: Identifier for the transform.
50015001
** *`force` (Optional, boolean)*: If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
50025002
deleted regardless of its current state.
5003+
** *`delete_dest_index` (Optional, boolean)*: If this value is true, the destination index is deleted together with the transform. If false, the destination
5004+
index will not be deleted
50035005
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
50045006

50055007
[discrete]

src/api/api/eql.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export default class Eql {
7171

7272
/**
7373
* Returns async results from previously executed Event Query Language (EQL) search
74-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
74+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
7575
*/
7676
async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetResponse<TEvent>>
7777
async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetResponse<TEvent>, unknown>>
@@ -97,7 +97,7 @@ export default class Eql {
9797

9898
/**
9999
* Returns the status of a previously submitted async or stored Event Query Language (EQL) search
100-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
100+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
101101
*/
102102
async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetStatusResponse>
103103
async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetStatusResponse, unknown>>

src/api/api/indices.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ export default class Indices {
326326

327327
/**
328328
* Deletes an index template.
329-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
329+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html | Elasticsearch API documentation}
330330
*/
331331
async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteIndexTemplateResponse>
332332
async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteIndexTemplateResponse, unknown>>
@@ -411,7 +411,7 @@ export default class Indices {
411411

412412
/**
413413
* Returns information about whether a particular index template exists.
414-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
414+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html | Elasticsearch API documentation}
415415
*/
416416
async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsIndexTemplateResponse>
417417
async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExistsIndexTemplateResponse, unknown>>
@@ -589,7 +589,7 @@ export default class Indices {
589589

590590
/**
591591
* Returns an index template.
592-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
592+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html | Elasticsearch API documentation}
593593
*/
594594
async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetIndexTemplateResponse>
595595
async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetIndexTemplateResponse, unknown>>
@@ -844,7 +844,7 @@ export default class Indices {
844844

845845
/**
846846
* Creates or updates an index template.
847-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
847+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html | Elasticsearch API documentation}
848848
*/
849849
async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutIndexTemplateResponse>
850850
async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutIndexTemplateResponse, unknown>>
@@ -958,7 +958,7 @@ export default class Indices {
958958

959959
/**
960960
* Creates or updates an index template.
961-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
961+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html | Elasticsearch API documentation}
962962
*/
963963
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutTemplateResponse>
964964
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutTemplateResponse, unknown>>
@@ -1101,7 +1101,7 @@ export default class Indices {
11011101

11021102
/**
11031103
* Simulate matching the given index name against the index templates in the system
1104-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
1104+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html | Elasticsearch API documentation}
11051105
*/
11061106
async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesSimulateIndexTemplateResponse>
11071107
async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesSimulateIndexTemplateResponse, unknown>>
@@ -1139,7 +1139,7 @@ export default class Indices {
11391139

11401140
/**
11411141
* Simulate resolving the given template name or body
1142-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
1142+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html | Elasticsearch API documentation}
11431143
*/
11441144
async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesSimulateTemplateResponse>
11451145
async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesSimulateTemplateResponse, unknown>>

src/api/api/logstash.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,15 @@ export default class Logstash {
7373
* Retrieves Logstash Pipelines used by Central Management
7474
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/logstash-api-get-pipeline.html | Elasticsearch API documentation}
7575
*/
76-
async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LogstashGetPipelineResponse>
77-
async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LogstashGetPipelineResponse, unknown>>
78-
async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptions): Promise<T.LogstashGetPipelineResponse>
79-
async getPipeline (this: That, params: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptions): Promise<any> {
76+
async getPipeline (this: That, params?: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LogstashGetPipelineResponse>
77+
async getPipeline (this: That, params?: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LogstashGetPipelineResponse, unknown>>
78+
async getPipeline (this: That, params?: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptions): Promise<T.LogstashGetPipelineResponse>
79+
async getPipeline (this: That, params?: T.LogstashGetPipelineRequest | TB.LogstashGetPipelineRequest, options?: TransportRequestOptions): Promise<any> {
8080
const acceptedPath: string[] = ['id']
8181
const querystring: Record<string, any> = {}
8282
const body = undefined
8383

84+
params = params ?? {}
8485
for (const key in params) {
8586
if (acceptedPath.includes(key)) {
8687
continue

0 commit comments

Comments
 (0)