Auto-generated API code (#3253)

Author: elasticmachine

docs/reference/api-reference.md

@@ -1030,7 +1030,7 @@ client.index({ index })
 Get cluster info.
 
 Get basic build, version, and cluster information.
-::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.
+::: In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated. The version number is provided to maintain compatibility with existing clients, but it is not meaningful for assessing feature availability. Clients should detect a Serverless environment by checking for `build_flavor: serverless`.
 
 [Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info)
 
@@ -1331,7 +1331,7 @@ If the Elasticsearch security features are enabled, you must have the following
 * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.
 
 If reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster.
-If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from Elastic Cloud Hosted are allowed.
+If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from [Elastic Cloud Hosted](https://cloud.elastic.co/registration?page=docs&placement=docs-body) are allowed.
 Automatic data stream creation requires a matching index template with data stream enabled.
 
 The `dest` element can be configured like the index API to control optimistic concurrency control.
@@ -4783,6 +4783,22 @@ A query ID is also provided when the request was submitted with the `keep_on_com
 - **`drop_null_columns` (Optional, boolean)**: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
 If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
 
+## client.esql.deleteView [_esql.delete_view]
+Delete an ES|QL view.
+
+Deletes a stored ES|QL view.
+
+[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch#TODO)
+
+```ts
+client.esql.deleteView({ name })
+```
+
+### Arguments [_arguments_esql.delete_view]
+
+#### Request (object) [_request_esql.delete_view]
+- **`name` (string)**: The view name to remove.
+
 ## client.esql.getQuery [_esql.get_query]
 Get a specific running ES|QL query information.
 
@@ -4799,6 +4815,22 @@ client.esql.getQuery({ id })
 #### Request (object) [_request_esql.get_query]
 - **`id` (string)**: The query ID
 
+## client.esql.getView [_esql.get_view]
+Get an ES|QL view.
+
+Returns a stored ES|QL view.
+
+[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch#TODO)
+
+```ts
+client.esql.getView({ ... })
+```
+
+### Arguments [_arguments_esql.get_view]
+
+#### Request (object) [_request_esql.get_view]
+- **`name` (Optional, string)**: The comma-separated view names to retrieve.
+
 ## client.esql.listQueries [_esql.list_queries]
 Get running ES|QL queries information.
 
@@ -4811,6 +4843,21 @@ client.esql.listQueries()
 ```
 
 
+## client.esql.putView [_esql.put_view]
+Create or update an ES|QL view.
+
+[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch#TODO)
+
+```ts
+client.esql.putView({ name, query })
+```
+
+### Arguments [_arguments_esql.put_view]
+
+#### Request (object) [_request_esql.put_view]
+- **`name` (string)**: The view name to create or update.
+- **`query` (string)**: The ES|QL query string from which to create a view.
+
 ## client.esql.query [_esql.query]
 Run an ES|QL query.
 
@@ -8318,7 +8365,7 @@ client.inference.putContextualai({ task_type, contextualai_inference_id, service
 - **`contextualai_inference_id` (string)**: The unique identifier of the inference endpoint.
 - **`service` (Enum("contextualai"))**: The type of service supported for the specified task type. In this case, `contextualai`.
 - **`service_settings` ({ api_key, model_id, rate_limit })**: Settings used to install the inference model. These settings are specific to the `contextualai` service.
-- **`task_settings` (Optional, { instruction, return_documents, top_k })**: Settings to configure the inference task.
+- **`task_settings` (Optional, { instruction, top_k })**: Settings to configure the inference task.
 These settings are specific to the task type you specified.
 - **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
 

src/api/api/clear_scroll.ts

@@ -30,7 +30,9 @@ const commonQueryParams = ['error_trace', 'filter_path', 'human', 'pretty']
 
 const acceptedParams: Record<string, { path: string[], body: string[], query: string[] }> = {
   clear_scroll: {
-    path: [],
+    path: [
+      'scroll_id'
+    ],
     body: [
       'scroll_id'
     ],

src/api/api/info.ts

@@ -35,7 +35,7 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
 }
 
 /**
-  * Get cluster info. Get basic build, version, and cluster information. ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.
+  * Get cluster info. Get basic build, version, and cluster information. ::: In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated. The version number is provided to maintain compatibility with existing clients, but it is not meaningful for assessing feature availability. Clients should detect a Serverless environment by checking for `build_flavor: serverless`.
   * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info | Elasticsearch API documentation}
   */
 export default async function InfoApi (this: That, params?: T.InfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InfoResponse>

src/api/api/ml.ts

@@ -654,7 +654,9 @@ export default class Ml {
         query: []
       },
       'ml.put_job': {
-        path: [],
+        path: [
+          'job_id'
+        ],
         body: [
           'allow_lazy_open',
           'analysis_config',
@@ -665,7 +667,6 @@ export default class Ml {
           'data_description',
           'datafeed_config',
           'description',
-          'job_id',
           'groups',
           'model_plot_config',
           'model_snapshot_retention_days',
@@ -766,9 +767,10 @@ export default class Ml {
         ]
       },
       'ml.start_data_frame_analytics': {
-        path: [],
+        path: [
+          'id'
+        ],
         body: [
-          'id',
           'timeout'
         ],
         query: [
@@ -809,9 +811,10 @@ export default class Ml {
         ]
       },
       'ml.stop_data_frame_analytics': {
-        path: [],
+        path: [
+          'id'
+        ],
         body: [
-          'id',
           'allow_no_match',
           'force',
           'timeout'
@@ -3969,7 +3972,7 @@ export default class Ml {
       },
       acceptedParams: {
         path: ['job_id'],
-        body: ['allow_lazy_open', 'analysis_config', 'analysis_limits', 'background_persist_interval', 'custom_settings', 'daily_model_snapshot_retention_after_days', 'data_description', 'datafeed_config', 'description', 'job_id', 'groups', 'model_plot_config', 'model_snapshot_retention_days', 'renormalization_window_days', 'results_index_name', 'results_retention_days'],
+        body: ['allow_lazy_open', 'analysis_config', 'analysis_limits', 'background_persist_interval', 'custom_settings', 'daily_model_snapshot_retention_after_days', 'data_description', 'datafeed_config', 'description', 'groups', 'model_plot_config', 'model_snapshot_retention_days', 'renormalization_window_days', 'results_index_name', 'results_retention_days'],
         query: ['allow_no_indices', 'expand_wildcards', 'ignore_throttled', 'ignore_unavailable']
       }
     }
@@ -4430,7 +4433,7 @@ export default class Ml {
       },
       acceptedParams: {
         path: ['id'],
-        body: ['id', 'timeout'],
+        body: ['timeout'],
         query: ['timeout']
       }
     }
@@ -4616,7 +4619,7 @@ export default class Ml {
       },
       acceptedParams: {
         path: ['id'],
-        body: ['id', 'allow_no_match', 'force', 'timeout'],
+        body: ['allow_no_match', 'force', 'timeout'],
         query: ['allow_no_match', 'force', 'timeout']
       }
     }

src/api/api/reindex.ts

@@ -53,7 +53,7 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
 }
 
 /**
-  * Reindex documents. Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. The destination should be configured as wanted before calling the reindex API. Reindex does not copy the settings from the source or its associated template. Mappings, shard counts, and replicas, for example, must be configured ahead of time. If the Elasticsearch security features are enabled, you must have the following security privileges: * The `read` index privilege for the source data stream, index, or alias. * The `write` index privilege for the destination data stream, index, or index alias. * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias. If reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster. If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from Elastic Cloud Hosted are allowed. Automatic data stream creation requires a matching index template with data stream enabled. The `dest` element can be configured like the index API to control optimistic concurrency control. Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID. Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source. Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. All existing documents will cause a version conflict. IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. A reindex can only add new documents to a destination data stream. It cannot update existing documents in a destination data stream. By default, version conflicts abort the reindex process. To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. In this case, the response includes a count of the version conflicts that were encountered. Note that the handling of other error types is unaffected by the `conflicts` property. Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index. Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause. Refer to the linked documentation for examples of how to reindex documents.
+  * Reindex documents. Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. The destination should be configured as wanted before calling the reindex API. Reindex does not copy the settings from the source or its associated template. Mappings, shard counts, and replicas, for example, must be configured ahead of time. If the Elasticsearch security features are enabled, you must have the following security privileges: * The `read` index privilege for the source data stream, index, or alias. * The `write` index privilege for the destination data stream, index, or index alias. * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias. If reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster. If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from [Elastic Cloud Hosted](https://cloud.elastic.co/registration?page=docs&placement=docs-body) are allowed. Automatic data stream creation requires a matching index template with data stream enabled. The `dest` element can be configured like the index API to control optimistic concurrency control. Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID. Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source. Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. All existing documents will cause a version conflict. IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. A reindex can only add new documents to a destination data stream. It cannot update existing documents in a destination data stream. By default, version conflicts abort the reindex process. To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. In this case, the response includes a count of the version conflicts that were encountered. Note that the handling of other error types is unaffected by the `conflicts` property. Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index. Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause. Refer to the linked documentation for examples of how to reindex documents.
   * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex | Elasticsearch API documentation}
   */
 export default async function ReindexApi (this: That, params: T.ReindexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexResponse>

src/api/api/render_search_template.ts

@@ -30,9 +30,10 @@ const commonQueryParams = ['error_trace', 'filter_path', 'human', 'pretty']
 
 const acceptedParams: Record<string, { path: string[], body: string[], query: string[] }> = {
   render_search_template: {
-    path: [],
+    path: [
+      'id'
+    ],
     body: [
-      'id',
       'file',
       'params',
       'source'
@@ -104,7 +105,7 @@ export default async function RenderSearchTemplateApi (this: That, params?: T.Re
     },
     acceptedParams: {
       path: ['id'],
-      body: ['id', 'file', 'params', 'source'],
+      body: ['file', 'params', 'source'],
       query: []
     }
   }

src/api/api/scroll.ts

@@ -30,7 +30,9 @@ const commonQueryParams = ['error_trace', 'filter_path', 'human', 'pretty']
 
 const acceptedParams: Record<string, { path: string[], body: string[], query: string[] }> = {
   scroll: {
-    path: [],
+    path: [
+      'scroll_id'
+    ],
     body: [
       'scroll',
       'scroll_id'

src/api/api/security.ts

@@ -499,9 +499,10 @@ export default class Security {
         ]
       },
       'security.put_user': {
-        path: [],
+        path: [
+          'username'
+        ],
         body: [
-          'username',
           'email',
           'full_name',
           'metadata',
@@ -3476,7 +3477,7 @@ export default class Security {
       },
       acceptedParams: {
         path: ['username'],
-        body: ['username', 'email', 'full_name', 'metadata', 'password', 'password_hash', 'roles', 'enabled'],
+        body: ['email', 'full_name', 'metadata', 'password', 'password_hash', 'roles', 'enabled'],
         query: ['refresh']
       }
     }