Skip to content

Commit 33fac68

Browse files
Auto-generated API code
1 parent 8b9fab9 commit 33fac68

File tree

12 files changed

+61
-57
lines changed

12 files changed

+61
-57
lines changed

docs/reference/api-reference.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,6 @@ client.getSource({ id, index })
831831
- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
832832
- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude in the response.
833833
- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response.
834-
- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit.
835834
- **`version` (Optional, number)**: The version number for concurrency control. It must match the current version of the document for the request to succeed.
836835
- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type.
837836

@@ -1014,6 +1013,7 @@ client.index({ index })
10141013
- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type.
10151014
- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.
10161015
- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias.
1016+
- **`require_data_stream` (Optional, boolean)**: If `true`, the request's actions must target a data stream (existing or to be created).
10171017

10181018
## client.info [_info]
10191019
Get cluster info.
@@ -3464,6 +3464,7 @@ client.cluster.getComponentTemplate({ ... })
34643464
- **`name` (Optional, string)**: List of component template names used to limit the request.
34653465
Wildcard (`*`) expressions are supported.
34663466
- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format.
3467+
- **`settings_filter` (Optional, string \| string[])**: Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
34673468
- **`include_defaults` (Optional, boolean)**: Return all default configurations for the component template (default: false)
34683469
- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only.
34693470
If `false`, information is retrieved from the master node.
@@ -3648,6 +3649,7 @@ To unset `_meta`, replace the template without specifying this information.
36483649
- **`deprecated` (Optional, boolean)**: Marks this index template as deprecated. When creating or updating a non-deprecated index template
36493650
that uses deprecated components, Elasticsearch will emit a deprecation warning.
36503651
- **`create` (Optional, boolean)**: If `true`, this request cannot replace or update existing component templates.
3652+
- **`cause` (Optional, string)**: User defined reason for create the component template.
36513653
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
36523654
If no response is received before the timeout expires, the request fails and returns an error.
36533655

@@ -7858,7 +7860,7 @@ The only valid task type for the model to perform is `text_embedding`.
78587860
- **`service_settings` ({ api_key, api_version, model_id, project_id, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `watsonxai` service.
78597861

78607862
## client.inference.rerank [_inference.rerank]
7861-
Perform rereanking inference on the service
7863+
Perform reranking inference on the service
78627864

78637865
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference)
78647866

@@ -8066,9 +8068,6 @@ client.ingest.getIpLocationDatabase({ ... })
80668068
- **`id` (Optional, string \| string[])**: List of database configuration IDs to retrieve.
80678069
Wildcard (`*`) expressions are supported.
80688070
To get all database configurations, omit this parameter or use `*`.
8069-
- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node.
8070-
If no response is received before the timeout expires, the request fails and returns an error.
8071-
A value of `-1` indicates that the request should never time out.
80728071

80738072
## client.ingest.getPipeline [_ingest.get_pipeline]
80748073
Get pipelines.
@@ -8327,7 +8326,7 @@ client.license.postStartTrial({ ... })
83278326

83288327
#### Request (object) [_request_license.post_start_trial]
83298328
- **`acknowledge` (Optional, boolean)**: whether the user has acknowledged acknowledge messages (default: false)
8330-
- **`type_query_string` (Optional, string)**
8329+
- **`type` (Optional, string)**: The type of trial license to generate (default: "trial")
83318330
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
83328331

83338332
## client.logstash.deletePipeline [_logstash.delete_pipeline]
@@ -12007,15 +12006,9 @@ To check whether a user has a specific list of privileges, use the has privilege
1200712006
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user-privileges)
1200812007

1200912008
```ts
12010-
client.security.getUserPrivileges({ ... })
12009+
client.security.getUserPrivileges()
1201112010
```
1201212011

12013-
### Arguments [_arguments_security.get_user_privileges]
12014-
12015-
#### Request (object) [_request_security.get_user_privileges]
12016-
- **`application` (Optional, string)**: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.
12017-
- **`priviledge` (Optional, string)**: The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.
12018-
- **`username` (Optional, string \| null)**
1201912012

1202012013
## client.security.getUserProfile [_security.get_user_profile]
1202112014
Get a user profile.
@@ -12086,6 +12079,10 @@ It is not valid with other grant types.
1208612079
If you specify the `password` grant type, this parameter is required.
1208712080
It is not valid with other grant types.
1208812081
- **`run_as` (Optional, string)**: The name of the user to be impersonated.
12082+
- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If 'true', Elasticsearch refreshes the affected shards to make this operation
12083+
visible to search.
12084+
If 'wait_for', it waits for a refresh to make this operation visible to search.
12085+
If 'false', nothing is done with refreshes.
1208912086

1209012087
## client.security.hasPrivileges [_security.has_privileges]
1209112088
Check user privileges.
@@ -13391,6 +13388,8 @@ It also accepts wildcards (`*`).
1339113388
- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node.
1339213389
If the master node is not available before the timeout expires, the request fails and returns an error.
1339313390
To indicate that the request should never timeout, set it to `-1`.
13391+
- **`wait_for_completion` (Optional, boolean)**: If `true`, the request returns a response when the matching snapshots are all deleted.
13392+
If `false`, the request returns a response as soon as the deletes are scheduled.
1339413393

1339513394
## client.snapshot.deleteRepository [_snapshot.delete_repository]
1339613395
Delete snapshot repositories.

src/api/api/cluster.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ export default class Cluster {
8484
body: [],
8585
query: [
8686
'flat_settings',
87+
'settings_filter',
8788
'include_defaults',
8889
'local',
8990
'master_timeout'
@@ -155,6 +156,7 @@ export default class Cluster {
155156
],
156157
query: [
157158
'create',
159+
'cause',
158160
'master_timeout'
159161
]
160162
},

src/api/api/get_source.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
4141
'_source',
4242
'_source_excludes',
4343
'_source_includes',
44-
'stored_fields',
4544
'version',
4645
'version_type'
4746
]

src/api/api/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
4949
'version',
5050
'version_type',
5151
'wait_for_active_shards',
52-
'require_alias'
52+
'require_alias',
53+
'require_data_stream'
5354
]
5455
}
5556
}

src/api/api/inference.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1626,7 +1626,7 @@ export default class Inference {
16261626
}
16271627

16281628
/**
1629-
* Perform rereanking inference on the service
1629+
* Perform reranking inference on the service
16301630
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference | Elasticsearch API documentation}
16311631
*/
16321632
async rerank (this: That, params: T.InferenceRerankRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceRerankResponse>

src/api/api/ingest.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,7 @@ export default class Ingest {
8282
'id'
8383
],
8484
body: [],
85-
query: [
86-
'master_timeout'
87-
]
85+
query: []
8886
},
8987
'ingest.get_pipeline': {
9088
path: [

src/api/api/license.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export default class License {
8787
body: [],
8888
query: [
8989
'acknowledge',
90-
'type_query_string',
90+
'type',
9191
'master_timeout'
9292
]
9393
}

src/api/api/reindex.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
4444
'requests_per_second',
4545
'scroll',
4646
'slices',
47+
'max_docs',
4748
'timeout',
4849
'wait_for_active_shards',
4950
'wait_for_completion',

src/api/api/search_mvt.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
6060
'grid_precision',
6161
'grid_type',
6262
'size',
63+
'track_total_hits',
6364
'with_labels'
6465
]
6566
}

src/api/api/security.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -351,11 +351,7 @@ export default class Security {
351351
'security.get_user_privileges': {
352352
path: [],
353353
body: [],
354-
query: [
355-
'application',
356-
'priviledge',
357-
'username'
358-
]
354+
query: []
359355
},
360356
'security.get_user_profile': {
361357
path: [
@@ -376,7 +372,9 @@ export default class Security {
376372
'password',
377373
'run_as'
378374
],
379-
query: []
375+
query: [
376+
'refresh'
377+
]
380378
},
381379
'security.has_privileges': {
382380
path: [

0 commit comments

Comments
 (0)