diff --git a/compiler/src/model/utils.ts b/compiler/src/model/utils.ts index 769de32bfc..9f4d3e669e 100644 --- a/compiler/src/model/utils.ts +++ b/compiler/src/model/utils.ts @@ -667,7 +667,7 @@ export function hoistRequestAnnotations ( } else if (tag === 'cluster_privileges') { const privileges = [ 'all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', - 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', + 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 67c12225ee..5dd6684516 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -14997,6 +14997,7 @@ "inference" ], "summary": "Create an inference endpoint", + "description": "When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "operationId": "inference-put", "parameters": [ { @@ -15089,6 +15090,7 @@ "inference" ], "summary": "Create an inference endpoint", + "description": "When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "operationId": "inference-put-1", "parameters": [ { @@ -16180,7 +16182,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline-1", "parameters": [ { @@ -16198,13 +16204,17 @@ "tags": [ "logstash" ], - "summary": "Creates or updates a pipeline used for Logstash Central Management", + "summary": "Create or update a Logstash pipeline", + "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-put-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -16237,13 +16247,17 @@ "tags": [ "logstash" ], - "summary": "Deletes a pipeline used for Logstash Central Management", + "summary": "Delete a Logstash pipeline", + "description": "Delete a pipeline that is used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-delete-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -16268,7 +16282,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline", "responses": { "200": { @@ -16477,7 +16495,8 @@ "tags": [ "migration" ], - "summary": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version", + "summary": "Get deprecation information", + "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-deprecations", "responses": { "200": { @@ -16492,7 +16511,8 @@ "tags": [ "migration" ], - "summary": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version", + "summary": "Get deprecation information", + "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-deprecations-1", "parameters": [ { @@ -16512,7 +16532,8 @@ "tags": [ "migration" ], - "summary": "Find out whether system features need to be upgraded or not", + "summary": "Get feature migration information", + "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "operationId": "migration-get-feature-upgrade-status", "responses": { "200": { @@ -16547,7 +16568,8 @@ "tags": [ "migration" ], - "summary": "Begin upgrades for system features", + "summary": "Start the feature migration", + "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "operationId": "migration-post-feature-upgrade", "responses": { "200": { @@ -20409,8 +20431,8 @@ "tags": [ "ml" ], - "summary": "Return ML defaults and limits", - "description": "Returns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "summary": "Get machine learning information", + "description": "Get defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "operationId": "ml-info", "responses": { "200": { @@ -22586,9 +22608,9 @@ "/_ml/anomaly_detectors/_validate/detector": { "post": { "tags": [ - "ml" + "ml anomaly" ], - "summary": "Validates an anomaly detection detector", + "summary": "Validate an anomaly detection job", "operationId": "ml-validate-detector", "requestBody": { "content": { @@ -22620,7 +22642,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-1", "parameters": [ { @@ -22647,7 +22670,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk", "parameters": [ { @@ -22676,7 +22700,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-3", "parameters": [ { @@ -22706,7 +22731,8 @@ "tags": [ "monitoring" ], - "summary": "Used by the monitoring features to send monitoring data", + "summary": "Send monitoring data", + "description": "This API is used by the monitoring features to send monitoring data.", "operationId": "monitoring-bulk-2", "parameters": [ { @@ -25207,7 +25233,8 @@ "tags": [ "rollup" ], - "summary": "Retrieves the configuration, stats, and status of rollup jobs", + "summary": "Get rollup job information", + "description": "Get the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "operationId": "rollup-get-jobs", "parameters": [ { @@ -25225,7 +25252,8 @@ "tags": [ "rollup" ], - "summary": "Creates a rollup job", + "summary": "Create a rollup job", + "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "operationId": "rollup-put-job", "parameters": [ { @@ -25308,7 +25336,8 @@ "tags": [ "rollup" ], - "summary": "Deletes an existing rollup job", + "summary": "Delete a rollup job", + "description": "A job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "operationId": "rollup-delete-job", "parameters": [ { @@ -25357,7 +25386,8 @@ "tags": [ "rollup" ], - "summary": "Retrieves the configuration, stats, and status of rollup jobs", + "summary": "Get rollup job information", + "description": "Get the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "operationId": "rollup-get-jobs-1", "responses": { "200": { @@ -25372,7 +25402,8 @@ "tags": [ "rollup" ], - "summary": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern", + "summary": "Get the rollup job capabilities", + "description": "Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "operationId": "rollup-get-rollup-caps", "parameters": [ { @@ -25392,7 +25423,8 @@ "tags": [ "rollup" ], - "summary": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern", + "summary": "Get the rollup job capabilities", + "description": "Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "operationId": "rollup-get-rollup-caps-1", "responses": { "200": { @@ -25407,7 +25439,8 @@ "tags": [ "rollup" ], - "summary": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored)", + "summary": "Get the rollup index capabilities", + "description": "Get the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "operationId": "rollup-get-rollup-index-caps", "parameters": [ { @@ -25445,7 +25478,8 @@ "tags": [ "rollup" ], - "summary": "Enables searching rolled-up data using the standard Query DSL", + "summary": "Search rolled-up data", + "description": "The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "operationId": "rollup-rollup-search", "parameters": [ { @@ -25472,7 +25506,8 @@ "tags": [ "rollup" ], - "summary": "Enables searching rolled-up data using the standard Query DSL", + "summary": "Search rolled-up data", + "description": "The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "operationId": "rollup-rollup-search-1", "parameters": [ { @@ -25501,7 +25536,8 @@ "tags": [ "rollup" ], - "summary": "Starts an existing, stopped rollup job", + "summary": "Start rollup jobs", + "description": "If you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "operationId": "rollup-start-job", "parameters": [ { @@ -25544,7 +25580,8 @@ "tags": [ "rollup" ], - "summary": "Stops an existing, started rollup job", + "summary": "Stop rollup jobs", + "description": "If you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "operationId": "rollup-stop-job", "parameters": [ { @@ -27110,7 +27147,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve node-level cache statistics about searchable snapshots", + "summary": "Get cache statistics", + "description": "Get statistics about the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-cache-stats", "parameters": [ { @@ -27130,7 +27168,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve node-level cache statistics about searchable snapshots", + "summary": "Get cache statistics", + "description": "Get statistics about the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-cache-stats-1", "parameters": [ { @@ -27153,7 +27192,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Clear the cache of searchable snapshots", + "summary": "Clear the cache", + "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-clear-cache", "parameters": [ { @@ -27185,7 +27225,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Clear the cache of searchable snapshots", + "summary": "Clear the cache", + "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-clear-cache-1", "parameters": [ { @@ -27220,7 +27261,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Mount a snapshot as a searchable index", + "summary": "Mount a snapshot", + "description": "Mount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "operationId": "searchable-snapshots-mount", "parameters": [ { @@ -27337,7 +27379,7 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve shard-level statistics about searchable snapshots", + "summary": "Get searchable snapshot statistics", "operationId": "searchable-snapshots-stats", "parameters": [ { @@ -27357,7 +27399,7 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve shard-level statistics about searchable snapshots", + "summary": "Get searchable snapshot statistics", "operationId": "searchable-snapshots-stats-1", "parameters": [ { @@ -30925,8 +30967,8 @@ "tags": [ "shutdown" ], - "summary": "Retrieve status of a node or nodes that are currently marked as shutting down", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Get the shutdown status", + "description": "Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "operationId": "shutdown-get-node-1", "parameters": [ { @@ -30950,8 +30992,8 @@ "tags": [ "shutdown" ], - "summary": "Adds a node to be shut down", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Prepare a node to be shut down", + "description": "NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", "operationId": "shutdown-put-node", "parameters": [ { @@ -31035,8 +31077,8 @@ "tags": [ "shutdown" ], - "summary": "Removes a node from the shutdown list", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Cancel node shutdown preparations", + "description": "Remove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "operationId": "shutdown-delete-node", "parameters": [ { @@ -31091,8 +31133,8 @@ "tags": [ "shutdown" ], - "summary": "Retrieve status of a node or nodes that are currently marked as shutting down", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Get the shutdown status", + "description": "Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "operationId": "shutdown-get-node", "parameters": [ { @@ -31115,7 +31157,8 @@ "tags": [ "slm" ], - "summary": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts", + "summary": "Get policy information", + "description": "Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "operationId": "slm-get-lifecycle", "parameters": [ { @@ -31133,13 +31176,14 @@ "tags": [ "slm" ], - "summary": "Creates or updates a snapshot lifecycle policy", + "summary": "Create or update a policy", + "description": "Create or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", "operationId": "slm-put-lifecycle", "parameters": [ { "in": "path", "name": "policy_id", - "description": "ID for the snapshot lifecycle policy you want to create or update.", + "description": "The identifier for the snapshot lifecycle policy you want to create or update.", "required": true, "deprecated": false, "schema": { @@ -31213,7 +31257,8 @@ "tags": [ "slm" ], - "summary": "Deletes an existing snapshot lifecycle policy", + "summary": "Delete a policy", + "description": "Delete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", "operationId": "slm-delete-lifecycle", "parameters": [ { @@ -31248,7 +31293,8 @@ "tags": [ "slm" ], - "summary": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time", + "summary": "Run a policy", + "description": "Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", "operationId": "slm-execute-lifecycle", "parameters": [ { @@ -31291,7 +31337,8 @@ "tags": [ "slm" ], - "summary": "Deletes any snapshots that are expired according to the policy's retention rules", + "summary": "Run a retention policy", + "description": "Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", "operationId": "slm-execute-retention", "responses": { "200": { @@ -31313,7 +31360,8 @@ "tags": [ "slm" ], - "summary": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts", + "summary": "Get policy information", + "description": "Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "operationId": "slm-get-lifecycle-1", "responses": { "200": { @@ -31328,7 +31376,8 @@ "tags": [ "slm" ], - "summary": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management", + "summary": "Get snapshot lifecycle management statistics", + "description": "Get global and policy-level statistics about actions taken by snapshot lifecycle management.", "operationId": "slm-get-stats", "responses": { "200": { @@ -31397,7 +31446,7 @@ "tags": [ "slm" ], - "summary": "Retrieves the status of snapshot lifecycle management (SLM)", + "summary": "Get the snapshot lifecycle management status", "operationId": "slm-get-status", "responses": { "200": { @@ -31427,7 +31476,8 @@ "tags": [ "slm" ], - "summary": "Turns on snapshot lifecycle management (SLM)", + "summary": "Start snapshot lifecycle management", + "description": "Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", "operationId": "slm-start", "responses": { "200": { @@ -31449,7 +31499,8 @@ "tags": [ "slm" ], - "summary": "Turns off snapshot lifecycle management (SLM)", + "summary": "Stop snapshot lifecycle management", + "description": "Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", "operationId": "slm-stop", "responses": { "200": { @@ -31471,7 +31522,11 @@ "tags": [ "snapshot" ], - "summary": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots", + "summary": "Clean up the snapshot repository", + "description": "Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-cleanup" + }, "operationId": "snapshot-cleanup-repository", "parameters": [ { @@ -31534,7 +31589,8 @@ "tags": [ "snapshot" ], - "summary": "Clones indices from one snapshot into another snapshot in the same repository", + "summary": "Clone a snapshot", + "description": "Clone part of all of a snapshot into another snapshot in the same repository.", "operationId": "snapshot-clone", "parameters": [ { @@ -31628,7 +31684,7 @@ "tags": [ "snapshot" ], - "summary": "Returns information about a snapshot", + "summary": "Get snapshot information", "operationId": "snapshot-get", "parameters": [ { @@ -31828,7 +31884,11 @@ "tags": [ "snapshot" ], - "summary": "Creates a snapshot in a repository", + "summary": "Create a snapshot", + "description": "Take a snapshot of a cluster or of data streams and indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html" + }, "operationId": "snapshot-create", "parameters": [ { @@ -31858,7 +31918,11 @@ "tags": [ "snapshot" ], - "summary": "Creates a snapshot in a repository", + "summary": "Create a snapshot", + "description": "Take a snapshot of a cluster or of data streams and indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html" + }, "operationId": "snapshot-create-1", "parameters": [ { @@ -31888,7 +31952,7 @@ "tags": [ "snapshot" ], - "summary": "Deletes one or more snapshots", + "summary": "Delete snapshots", "operationId": "snapshot-delete", "parameters": [ { @@ -31943,7 +32007,7 @@ "tags": [ "snapshot" ], - "summary": "Returns information about a repository", + "summary": "Get snapshot repository information", "operationId": "snapshot-get-repository-1", "parameters": [ { @@ -31967,7 +32031,11 @@ "tags": [ "snapshot" ], - "summary": "Creates a repository", + "summary": "Create or update a snapshot repository", + "description": "IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html" + }, "operationId": "snapshot-create-repository", "parameters": [ { @@ -31997,7 +32065,11 @@ "tags": [ "snapshot" ], - "summary": "Creates a repository", + "summary": "Create or update a snapshot repository", + "description": "IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html" + }, "operationId": "snapshot-create-repository-1", "parameters": [ { @@ -32027,7 +32099,8 @@ "tags": [ "snapshot" ], - "summary": "Deletes a repository", + "summary": "Delete snapshot repositories", + "description": "When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", "operationId": "snapshot-delete-repository", "parameters": [ { @@ -32082,7 +32155,7 @@ "tags": [ "snapshot" ], - "summary": "Returns information about a repository", + "summary": "Get snapshot repository information", "operationId": "snapshot-get-repository", "parameters": [ { @@ -32105,7 +32178,8 @@ "tags": [ "snapshot" ], - "summary": "Verifies the integrity of the contents of a snapshot repository", + "summary": "Verify the repository integrity", + "description": "Verify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.", "operationId": "snapshot-repository-verify-integrity", "parameters": [ { @@ -32220,7 +32294,11 @@ "tags": [ "snapshot" ], - "summary": "Restores a snapshot", + "summary": "Restore a snapshot", + "description": "Restore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html" + }, "operationId": "snapshot-restore", "parameters": [ { @@ -32341,7 +32419,8 @@ "tags": [ "snapshot" ], - "summary": "Returns information about the status of a snapshot", + "summary": "Get the snapshot status", + "description": "Get a detailed description of the current state for each shard participating in the snapshot.\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "operationId": "snapshot-status", "parameters": [ { @@ -32364,7 +32443,8 @@ "tags": [ "snapshot" ], - "summary": "Returns information about the status of a snapshot", + "summary": "Get the snapshot status", + "description": "Get a detailed description of the current state for each shard participating in the snapshot.\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "operationId": "snapshot-status-1", "parameters": [ { @@ -32390,7 +32470,8 @@ "tags": [ "snapshot" ], - "summary": "Returns information about the status of a snapshot", + "summary": "Get the snapshot status", + "description": "Get a detailed description of the current state for each shard participating in the snapshot.\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "operationId": "snapshot-status-2", "parameters": [ { @@ -32419,7 +32500,11 @@ "tags": [ "snapshot" ], - "summary": "Verifies a repository", + "summary": "Verify a snapshot repository", + "description": "Check for common misconfigurations in a snapshot repository.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-verification" + }, "operationId": "snapshot-verify-repository", "parameters": [ { @@ -72332,34 +72417,37 @@ "type": "object", "properties": { "description": { - "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "type": "string" }, "last_modified": { "$ref": "#/components/schemas/_types:DateTime" }, - "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types:PipelineMetadata" - }, - "username": { - "description": "User who last updated the pipeline.", - "type": "string" - }, "pipeline": { - "description": "Configuration for the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + }, + "description": "The configuration for the pipeline.", "type": "string" }, + "pipeline_metadata": { + "$ref": "#/components/schemas/logstash._types:PipelineMetadata" + }, "pipeline_settings": { "$ref": "#/components/schemas/logstash._types:PipelineSettings" + }, + "username": { + "description": "The user who last updated the pipeline.", + "type": "string" } }, "required": [ "description", "last_modified", - "pipeline_metadata", - "username", "pipeline", - "pipeline_settings" + "pipeline_metadata", + "pipeline_settings", + "username" ] }, "logstash._types:PipelineMetadata": { @@ -98266,7 +98354,7 @@ "logstash.get_pipeline#id": { "in": "path", "name": "id", - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "required": true, "deprecated": false, "schema": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index a30dc8511f..f55f7a87e6 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -8579,6 +8579,7 @@ "inference" ], "summary": "Create an inference endpoint", + "description": "When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "operationId": "inference-put", "parameters": [ { @@ -8671,6 +8672,7 @@ "inference" ], "summary": "Create an inference endpoint", + "description": "When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "operationId": "inference-put-1", "parameters": [ { @@ -9235,7 +9237,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline-1", "parameters": [ { @@ -9253,13 +9259,17 @@ "tags": [ "logstash" ], - "summary": "Creates or updates a pipeline used for Logstash Central Management", + "summary": "Create or update a Logstash pipeline", + "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-put-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -9292,13 +9302,17 @@ "tags": [ "logstash" ], - "summary": "Deletes a pipeline used for Logstash Central Management", + "summary": "Delete a Logstash pipeline", + "description": "Delete a pipeline that is used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-delete-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -9323,7 +9337,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline", "responses": { "200": { @@ -48027,34 +48045,37 @@ "type": "object", "properties": { "description": { - "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "type": "string" }, "last_modified": { "$ref": "#/components/schemas/_types:DateTime" }, - "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types:PipelineMetadata" - }, - "username": { - "description": "User who last updated the pipeline.", - "type": "string" - }, "pipeline": { - "description": "Configuration for the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + }, + "description": "The configuration for the pipeline.", "type": "string" }, + "pipeline_metadata": { + "$ref": "#/components/schemas/logstash._types:PipelineMetadata" + }, "pipeline_settings": { "$ref": "#/components/schemas/logstash._types:PipelineSettings" + }, + "username": { + "description": "The user who last updated the pipeline.", + "type": "string" } }, "required": [ "description", "last_modified", - "pipeline_metadata", - "username", "pipeline", - "pipeline_settings" + "pipeline_metadata", + "pipeline_settings", + "username" ] }, "logstash._types:PipelineMetadata": { @@ -60258,7 +60279,7 @@ "logstash.get_pipeline#id": { "in": "path", "name": "id", - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "required": true, "deprecated": false, "schema": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 818d229e40..70645d7f69 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -4293,9 +4293,14 @@ "visibility": "public" } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", "name": "inference.put", + "privileges": { + "cluster": [ + "manage_inference" + ] + }, "request": { "name": "Request", "namespace": "inference.put" @@ -4610,8 +4615,10 @@ "stability": "stable" } }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -4650,8 +4657,10 @@ "stability": "stable" } }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -4696,8 +4705,10 @@ "stability": "stable" } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -24702,7 +24713,7 @@ } } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "inherits": { "type": { "name": "RequestBase", @@ -24741,7 +24752,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L44" + "specLocation": "inference/put/PutRequest.ts#L25-L54" }, { "body": { @@ -25447,7 +25458,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -25461,7 +25472,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -25474,7 +25485,7 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L37" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L40" }, { "body": { @@ -25494,7 +25505,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -25508,7 +25519,7 @@ }, "path": [ { - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "name": "id", "required": false, "type": { @@ -25521,7 +25532,7 @@ } ], "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L37" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L40" }, { "body": { @@ -25567,7 +25578,7 @@ } } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "inherits": { "type": { "name": "RequestBase", @@ -25581,7 +25592,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -25594,7 +25605,7 @@ } ], "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L39" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L44" }, { "body": { @@ -126399,7 +126410,7 @@ }, "properties": [ { - "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "name": "description", "required": true, "type": { @@ -126411,7 +126422,7 @@ } }, { - "description": "Date the pipeline was last updated.\nMust be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", "name": "last_modified", "required": true, "type": { @@ -126423,59 +126434,59 @@ } }, { - "description": "Optional metadata about the pipeline.\nMay have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", - "name": "pipeline_metadata", + "description": "The configuration for the pipeline.", + "extDocId": "logstash-configuration-file-structure", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", + "name": "pipeline", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineMetadata", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "User who last updated the pipeline.", - "name": "username", + "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "name": "pipeline_metadata", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineMetadata", + "namespace": "logstash._types" } } }, { - "description": "Configuration for the pipeline.", - "docId": "logstash-configuration-file-structure", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", - "name": "pipeline", + "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", + "extDocId": "logstash-logstash-settings-file", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", + "name": "pipeline_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineSettings", + "namespace": "logstash._types" } } }, { - "description": "Settings for the pipeline.\nSupports only flat keys in dot notation.", - "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", - "name": "pipeline_settings", + "description": "The user who last updated the pipeline.", + "name": "username", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineSettings", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "logstash/_types/Pipeline.ts#L60-L92" + "specLocation": "logstash/_types/Pipeline.ts#L60-L91" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 0b4529e68f..f1c69fffa9 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8525,9 +8525,14 @@ "visibility": "public" } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", "name": "inference.put", + "privileges": { + "cluster": [ + "manage_inference" + ] + }, "request": { "name": "Request", "namespace": "inference.put" @@ -9369,8 +9374,10 @@ "stability": "stable" } }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -9409,8 +9416,10 @@ "stability": "stable" } }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -9455,8 +9464,10 @@ "stability": "stable" } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -9546,9 +9557,14 @@ "stability": "stable" } }, - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "name": "migration.deprecations", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "migration.deprecations" @@ -9583,10 +9599,13 @@ "stability": "stable" } }, - "description": "Find out whether system features need to be upgraded or not", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.get_feature_upgrade_status", "privileges": { + "cluster": [ + "manage" + ], "index": [ "manage" ] @@ -9619,10 +9638,13 @@ "stability": "stable" } }, - "description": "Begin upgrades for system features", + "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.post_feature_upgrade", "privileges": { + "cluster": [ + "manage" + ], "index": [ "manage" ] @@ -11429,7 +11451,7 @@ "stability": "stable" } }, - "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "name": "ml.info", "privileges": { @@ -12908,7 +12930,8 @@ "visibility": "private" } }, - "description": "Validates an anomaly detection detector.", + "description": "Validate an anomaly detection job.", + "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate_detector", "request": { @@ -12939,10 +12962,11 @@ "availability": { "stack": { "since": "6.3.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, - "description": "Used by the monitoring features to send monitoring data.", + "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "name": "monitoring.bulk", "request": { @@ -14202,9 +14226,14 @@ "stability": "experimental" } }, - "description": "Deletes an existing rollup job.", + "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "name": "rollup.delete_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.delete_job" @@ -14233,9 +14262,14 @@ "stability": "experimental" } }, - "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "name": "rollup.get_jobs", + "privileges": { + "cluster": [ + "monitor_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_jobs" @@ -14270,9 +14304,14 @@ "stability": "experimental" } }, - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "name": "rollup.get_rollup_caps", + "privileges": { + "cluster": [ + "monitor_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_rollup_caps" @@ -14307,9 +14346,14 @@ "stability": "experimental" } }, - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", + "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "name": "rollup.get_rollup_index_caps", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_rollup_index_caps" @@ -14338,7 +14382,7 @@ "stability": "experimental" } }, - "description": "Creates a rollup job.", + "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "name": "rollup.put_job", "privileges": { @@ -14378,7 +14422,7 @@ "stability": "experimental" } }, - "description": "Enables searching rolled-up data using the standard Query DSL.", + "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "name": "rollup.rollup_search", "request": { @@ -14413,9 +14457,14 @@ "stability": "experimental" } }, - "description": "Starts an existing, stopped rollup job.", + "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "name": "rollup.start_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.start_job" @@ -14444,9 +14493,14 @@ "stability": "experimental" } }, - "description": "Stops an existing, started rollup job.", + "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "name": "rollup.stop_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.stop_job" @@ -15097,9 +15151,14 @@ "stability": "experimental" } }, - "description": "Retrieve node-level cache statistics about searchable snapshots.", + "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.cache_stats", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.cache_stats" @@ -15134,9 +15193,17 @@ "stability": "experimental" } }, - "description": "Clear the cache of searchable snapshots.", + "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.clear_cache", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.clear_cache" @@ -15171,9 +15238,17 @@ "stability": "stable" } }, - "description": "Mount a snapshot as a searchable index.", + "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", "name": "searchable_snapshots.mount", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.mount" @@ -15205,9 +15280,17 @@ "stability": "stable" } }, - "description": "Retrieve shard-level statistics about searchable snapshots.", + "description": "Get searchable snapshot statistics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.stats", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.stats" @@ -17673,9 +17756,14 @@ "stability": "stable" } }, - "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.delete_node", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "shutdown.delete_node" @@ -17707,9 +17795,14 @@ "stability": "stable" } }, - "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.get_node", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "shutdown.get_node" @@ -17747,9 +17840,14 @@ "stability": "stable" } }, - "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.put_node", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "shutdown.put_node" @@ -17821,9 +17919,14 @@ "stability": "stable" } }, - "description": "Deletes an existing snapshot lifecycle policy.", + "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "name": "slm.delete_lifecycle", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.delete_lifecycle" @@ -17856,9 +17959,14 @@ "stability": "stable" } }, - "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", + "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "name": "slm.execute_lifecycle", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.execute_lifecycle" @@ -17891,9 +17999,14 @@ "stability": "stable" } }, - "description": "Deletes any snapshots that are expired according to the policy's retention rules.", + "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "name": "slm.execute_retention", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.execute_retention" @@ -17926,9 +18039,14 @@ "stability": "stable" } }, - "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "name": "slm.get_lifecycle", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.get_lifecycle" @@ -17967,9 +18085,14 @@ "stability": "stable" } }, - "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", + "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "name": "slm.get_stats", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.get_stats" @@ -18002,9 +18125,14 @@ "stability": "stable" } }, - "description": "Retrieves the status of snapshot lifecycle management (SLM).", + "description": "Get the snapshot lifecycle management status.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "name": "slm.get_status", + "privileges": { + "cluster": [ + "read_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.get_status" @@ -18037,9 +18165,17 @@ "stability": "stable" } }, - "description": "Creates or updates a snapshot lifecycle policy.", + "description": "Create or update a policy.\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "name": "slm.put_lifecycle", + "privileges": { + "cluster": [ + "manage_slm" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "slm.put_lifecycle" @@ -18075,9 +18211,14 @@ "stability": "stable" } }, - "description": "Turns on snapshot lifecycle management (SLM).", + "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "name": "slm.start", + "privileges": { + "cluster": [ + "manage_slm" + ] + }, "request": { "name": "Request", "namespace": "slm.start" @@ -18110,7 +18251,7 @@ "stability": "stable" } }, - "description": "Turns off snapshot lifecycle management (SLM).", + "description": "Stop snapshot lifecycle management.\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "name": "slm.stop", "request": { @@ -18145,9 +18286,16 @@ "stability": "stable" } }, - "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", + "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", + "extDocId": "clean-up-snapshot-repo", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-cleanup", "name": "snapshot.cleanup_repository", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.cleanup_repository" @@ -18180,9 +18328,14 @@ "stability": "stable" } }, - "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "description": "Clone a snapshot.\nClone part of all of a snapshot into another snapshot in the same repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.clone", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.clone" @@ -18218,9 +18371,16 @@ "stability": "stable" } }, - "description": "Creates a snapshot in a repository.", + "description": "Create a snapshot.\nTake a snapshot of a cluster or of data streams and indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "extDocId": "snapshot-create", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html", "name": "snapshot.create", + "privileges": { + "cluster": [ + "create_snapshot" + ] + }, "request": { "name": "Request", "namespace": "snapshot.create" @@ -18257,9 +18417,16 @@ "stability": "stable" } }, - "description": "Creates a repository.", + "description": "Create or update a snapshot repository.\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "extDocId": "register-repository", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html", "name": "snapshot.create_repository", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.create_repository" @@ -18295,9 +18462,14 @@ "stability": "stable" } }, - "description": "Deletes one or more snapshots.", + "description": "Delete snapshots.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.delete" @@ -18330,9 +18502,14 @@ "stability": "stable" } }, - "description": "Deletes a repository.", + "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete_repository", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.delete_repository" @@ -18365,9 +18542,14 @@ "stability": "stable" } }, - "description": "Returns information about a snapshot.", + "description": "Get snapshot information.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get", + "privileges": { + "cluster": [ + "monitor_snapshot" + ] + }, "request": { "name": "Request", "namespace": "snapshot.get" @@ -18400,9 +18582,14 @@ "stability": "stable" } }, - "description": "Returns information about a repository.", + "description": "Get snapshot repository information.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get_repository", + "privileges": { + "cluster": [ + "monitor_snapshot" + ] + }, "request": { "name": "Request", "namespace": "snapshot.get_repository" @@ -18463,9 +18650,14 @@ "visibility": "private" } }, - "description": "Verifies the integrity of the contents of a snapshot repository", + "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_verify_integrity", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.repository_verify_integrity" @@ -18498,9 +18690,16 @@ "stability": "stable" } }, - "description": "Restores a snapshot.", + "description": "Restore a snapshot.\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "extDocId": "restore-snapshot", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-restore-snapshot.html", "name": "snapshot.restore", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.restore" @@ -18536,9 +18735,14 @@ "stability": "stable" } }, - "description": "Returns information about the status of a snapshot.", + "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.status", + "privileges": { + "cluster": [ + "monitor_snapshot" + ] + }, "request": { "name": "Request", "namespace": "snapshot.status" @@ -18583,9 +18787,16 @@ "stability": "stable" } }, - "description": "Verifies a repository.", + "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "extDocId": "verify-repository", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-verification", "name": "snapshot.verify_repository", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "snapshot.verify_repository" @@ -141784,7 +141995,7 @@ } } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "inherits": { "type": { "name": "RequestBase", @@ -141822,7 +142033,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L44" + "specLocation": "inference/put/PutRequest.ts#L25-L54" }, { "kind": "response", @@ -148956,7 +149167,7 @@ }, "properties": [ { - "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "name": "description", "required": true, "type": { @@ -148968,7 +149179,7 @@ } }, { - "description": "Date the pipeline was last updated.\nMust be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", "name": "last_modified", "required": true, "type": { @@ -148980,59 +149191,59 @@ } }, { - "description": "Optional metadata about the pipeline.\nMay have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", - "name": "pipeline_metadata", + "description": "The configuration for the pipeline.", + "extDocId": "logstash-configuration-file-structure", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", + "name": "pipeline", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineMetadata", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "User who last updated the pipeline.", - "name": "username", + "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "name": "pipeline_metadata", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineMetadata", + "namespace": "logstash._types" } } }, { - "description": "Configuration for the pipeline.", - "docId": "logstash-configuration-file-structure", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", - "name": "pipeline", + "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", + "extDocId": "logstash-logstash-settings-file", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", + "name": "pipeline_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineSettings", + "namespace": "logstash._types" } } }, { - "description": "Settings for the pipeline.\nSupports only flat keys in dot notation.", - "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", - "name": "pipeline_settings", + "description": "The user who last updated the pipeline.", + "name": "username", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineSettings", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "logstash/_types/Pipeline.ts#L60-L92" + "specLocation": "logstash/_types/Pipeline.ts#L60-L91" }, { "kind": "interface", @@ -149172,7 +149383,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -149185,7 +149396,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -149198,7 +149409,7 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L37" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L40" }, { "kind": "response", @@ -149219,7 +149430,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -149232,7 +149443,7 @@ }, "path": [ { - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "name": "id", "required": false, "type": { @@ -149245,7 +149456,7 @@ } ], "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L37" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L40" }, { "kind": "response", @@ -149292,7 +149503,7 @@ } } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "inherits": { "type": { "name": "RequestBase", @@ -149305,7 +149516,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -149318,7 +149529,7 @@ } ], "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L39" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L44" }, { "kind": "response", @@ -149447,7 +149658,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149473,7 +149684,7 @@ } ], "query": [], - "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L32" + "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L37" }, { "kind": "response", @@ -149710,7 +149921,7 @@ "body": { "kind": "no_body" }, - "description": "Find out whether system features need to be upgraded or not", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149723,7 +149934,7 @@ }, "path": [], "query": [], - "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L27" + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L34" }, { "kind": "response", @@ -149792,7 +150003,7 @@ "body": { "kind": "no_body" }, - "description": "Begin upgrades for system features", + "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -149805,7 +150016,7 @@ }, "path": [], "query": [], - "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L27" + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L35" }, { "kind": "response", @@ -168587,7 +168798,7 @@ "body": { "kind": "no_body" }, - "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "inherits": { "type": { "name": "RequestBase", @@ -175139,7 +175350,7 @@ } } }, - "description": "Validates an anomaly detection detector.", + "description": "Validate an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -175152,7 +175363,7 @@ }, "path": [], "query": [], - "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L31" + "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L33" }, { "kind": "response", @@ -175226,7 +175437,7 @@ } } }, - "description": "Used by the monitoring features to send monitoring data.", + "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", "generics": [ { "name": "TDocument", @@ -175303,7 +175514,7 @@ } } ], - "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L59" + "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L61" }, { "kind": "response", @@ -185443,7 +185654,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing rollup job.", + "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "inherits": { "type": { "name": "RequestBase", @@ -185469,7 +185680,7 @@ } ], "query": [], - "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L35" + "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L59" }, { "kind": "response", @@ -185542,7 +185753,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "inherits": { "type": { "name": "RequestBase", @@ -185568,7 +185779,7 @@ } ], "query": [], - "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L36" + "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L42" }, { "kind": "response", @@ -185968,7 +186179,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "inherits": { "type": { "name": "RequestBase", @@ -185994,7 +186205,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L36" + "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L45" }, { "kind": "response", @@ -186192,7 +186403,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", + "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "inherits": { "type": { "name": "RequestBase", @@ -186218,7 +186429,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L36" + "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L42" }, { "kind": "response", @@ -186469,7 +186680,7 @@ } ] }, - "description": "Creates a rollup job.", + "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "inherits": { "type": { "name": "RequestBase", @@ -186495,7 +186706,7 @@ } ], "query": [], - "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L89" + "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L97" }, { "kind": "response", @@ -186575,7 +186786,7 @@ } ] }, - "description": "Enables searching rolled-up data using the standard Query DSL.", + "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "inherits": { "type": { "name": "RequestBase", @@ -186626,7 +186837,7 @@ } } ], - "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L57" + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L59" }, { "kind": "response", @@ -186741,7 +186952,7 @@ "body": { "kind": "no_body" }, - "description": "Starts an existing, stopped rollup job.", + "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "inherits": { "type": { "name": "RequestBase", @@ -186767,7 +186978,7 @@ } ], "query": [], - "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L35" + "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L38" }, { "kind": "response", @@ -186801,7 +187012,7 @@ "body": { "kind": "no_body" }, - "description": "Stops an existing, started rollup job.", + "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "inherits": { "type": { "name": "RequestBase", @@ -186854,7 +187065,7 @@ } } ], - "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L50" + "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L53" }, { "kind": "response", @@ -187694,7 +187905,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve node-level cache statistics about searchable snapshots.", + "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", "inherits": { "type": { "name": "RequestBase", @@ -187732,7 +187943,7 @@ } } ], - "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L35" + "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L38" }, { "kind": "response", @@ -187875,7 +188086,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the cache of searchable snapshots.", + "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", "inherits": { "type": { "name": "RequestBase", @@ -187960,7 +188171,7 @@ } } ], - "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L38" + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -188083,7 +188294,7 @@ } ] }, - "description": "Mount a snapshot as a searchable index.", + "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "inherits": { "type": { "name": "RequestBase", @@ -188161,7 +188372,7 @@ } } ], - "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L49" + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L55" }, { "kind": "response", @@ -188195,7 +188406,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve shard-level statistics about searchable snapshots.", + "description": "Get searchable snapshot statistics.", "inherits": { "type": { "name": "RequestBase", @@ -188234,7 +188445,7 @@ } } ], - "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L35" + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L38" }, { "kind": "response", @@ -199967,7 +200178,7 @@ "body": { "kind": "no_body" }, - "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "inherits": { "type": { "name": "RequestBase", @@ -200020,7 +200231,7 @@ } } ], - "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L44" + "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L54" }, { "kind": "response", @@ -200197,7 +200408,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "inherits": { "type": { "name": "RequestBase", @@ -200250,7 +200461,7 @@ } } ], - "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L44" + "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L53" }, { "kind": "response", @@ -200396,7 +200607,7 @@ } ] }, - "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -200449,7 +200660,7 @@ } } ], - "specLocation": "shutdown/put_node/ShutdownPutNodeRequest.ts#L25-L76" + "specLocation": "shutdown/put_node/ShutdownPutNodeRequest.ts#L25-L91" }, { "kind": "response", @@ -201050,7 +201261,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing snapshot lifecycle policy.", + "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -201076,7 +201287,7 @@ } ], "query": [], - "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L23-L32" + "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L23-L36" }, { "kind": "response", @@ -201104,7 +201315,7 @@ "body": { "kind": "no_body" }, - "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", + "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", "inherits": { "type": { "name": "RequestBase", @@ -201130,7 +201341,7 @@ } ], "query": [], - "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L23-L32" + "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L23-L36" }, { "kind": "response", @@ -201164,7 +201375,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes any snapshots that are expired according to the policy's retention rules.", + "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", "inherits": { "type": { "name": "RequestBase", @@ -201177,7 +201388,7 @@ }, "path": [], "query": [], - "specLocation": "slm/execute_retention/ExecuteRetentionRequest.ts#L22-L27" + "specLocation": "slm/execute_retention/ExecuteRetentionRequest.ts#L22-L31" }, { "kind": "response", @@ -201205,7 +201416,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "inherits": { "type": { "name": "RequestBase", @@ -201231,7 +201442,7 @@ } ], "query": [], - "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L23-L32" + "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L23-L38" }, { "kind": "response", @@ -201270,7 +201481,7 @@ "body": { "kind": "no_body" }, - "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", + "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", "inherits": { "type": { "name": "RequestBase", @@ -201283,7 +201494,7 @@ }, "path": [], "query": [], - "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsRequest.ts#L22-L27" + "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsRequest.ts#L22-L30" }, { "kind": "response", @@ -201428,7 +201639,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the status of snapshot lifecycle management (SLM).", + "description": "Get the snapshot lifecycle management status.", "inherits": { "type": { "name": "RequestBase", @@ -201441,7 +201652,7 @@ }, "path": [], "query": [], - "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts#L22-L27" + "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts#L22-L29" }, { "kind": "response", @@ -201537,7 +201748,7 @@ } ] }, - "description": "Creates or updates a snapshot lifecycle policy.", + "description": "Create or update a policy.\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", "inherits": { "type": { "name": "RequestBase", @@ -201550,7 +201761,7 @@ }, "path": [ { - "description": "ID for the snapshot lifecycle policy you want to create or update.", + "description": "The identifier for the snapshot lifecycle policy you want to create or update.", "name": "policy_id", "required": true, "type": { @@ -201590,7 +201801,7 @@ } } ], - "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L72" + "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L78" }, { "kind": "response", @@ -201618,7 +201829,7 @@ "body": { "kind": "no_body" }, - "description": "Turns on snapshot lifecycle management (SLM).", + "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", "inherits": { "type": { "name": "RequestBase", @@ -201631,7 +201842,7 @@ }, "path": [], "query": [], - "specLocation": "slm/start/StartSnapshotLifecycleManagementRequest.ts#L22-L27" + "specLocation": "slm/start/StartSnapshotLifecycleManagementRequest.ts#L22-L31" }, { "kind": "response", @@ -201659,7 +201870,7 @@ "body": { "kind": "no_body" }, - "description": "Turns off snapshot lifecycle management (SLM).", + "description": "Stop snapshot lifecycle management.\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", "inherits": { "type": { "name": "RequestBase", @@ -201672,7 +201883,7 @@ }, "path": [], "query": [], - "specLocation": "slm/stop/StopSnapshotLifecycleManagementRequest.ts#L22-L27" + "specLocation": "slm/stop/StopSnapshotLifecycleManagementRequest.ts#L22-L35" }, { "kind": "response", @@ -203531,7 +203742,7 @@ "body": { "kind": "no_body" }, - "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", + "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -203585,7 +203796,7 @@ } } ], - "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts#L24-L49" + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts#L24-L52" }, { "kind": "response", @@ -203633,7 +203844,7 @@ } ] }, - "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "description": "Clone a snapshot.\nClone part of all of a snapshot into another snapshot in the same repository.", "inherits": { "type": { "name": "RequestBase", @@ -203707,7 +203918,7 @@ } } ], - "specLocation": "snapshot/clone/SnapshotCloneRequest.ts#L24-L42" + "specLocation": "snapshot/clone/SnapshotCloneRequest.ts#L24-L45" }, { "kind": "response", @@ -203815,7 +204026,7 @@ } ] }, - "description": "Creates a snapshot in a repository.", + "description": "Create a snapshot.\nTake a snapshot of a cluster or of data streams and indices.", "inherits": { "type": { "name": "RequestBase", @@ -203880,7 +204091,7 @@ } } ], - "specLocation": "snapshot/create/SnapshotCreateRequest.ts#L24-L81" + "specLocation": "snapshot/create/SnapshotCreateRequest.ts#L24-L85" }, { "kind": "response", @@ -203941,7 +204152,7 @@ } } }, - "description": "Creates a repository.", + "description": "Create or update a snapshot repository.\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.", "inherits": { "type": { "name": "RequestBase", @@ -204005,7 +204216,7 @@ } } ], - "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L42" + "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L48" }, { "kind": "response", @@ -204033,7 +204244,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more snapshots.", + "description": "Delete snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -204084,7 +204295,7 @@ } } ], - "specLocation": "snapshot/delete/SnapshotDeleteRequest.ts#L24-L37" + "specLocation": "snapshot/delete/SnapshotDeleteRequest.ts#L24-L39" }, { "kind": "response", @@ -204112,7 +204323,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a repository.", + "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", "inherits": { "type": { "name": "RequestBase", @@ -204164,7 +204375,7 @@ } } ], - "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts#L24-L38" + "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts#L24-L42" }, { "kind": "response", @@ -204192,7 +204403,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about a snapshot.", + "description": "Get snapshot information.", "inherits": { "type": { "name": "RequestBase", @@ -204451,7 +204662,7 @@ } } ], - "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L127" + "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L129" }, { "kind": "response", @@ -204584,7 +204795,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about a repository.", + "description": "Get snapshot repository information.", "inherits": { "type": { "name": "RequestBase", @@ -204636,7 +204847,7 @@ } } ], - "specLocation": "snapshot/get_repository/SnapshotGetRepositoryRequest.ts#L24-L38" + "specLocation": "snapshot/get_repository/SnapshotGetRepositoryRequest.ts#L24-L40" }, { "kind": "response", @@ -204675,7 +204886,7 @@ "body": { "kind": "no_body" }, - "description": "Verifies the integrity of the contents of a snapshot repository", + "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.", "inherits": { "type": { "name": "RequestBase", @@ -204799,7 +205010,7 @@ } } ], - "specLocation": "snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts#L24-L43" + "specLocation": "snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts#L24-L72" }, { "kind": "response", @@ -204941,7 +205152,7 @@ } ] }, - "description": "Restores a snapshot.", + "description": "Restore a snapshot.\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -205004,7 +205215,7 @@ } } ], - "specLocation": "snapshot/restore/SnapshotRestoreRequest.ts#L25-L51" + "specLocation": "snapshot/restore/SnapshotRestoreRequest.ts#L25-L71" }, { "kind": "response", @@ -205095,7 +205306,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about the status of a snapshot.", + "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "inherits": { "type": { "name": "RequestBase", @@ -205158,7 +205369,7 @@ } } ], - "specLocation": "snapshot/status/SnapshotStatusRequest.ts#L24-L38" + "specLocation": "snapshot/status/SnapshotStatusRequest.ts#L24-L50" }, { "kind": "response", @@ -205216,7 +205427,7 @@ "body": { "kind": "no_body" }, - "description": "Verifies a repository.", + "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", "inherits": { "type": { "name": "RequestBase", @@ -205268,7 +205479,7 @@ } } ], - "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts#L24-L38" + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts#L24-L42" }, { "kind": "response", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 074d11f89d..2de101888b 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -13530,10 +13530,10 @@ export interface LicensePostStartTrialResponse { export interface LogstashPipeline { description: string last_modified: DateTime - pipeline_metadata: LogstashPipelineMetadata - username: string pipeline: string + pipeline_metadata: LogstashPipelineMetadata pipeline_settings: LogstashPipelineSettings + username: string } export interface LogstashPipelineMetadata { diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 1e7fac6559..afbdb888e1 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -61,6 +61,7 @@ ccr-put-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/refere ccr-put-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html ccr-resume-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays +clean-up-snapshot-repo,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-cleanup clean-up-snapshot-repo-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clean-up-snapshot-repo-api.html clear-repositories-metering-archive-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html clear-scroll-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html @@ -265,6 +266,7 @@ license-management,https://www.elastic.co/guide/en/kibana/{branch}/managing-lice logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html +logstash-centralized-pipeline-management,https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html logstash-configuration-file-structure,https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html logstash-logstash-settings-file,https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html @@ -428,6 +430,7 @@ query-rule,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sear realtime,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime redact-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/redact-processor.html regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html +register-repository,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html registered-domain-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/registered-domain-processor.html remove-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remove-processor.html remote-clusters-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html @@ -435,6 +438,7 @@ rename-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch reroute-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reroute-processor.html render-search-template-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html +restore-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-restore-snapshot.html rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html rollup-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-job.html rollup-get-rollup-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-caps.html @@ -640,6 +644,7 @@ urldecode-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{bra usage-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/usage-api.html user-agent-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html user-profile,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html +verify-repository,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-verification voting-config-exclusions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html watcher-api-ack-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-ack-watch.html watcher-api-activate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-activate-watch.html diff --git a/specification/inference/put/PutRequest.ts b/specification/inference/put/PutRequest.ts index be83f3ace8..3ddb505e53 100644 --- a/specification/inference/put/PutRequest.ts +++ b/specification/inference/put/PutRequest.ts @@ -23,10 +23,20 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Create an inference endpoint + * Create an inference endpoint. + * When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + * After creating the endpoint, wait for the model deployment to complete before using it. + * To verify the deployment status, use the get trained model statistics API. + * Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. + * Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + * + * IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + * For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + * However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. * @rest_spec_name inference.put * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public + * @cluster_privileges manage_inference */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/logstash/_types/Pipeline.ts b/specification/logstash/_types/Pipeline.ts index 0e82c10bf2..76ff608407 100644 --- a/specification/logstash/_types/Pipeline.ts +++ b/specification/logstash/_types/Pipeline.ts @@ -59,34 +59,33 @@ export class PipelineSettings { } export class Pipeline { /** - * Description of the pipeline. + * A description of the pipeline. * This description is not used by Elasticsearch or Logstash. */ description: string /** - * Date the pipeline was last updated. - * Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. + * The date the pipeline was last updated. + * It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. */ last_modified: DateTime /** - * Optional metadata about the pipeline. - * May have any contents. - * This metadata is not generated or used by Elasticsearch or Logstash. - */ - pipeline_metadata: PipelineMetadata - /** - * User who last updated the pipeline. + * The configuration for the pipeline. + * @ext_doc_id logstash-configuration-file-structure */ - username: string + pipeline: string /** - * Configuration for the pipeline. - * @doc_id logstash-configuration-file-structure + * Optional metadata about the pipeline, which can have any contents. + * This metadata is not generated or used by Elasticsearch or Logstash. */ - pipeline: string + pipeline_metadata: PipelineMetadata /** * Settings for the pipeline. - * Supports only flat keys in dot notation. - * @doc_id logstash-logstash-settings-file + * It supports only flat keys in dot notation. + * @ext_doc_id logstash-logstash-settings-file */ pipeline_settings: PipelineSettings + /** + * The user who last updated the pipeline. + */ + username: string } diff --git a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts index bc35272839..a94dc2b20e 100644 --- a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts +++ b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts @@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a pipeline used for Logstash Central Management. + * Delete a Logstash pipeline. + * + * Delete a pipeline that is used for Logstash Central Management. * @rest_spec_name logstash.delete_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Identifier for the pipeline. + * An identifier for the pipeline. */ id: Id } diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts index e5865df54b..52b59d2706 100644 --- a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts @@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Retrieves pipelines used for Logstash Central Management. + * Get Logstash pipelines. + * + * Get pipelines that are used for Logstash Central Management. * @rest_spec_name logstash.get_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Comma-separated list of pipeline identifiers. + * A comma-separated list of pipeline identifiers. */ id?: Ids } diff --git a/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts index 4a41853425..aac5048de2 100644 --- a/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts +++ b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts @@ -21,16 +21,21 @@ import { Pipeline } from '@logstash/_types/Pipeline' import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' -/** Creates or updates a pipeline used for Logstash Central Management. +/** + * Create or update a Logstash pipeline. + * + * Create a pipeline that is used for Logstash Central Management. + * If the specified pipeline exists, it is replaced. * @rest_spec_name logstash.put_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Identifier for the pipeline. + * An identifier for the pipeline. */ id: Id } diff --git a/specification/migration/deprecations/DeprecationInfoRequest.ts b/specification/migration/deprecations/DeprecationInfoRequest.ts index c901dc6f29..a750d93280 100644 --- a/specification/migration/deprecations/DeprecationInfoRequest.ts +++ b/specification/migration/deprecations/DeprecationInfoRequest.ts @@ -21,8 +21,13 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** + * Get deprecation information. + * Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. + * + * TIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.deprecations * @availability stack since=6.1.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts index 54896f33b1..e953f6b4a5 100644 --- a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts @@ -20,8 +20,15 @@ import { RequestBase } from '@_types/Base' /** + * Get feature migration information. + * Version upgrades sometimes require changes to how features store configuration information and data in system indices. + * Check which features need to be migrated and the status of any migrations that are in progress. + * + * TIP: This API is designed for indirect use by the Upgrade Assistant. + * We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.get_feature_upgrade_status * @availability stack since=7.16.0 stability=stable * @index_privileges manage + * @cluster_privileges manage */ export interface Request extends RequestBase {} diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts index 30c6ff117e..822ecc610d 100644 --- a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts @@ -20,8 +20,16 @@ import { RequestBase } from '@_types/Base' /** + * Start the feature migration. + * Version upgrades sometimes require changes to how features store configuration information and data in system indices. + * This API starts the automatic migration process. + * + * Some functionality might be temporarily unavailable during the migration process. + * + * TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. * @rest_spec_name migration.post_feature_upgrade * @availability stack since=7.16.0 stability=stable * @index_privileges manage + * @cluster_privileges manage */ export interface Request extends RequestBase {} diff --git a/specification/ml/info/MlInfoRequest.ts b/specification/ml/info/MlInfoRequest.ts index 17ba0702d3..4f503ed165 100644 --- a/specification/ml/info/MlInfoRequest.ts +++ b/specification/ml/info/MlInfoRequest.ts @@ -20,8 +20,8 @@ import { RequestBase } from '@_types/Base' /** - * Return ML defaults and limits. - * Returns defaults and limits used by machine learning. + * Get machine learning information. + * Get defaults and limits used by machine learning. * This endpoint is designed to be used by a user interface that needs to fully * understand machine learning configurations where some options are not * specified, meaning that the defaults should be used. This endpoint may be diff --git a/specification/ml/validate_detector/MlValidateDetectorRequest.ts b/specification/ml/validate_detector/MlValidateDetectorRequest.ts index fc586c5fb2..e8f6c3a705 100644 --- a/specification/ml/validate_detector/MlValidateDetectorRequest.ts +++ b/specification/ml/validate_detector/MlValidateDetectorRequest.ts @@ -21,9 +21,11 @@ import { Detector } from '@ml/_types/Detector' import { RequestBase } from '@_types/Base' /** + * Validate an anomaly detection job. * @rest_spec_name ml.validate_detector * @availability stack since=5.4.0 stability=stable visibility=private * @availability serverless stability=stable visibility=private + * @doc_tag ml anomaly */ export interface Request extends RequestBase { /** @codegen_name detector */ diff --git a/specification/monitoring/bulk/BulkMonitoringRequest.ts b/specification/monitoring/bulk/BulkMonitoringRequest.ts index b991d9010e..90346fa55b 100644 --- a/specification/monitoring/bulk/BulkMonitoringRequest.ts +++ b/specification/monitoring/bulk/BulkMonitoringRequest.ts @@ -22,8 +22,10 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** + * Send monitoring data. + * This API is used by the monitoring features to send monitoring data. * @rest_spec_name monitoring.bulk - * @availability stack since=6.3.0 stability=stable + * @availability stack since=6.3.0 stability=stable visibility=private */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/delete_job/DeleteRollupJobRequest.ts b/specification/rollup/delete_job/DeleteRollupJobRequest.ts index e2d467fe3d..eef578b63d 100644 --- a/specification/rollup/delete_job/DeleteRollupJobRequest.ts +++ b/specification/rollup/delete_job/DeleteRollupJobRequest.ts @@ -21,9 +21,33 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an existing rollup job. + * Delete a rollup job. + * + * A job must be stopped before it can be deleted. + * If you attempt to delete a started job, an error occurs. + * Similarly, if you attempt to delete a nonexistent job, an exception occurs. + * + * IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + * The API does not delete any previously rolled up data. + * This is by design; a user may wish to roll up a static data set. + * Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + * Thus the job can be deleted, leaving behind the rolled up data for analysis. + * If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + * If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + * + * ``` + * POST my_rollup_index/_delete_by_query + * { + * "query": { + * "term": { + * "_rollup.id": "the_rollup_job_id" + * } + * } + * } + * ``` * @rest_spec_name rollup.delete_job * @availability stack since=6.3.0 stability=experimental + * @cluster_privileges manage_rollup */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/get_jobs/GetRollupJobRequest.ts b/specification/rollup/get_jobs/GetRollupJobRequest.ts index fa990bf94f..6e69d18a09 100644 --- a/specification/rollup/get_jobs/GetRollupJobRequest.ts +++ b/specification/rollup/get_jobs/GetRollupJobRequest.ts @@ -21,9 +21,15 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves the configuration, stats, and status of rollup jobs. + * Get rollup job information. + * Get the configuration, stats, and status of rollup jobs. + * + * NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. + * If a job was created, ran for a while, then was deleted, the API does not return any details about it. + * For details about a historical rollup job, the rollup capabilities API may be more useful. * @rest_spec_name rollup.get_jobs * @availability stack since=6.3.0 stability=experimental + * @cluster_privileges monitor_rollup */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts index bd7673d72a..d579f5ae9a 100644 --- a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts @@ -21,9 +21,18 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + * Get the rollup job capabilities. + * Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + * + * This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + * Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + * This API enables you to inspect an index and determine: + * + * 1. Does this index have associated rollup data somewhere in the cluster? + * 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? * @rest_spec_name rollup.get_rollup_caps * @availability stack since=6.3.0 stability=experimental + * @cluster_privileges monitor_rollup */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts index 36d77bd4c2..4ff08efcf4 100644 --- a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts +++ b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts @@ -21,9 +21,15 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + * Get the rollup index capabilities. + * Get the rollup capabilities of all jobs inside of a rollup index. + * A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + * + * * What jobs are stored in an index (or indices specified via a pattern)? + * * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? * @rest_spec_name rollup.get_rollup_index_caps * @availability stack since=6.4.0 stability=experimental + * @index_privileges read */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/put_job/CreateRollupJobRequest.ts b/specification/rollup/put_job/CreateRollupJobRequest.ts index 6f00c8cb9a..b16206b85d 100644 --- a/specification/rollup/put_job/CreateRollupJobRequest.ts +++ b/specification/rollup/put_job/CreateRollupJobRequest.ts @@ -25,7 +25,15 @@ import { integer } from '@_types/Numeric' import { Duration } from '@_types/Time' /** - * Creates a rollup job. + * Create a rollup job. + * + * WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + * + * The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + * + * There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + * + * Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. * @rest_spec_name rollup.put_job * @availability stack since=6.3.0 stability=experimental * @cluster_privileges manage, manage_rollup diff --git a/specification/rollup/rollup_search/RollupSearchRequest.ts b/specification/rollup/rollup_search/RollupSearchRequest.ts index 7f27d9b54f..4261604f07 100644 --- a/specification/rollup/rollup_search/RollupSearchRequest.ts +++ b/specification/rollup/rollup_search/RollupSearchRequest.ts @@ -25,7 +25,9 @@ import { integer } from '@_types/Numeric' import { QueryContainer } from '@_types/query_dsl/abstractions' /** - * Enables searching rolled-up data using the standard Query DSL. + * Search rolled-up data. + * The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + * It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. * @rest_spec_name rollup.rollup_search * @availability stack since=6.3.0 stability=experimental */ diff --git a/specification/rollup/start_job/StartRollupJobRequest.ts b/specification/rollup/start_job/StartRollupJobRequest.ts index 1ae1c98aaa..229aa2a56f 100644 --- a/specification/rollup/start_job/StartRollupJobRequest.ts +++ b/specification/rollup/start_job/StartRollupJobRequest.ts @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Starts an existing, stopped rollup job. + * Start rollup jobs. + * If you try to start a job that does not exist, an exception occurs. + * If you try to start a job that is already started, nothing happens. * @rest_spec_name rollup.start_job * @availability stack since=6.3.0 stability=experimental + * @cluster_privileges manage_rollup */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/rollup/stop_job/StopRollupJobRequest.ts b/specification/rollup/stop_job/StopRollupJobRequest.ts index a8824f19e3..88541dea0c 100644 --- a/specification/rollup/stop_job/StopRollupJobRequest.ts +++ b/specification/rollup/stop_job/StopRollupJobRequest.ts @@ -22,9 +22,12 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Stops an existing, started rollup job. + * Stop rollup jobs. + * If you try to stop a job that does not exist, an exception occurs. + * If you try to stop a job that is already stopped, nothing happens. * @rest_spec_name rollup.stop_job * @availability stack since=6.3.0 stability=experimental + * @cluster_privileges manage_rollup */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/cache_stats/Request.ts b/specification/searchable_snapshots/cache_stats/Request.ts index 9d482258d9..7ef9bc1781 100644 --- a/specification/searchable_snapshots/cache_stats/Request.ts +++ b/specification/searchable_snapshots/cache_stats/Request.ts @@ -22,8 +22,11 @@ import { NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get cache statistics. + * Get statistics about the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.cache_stats * @availability stack since=7.13.0 stability=experimental + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts index 13300556a9..5c50a67828 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts @@ -21,8 +21,12 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices } from '@_types/common' /** + * Clear the cache. + * Clear indices and data streams from the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.clear_cache * @availability stack since=7.10.0 stability=experimental + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts index 9455ee41d9..fcc880e756 100644 --- a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts +++ b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts @@ -24,8 +24,14 @@ import { IndexName, Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Mount a snapshot. + * Mount a snapshot as a searchable snapshot index. + * Do not use this API for snapshots managed by index lifecycle management (ILM). + * Manually mounting ILM-managed snapshots can interfere with ILM processes. * @rest_spec_name searchable_snapshots.mount * @availability stack since=7.10.0 stability=stable + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index bdc4fdffa5..872a7c71c7 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -22,8 +22,11 @@ import { Indices } from '@_types/common' import { StatsLevel } from '../_types/stats' /** + * Get searchable snapshot statistics. * @rest_spec_name searchable_snapshots.stats * @availability stack since=7.10.0 stability=stable + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index 25df4239a5..e84a7d7d28 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -22,8 +22,18 @@ import { NodeId } from '@_types/common' import { TimeUnit } from '@_types/Time' /** + * Cancel node shutdown preparations. + * Remove a node from the shutdown list so it can resume normal operations. + * You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. + * Shutdown requests are never removed automatically by Elasticsearch. + * + * NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. + * Direct use is not supported. + * + * If the operator privileges feature is enabled, you must be an operator to use this API. * @rest_spec_name shutdown.delete_node * @availability stack since=7.13.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index 63fed84660..e74fa31743 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -22,8 +22,17 @@ import { NodeIds } from '@_types/common' import { TimeUnit } from '@_types/Time' /** + * Get the shutdown status. + * + * Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. + * The API returns status information for each part of the shut down process. + * + * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. + * + * If the operator privileges feature is enabled, you must be an operator to use this API. * @rest_spec_name shutdown.get_node * @availability stack since=7.13.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index 6ab62d3eb5..318f9128b5 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -23,8 +23,23 @@ import { TimeUnit } from '@_types/Time' import { Type } from '../_types/types' /** + * Prepare a node to be shut down. + * + * NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. + * + * If the operator privileges feature is enabled, you must be an operator to use this API. + * + * The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. + * This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. + * + * You must specify the type of shutdown: `restart`, `remove`, or `replace`. + * If a node is already being prepared for shutdown, you can use this API to change the shutdown type. + * + * IMPORTANT: This API does NOT terminate the Elasticsearch process. + * Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. * @rest_spec_name shutdown.put_node * @availability stack since=7.13.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts index b7226560a6..3699ce3608 100644 --- a/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts +++ b/specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Delete a policy. + * Delete a snapshot lifecycle policy definition. + * This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. * @rest_spec_name slm.delete_lifecycle * @availability stack since=7.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts index 487930b114..5ca42d3cce 100644 --- a/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts +++ b/specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Run a policy. + * Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + * The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. * @rest_spec_name slm.execute_lifecycle * @availability stack since=7.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/slm/execute_retention/ExecuteRetentionRequest.ts b/specification/slm/execute_retention/ExecuteRetentionRequest.ts index 9c672d8a1f..458fd23372 100644 --- a/specification/slm/execute_retention/ExecuteRetentionRequest.ts +++ b/specification/slm/execute_retention/ExecuteRetentionRequest.ts @@ -20,8 +20,12 @@ import { RequestBase } from '@_types/Base' /** + * Run a retention policy. + * Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + * The retention policy is normally applied according to its schedule. * @rest_spec_name slm.execute_retention * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts index c61c32337e..b1e6ad614d 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts @@ -21,12 +21,18 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Get policy information. + * Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. * @rest_spec_name slm.get_lifecycle * @availability stack since=7.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase { path_parts: { + /* + A comma-separate list of snapshot lifecycle policy identifiers. + */ policy_id?: Names } } diff --git a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts index 178ca6b4e6..fc55ea2ef9 100644 --- a/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts +++ b/specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts @@ -20,8 +20,11 @@ import { RequestBase } from '@_types/Base' /** + * Get snapshot lifecycle management statistics. + * Get global and policy-level statistics about actions taken by snapshot lifecycle management. * @rest_spec_name slm.get_stats * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase {} diff --git a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts index 5c162fe0a6..7ffec86da8 100644 --- a/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts +++ b/specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts @@ -20,8 +20,10 @@ import { RequestBase } from '@_types/Base' /** + * Get the snapshot lifecycle management status. * @rest_spec_name slm.get_status * @availability stack since=7.6.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges read_slm */ export interface Request extends RequestBase {} diff --git a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts index b6b79b47df..66e107f2ca 100644 --- a/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts +++ b/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts @@ -24,14 +24,20 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Create or update a policy. + * Create or update a snapshot lifecycle policy. + * If the policy already exists, this request increments the policy version. + * Only the latest version of a policy is stored. * @rest_spec_name slm.put_lifecycle * @availability stack since=7.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { /** - * ID for the snapshot lifecycle policy you want to create or update. + * The identifier for the snapshot lifecycle policy you want to create or update. */ policy_id: Name } diff --git a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts index 1f0d8106ff..04612c9ee1 100644 --- a/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/start/StartSnapshotLifecycleManagementRequest.ts @@ -20,8 +20,12 @@ import { RequestBase } from '@_types/Base' /** + * Start snapshot lifecycle management. + * Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + * Manually starting SLM is necessary only if it has been stopped using the stop SLM API. * @rest_spec_name slm.start * @availability stack since=7.6.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage_slm */ export interface Request extends RequestBase {} diff --git a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts index eb5e8ede10..32a9ea2062 100644 --- a/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts +++ b/specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts @@ -20,6 +20,14 @@ import { RequestBase } from '@_types/Base' /** + * Stop snapshot lifecycle management. + * Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + * This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + * Stopping SLM does not stop any snapshots that are in progress. + * You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + * + * The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + * Use the get snapshot lifecycle management status API to see if SLM is running. * @rest_spec_name slm.stop * @availability stack since=7.6.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts index 7b69025470..4ad18c81e0 100644 --- a/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts +++ b/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts @@ -22,10 +22,13 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** - * Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + * Clean up the snapshot repository. + * Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. * @rest_spec_name snapshot.cleanup_repository * @availability stack since=7.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage + * @ext_doc_id clean-up-snapshot-repo */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/clone/SnapshotCloneRequest.ts b/specification/snapshot/clone/SnapshotCloneRequest.ts index 8cf780a4e0..4141fb04b6 100644 --- a/specification/snapshot/clone/SnapshotCloneRequest.ts +++ b/specification/snapshot/clone/SnapshotCloneRequest.ts @@ -22,9 +22,12 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Clone a snapshot. + * Clone part of all of a snapshot into another snapshot in the same repository. * @rest_spec_name snapshot.clone * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/create/SnapshotCreateRequest.ts b/specification/snapshot/create/SnapshotCreateRequest.ts index 7fff18df5d..86ae28ecc7 100644 --- a/specification/snapshot/create/SnapshotCreateRequest.ts +++ b/specification/snapshot/create/SnapshotCreateRequest.ts @@ -22,9 +22,13 @@ import { Indices, Metadata, Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Create a snapshot. + * Take a snapshot of a cluster or of data streams and indices. * @rest_spec_name snapshot.create * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges create_snapshot + * @ext_doc_id snapshot-create */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts index 93e836180e..b5eb7782bd 100644 --- a/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts +++ b/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts @@ -23,9 +23,15 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Create or update a snapshot repository. + * IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + * To register a snapshot repository, the cluster's global metadata must be writeable. + * Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. * @rest_spec_name snapshot.create_repository * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage + * @ext_doc_id register-repository */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/delete/SnapshotDeleteRequest.ts b/specification/snapshot/delete/SnapshotDeleteRequest.ts index e9194337f4..4ba1ed9fc9 100644 --- a/specification/snapshot/delete/SnapshotDeleteRequest.ts +++ b/specification/snapshot/delete/SnapshotDeleteRequest.ts @@ -22,9 +22,11 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete snapshots. * @rest_spec_name snapshot.delete * @availability stack stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts index 84ff3aea05..b5e274a232 100644 --- a/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts +++ b/specification/snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts @@ -22,9 +22,13 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete snapshot repositories. + * When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + * The snapshots themselves are left untouched and in place. * @rest_spec_name snapshot.delete_repository * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/get/SnapshotGetRequest.ts b/specification/snapshot/get/SnapshotGetRequest.ts index 0ecdcd1281..fd096bb030 100644 --- a/specification/snapshot/get/SnapshotGetRequest.ts +++ b/specification/snapshot/get/SnapshotGetRequest.ts @@ -25,9 +25,11 @@ import { SortOrder } from '@_types/sort' import { Duration } from '@_types/Time' /** + * Get snapshot information. * @rest_spec_name snapshot.get * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges monitor_snapshot */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts index b620870113..4d42c890c8 100644 --- a/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts +++ b/specification/snapshot/get_repository/SnapshotGetRepositoryRequest.ts @@ -22,9 +22,11 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get snapshot repository information. * @rest_spec_name snapshot.get_repository * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges monitor_snapshot */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts b/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts index 2c77b1476a..5e493327d4 100644 --- a/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts +++ b/specification/snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts @@ -22,8 +22,37 @@ import { Names } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Verify the repository integrity. + * Verify the integrity of the contents of a snapshot repository. + * + * This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + * + * If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity. + * Until you do so: + * + * * It may not be possible to restore some snapshots from this repository. + * * Searchable snapshots may report errors when searched or may have unassigned shards. + * * Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + * * Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + * * Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + * + * If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + * The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + * You must also identify what caused the damage and take action to prevent it from happening again. + * + * If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + * In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + * + * Avoid all operations which write to the repository while the verify repository integrity API is running. + * If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + * It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + * + * NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + * + * NOTE: This API may not work correctly in a mixed-version cluster. * @rest_spec_name snapshot.repository_verify_integrity * @availability stack since=8.16.0 stability=experimental visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/restore/SnapshotRestoreRequest.ts b/specification/snapshot/restore/SnapshotRestoreRequest.ts index bedf603476..a982b26fe6 100644 --- a/specification/snapshot/restore/SnapshotRestoreRequest.ts +++ b/specification/snapshot/restore/SnapshotRestoreRequest.ts @@ -23,9 +23,29 @@ import { Indices, Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Restore a snapshot. + * Restore a snapshot of a cluster or data streams and indices. + * + * You can restore a snapshot only to a running cluster with an elected master node. + * The snapshot repository must be registered and available to the cluster. + * The snapshot and cluster versions must be compatible. + * + * To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + * + * Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + * + * ``` + * GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + * ``` + * + * If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + * + * If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. * @rest_spec_name snapshot.restore * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage + * @ext_doc_id restore-snapshot */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/status/SnapshotStatusRequest.ts b/specification/snapshot/status/SnapshotStatusRequest.ts index 747f5bd2cb..44a7f74489 100644 --- a/specification/snapshot/status/SnapshotStatusRequest.ts +++ b/specification/snapshot/status/SnapshotStatusRequest.ts @@ -22,9 +22,21 @@ import { Name, Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get the snapshot status. + * Get a detailed description of the current state for each shard participating in the snapshot. + * Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + * If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + * + * WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + * The API requires a read from the repository for each shard in each snapshot. + * For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + * + * Depending on the latency of your storage, such requests can take an extremely long time to return results. + * These requests can also tax machine resources and, when using cloud storage, incur high processing costs. * @rest_spec_name snapshot.status * @availability stack since=7.8.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges monitor_snapshot */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts index ec97297dc9..951a55bb5a 100644 --- a/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts +++ b/specification/snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts @@ -22,9 +22,13 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Verify a snapshot repository. + * Check for common misconfigurations in a snapshot repository. * @rest_spec_name snapshot.verify_repository * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private + * @cluster_privileges manage + * @ext_doc_id verify-repository */ export interface Request extends RequestBase { path_parts: {