From a6b96b44bd9a240575328b446d3a2ae471b6a319 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 27 Jan 2025 19:23:08 -0800 Subject: [PATCH] [DOCS] Add missing doc_id values (#3632) (cherry picked from commit 89a229fb5b680d6c2ac79167b0063211f170df07) --- output/openapi/elasticsearch-openapi.json | 91 +- .../elasticsearch-serverless-openapi.json | 71 +- output/schema/schema.json | 905 +++++++++++------- specification/_doc_ids/table.csv | 56 +- .../_global/get_script/GetScriptRequest.ts | 1 + .../_global/health_report/Request.ts | 1 + .../_global/msearch/MultiSearchRequest.ts | 1 + specification/_global/ping/PingRequest.ts | 1 + .../_global/rank_eval/RankEvalRequest.ts | 1 + specification/cat/tasks/CatTasksRequest.ts | 2 +- .../DeleteEnrichPolicyRequest.ts | 1 + .../get_policy/GetEnrichPolicyRequest.ts | 1 + .../enrich/stats/EnrichStatsRequest.ts | 1 + specification/eql/delete/EqlDeleteRequest.ts | 1 + specification/eql/search/EqlSearchRequest.ts | 1 + .../get_features/GetFeaturesRequest.ts | 1 + .../reset_features/ResetFeaturesRequest.ts | 1 + .../GlobalCheckpointsRequest.ts | 5 + .../fleet/msearch/MultiSearchRequest.ts | 1 + specification/fleet/search/SearchRequest.ts | 1 + .../DeleteLifecycleRequest.ts | 1 + .../ExplainLifecycleRequest.ts | 1 + .../ilm/get_lifecycle/GetLifecycleRequest.ts | 1 + .../ilm/get_status/GetIlmStatusRequest.ts | 2 + .../ilm/migrate_to_data_tiers/Request.ts | 1 + .../ilm/move_to_step/MoveToStepRequest.ts | 1 + .../ilm/put_lifecycle/PutLifecycleRequest.ts | 1 + .../ilm/remove_policy/RemovePolicyRequest.ts | 1 + specification/ilm/retry/RetryIlmRequest.ts | 1 + specification/ilm/start/StartIlmRequest.ts | 1 + specification/ilm/stop/StopIlmRequest.ts | 1 + .../add_block/IndicesAddBlockRequest.ts | 46 +- .../IndicesAddBlockResponseExample1.yaml | 14 +- .../clear_cache/IndicesClearCacheRequest.ts | 1 + .../indices/clone/IndicesCloneRequest.ts | 1 + .../IndicesCreateDataStreamRequest.ts | 3 +- .../IndicesDataStreamsStatsRequest.ts | 4 +- .../IndicesDeleteDataLifecycleRequest.ts | 1 + .../IndicesDeleteDataStreamRequest.ts | 1 + .../exists_alias/IndicesExistsAliasRequest.ts | 4 +- .../IndicesExistsIndexTemplateRequest.ts | 2 + .../IndicesExplainDataLifecycleRequest.ts | 1 + .../IndicesGetDataLifecycleRequest.ts | 4 +- .../IndicesGetDataStreamRequest.ts | 4 +- .../inference/delete/DeleteRequest.ts | 7 +- specification/inference/get/GetRequest.ts | 1 + .../inference/inference/InferenceRequest.ts | 31 +- .../request/InferenceRequestExample1.yaml | 8 + .../request/InferenceRequestExample2.yaml | 9 + .../request/InferenceRequestExample3.yaml | 8 + .../request/InferenceRequestExample4.yaml | 11 + .../response/InferenceResponseExample1.yaml | 13 + .../response/InferenceResponseExample2.yaml | 45 + .../response/InferenceResponseExample3.yaml | 26 + .../response/InferenceResponseExample4.yaml | 30 + specification/inference/put/PutRequest.ts | 1 + .../DeleteGeoipDatabaseRequest.ts | 6 +- .../DeleteIpLocationDatabaseRequest.ts | 1 + .../delete_pipeline/DeletePipelineRequest.ts | 1 + .../GetGeoipDatabaseRequest.ts | 4 +- .../GetIpLocationDatabaseRequest.ts | 1 + .../ingest/get_pipeline/GetPipelineRequest.ts | 2 + .../PutGeoipDatabaseRequest.ts | 2 + .../PutIpLocationDatabaseRequest.ts | 1 + .../simulate/SimulatePipelineRequest.ts | 11 +- .../license/delete/DeleteLicenseRequest.ts | 6 +- .../license/get/GetLicenseRequest.ts | 7 +- .../GetBasicLicenseStatusRequest.ts | 1 + .../GetTrialLicenseStatusRequest.ts | 1 + .../license/post/PostLicenseRequest.ts | 6 +- .../StartBasicLicenseRequest.ts | 2 + ...ClearTrainedModelDeploymentCacheRequest.ts | 1 + .../MlDeleteExpiredDataRequest.ts | 1 + .../ml/delete_filter/MlDeleteFilterRequest.ts | 1 + .../MlDeleteForecastRequest.ts | 1 + .../ml/delete_job/MlDeleteJobRequest.ts | 1 + .../MlDeleteModelSnapshotRequest.ts | 1 + .../MlDeleteTrainedModelRequest.ts | 1 + .../MlDeleteTrainedModelAliasRequest.ts | 1 + .../MlEstimateModelMemoryRequest.ts | 1 + .../MlEvaluateDataFrameRequest.ts | 1 + .../MlExplainDataFrameAnalyticsRequest.ts | 1 + .../ml/flush_job/MlFlushJobRequest.ts | 1 + .../ml/forecast/MlForecastJobRequest.ts | 1 + .../ml/get_buckets/MlGetBucketsRequest.ts | 1 + .../MlGetCalendarEventsRequest.ts | 1 + .../ml/get_calendars/MlGetCalendarsRequest.ts | 1 + .../get_categories/MlGetCategoriesRequest.ts | 1 + .../MlGetDataFrameAnalyticsRequest.ts | 1 + .../MlGetDataFrameAnalyticsStatsRequest.ts | 1 + .../MlGetDatafeedStatsRequest.ts | 1 + .../ml/get_datafeeds/MlGetDatafeedsRequest.ts | 1 + .../ml/get_filters/MlGetFiltersRequest.ts | 1 + .../MlGetInfluencersRequest.ts | 1 + .../ml/get_job_stats/MlGetJobStatsRequest.ts | 1 + specification/ml/get_jobs/MlGetJobsRequest.ts | 1 + .../MlGetMemoryStatsRequest.ts | 1 + .../MlGetModelSnapshotUpgradeStatsRequest.ts | 1 + .../MlGetModelSnapshotsRequest.ts | 1 + .../MlGetOverallBucketsRequest.ts | 1 + .../get_records/MlGetAnomalyRecordsRequest.ts | 1 + .../MlGetTrainedModelRequest.ts | 1 + .../MlGetTrainedModelStatsRequest.ts | 1 + .../MlInferTrainedModelRequest.ts | 1 + specification/ml/info/MlInfoRequest.ts | 1 + specification/ml/open_job/MlOpenJobRequest.ts | 1 + .../MlPostCalendarEventsRequest.ts | 1 + .../ml/post_data/MlPostJobDataRequest.ts | 1 + .../MlPreviewDataFrameAnalyticsRequest.ts | 3 +- .../MlPreviewDatafeedRequest.ts | 1 + .../ml/put_calendar/MlPutCalendarRequest.ts | 1 + .../MlPutCalendarJobRequest.ts | 1 + .../ml/put_datafeed/MlPutDatafeedRequest.ts | 1 + .../ml/put_filter/MlPutFilterRequest.ts | 1 + specification/ml/put_job/MlPutJobRequest.ts | 1 + .../MlPutTrainedModelRequest.ts | 1 + .../MlPutTrainedModelAliasRequest.ts | 1 + .../MlPutTrainedModelDefinitionPartRequest.ts | 1 + .../MlPutTrainedModelVocabularyRequest.ts | 1 + .../ml/reset_job/MlResetJobRequest.ts | 1 + .../MlRevertModelSnapshotRequest.ts | 1 + .../MlSetUpgradeModeRequest.ts | 1 + .../MlStartDataFrameAnalyticsRequest.ts | 1 + .../start_datafeed/MlStartDatafeedRequest.ts | 1 + .../MlStartTrainedModelDeploymentRequest.ts | 1 + .../MlStopDataFrameAnalyticsRequest.ts | 1 + .../ml/stop_datafeed/MlStopDatafeedRequest.ts | 1 + .../MlStopTrainedModelDeploymentRequest.ts | 1 + .../MlUpdateDataFrameAnalyticsRequest.ts | 1 + .../MlUpdateDatafeedRequest.ts | 1 + .../ml/update_filter/MlUpdateFilterRequest.ts | 1 + .../ml/update_job/MlUpdateJobRequest.ts | 1 + .../MlUpdateModelSnapshotRequest.ts | 1 + .../MlUpdateTrainedModelDeploymentRequest.ts | 1 + .../MlUpgradeJobSnapshotRequest.ts | 3 +- .../MlValidateDetectorRequest.ts | 1 + .../monitoring/bulk/BulkMonitoringRequest.ts | 1 + .../ReloadSecureSettingsRequest.ts | 1 + .../delete/SearchApplicationsDeleteRequest.ts | 4 +- .../BehavioralAnalyticsDeleteRequest.ts | 1 + .../get/SearchApplicationsGetRequest.ts | 1 + .../BehavioralAnalyticsGetRequest.ts | 1 + .../list/SearchApplicationsListRequest.ts | 1 + .../put/SearchApplicationsPutRequest.ts | 1 + .../BehavioralAnalyticsPutRequest.ts | 1 + .../search/SearchApplicationsSearchRequest.ts | 1 + .../SecurityBulkDeleteRoleRequest.ts | 1 + .../SecurityBulkPutRoleRequest.ts | 1 + .../TestGrokPatternRequest.ts | 1 + .../DeleteTransformRequest.ts | 2 +- .../get_transform/GetTransformRequest.ts | 3 +- .../GetTransformStatsRequest.ts | 3 +- .../PreviewTransformRequest.ts | 1 + .../put_transform/PutTransformRequest.ts | 1 + .../reset_transform/ResetTransformRequest.ts | 1 + .../ScheduleNowTransformRequest.ts | 1 + .../start_transform/StartTransformRequest.ts | 1 + .../stop_transform/StopTransformRequest.ts | 1 + .../UpdateTransformRequest.ts | 1 + .../UpgradeTransformsRequest.ts | 1 + 160 files changed, 1092 insertions(+), 493 deletions(-) create mode 100644 specification/inference/inference/examples/request/InferenceRequestExample1.yaml create mode 100644 specification/inference/inference/examples/request/InferenceRequestExample2.yaml create mode 100644 specification/inference/inference/examples/request/InferenceRequestExample3.yaml create mode 100644 specification/inference/inference/examples/request/InferenceRequestExample4.yaml create mode 100644 specification/inference/inference/examples/response/InferenceResponseExample1.yaml create mode 100644 specification/inference/inference/examples/response/InferenceResponseExample2.yaml create mode 100644 specification/inference/inference/examples/response/InferenceResponseExample3.yaml create mode 100644 specification/inference/inference/examples/response/InferenceResponseExample4.yaml diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 952491d0c8..3e97806371 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -9740,8 +9740,8 @@ "tags": [ "fleet" ], - "summary": "Returns the current global checkpoints for an index", - "description": "This API is design for internal use by the fleet server project.", + "summary": "Get global checkpoints", + "description": "Get the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "operationId": "fleet-global-checkpoints", "parameters": [ { @@ -11265,13 +11265,13 @@ "indices" ], "summary": "Add an index block", - "description": "Limits the operations allowed on an index by blocking specific operation types.", + "description": "Add an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "operationId": "indices-add-block", "parameters": [ { "in": "path", "name": "index", - "description": "A comma separated list of indices to add a block to", + "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "required": true, "deprecated": false, "schema": { @@ -11282,7 +11282,7 @@ { "in": "path", "name": "block", - "description": "The block to add (one of read, write, read_only or metadata)", + "description": "The block type to add to the index.", "required": true, "deprecated": false, "schema": { @@ -11293,7 +11293,7 @@ { "in": "query", "name": "allow_no_indices", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "deprecated": false, "schema": { "type": "boolean" @@ -11303,7 +11303,7 @@ { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:ExpandWildcards" @@ -11313,7 +11313,7 @@ { "in": "query", "name": "ignore_unavailable", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "deprecated": false, "schema": { "type": "boolean" @@ -11323,7 +11323,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -11333,7 +11333,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit operation timeout", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -12163,7 +12163,7 @@ "data stream" ], "summary": "Get data streams", - "description": "Retrieves information about one or more data streams.", + "description": "Get information about one or more data streams.", "operationId": "indices-get-data-stream-1", "parameters": [ { @@ -12194,7 +12194,7 @@ "data stream" ], "summary": "Create a data stream", - "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "You must have a matching index template with data stream enabled.", "operationId": "indices-create-data-stream", "parameters": [ { @@ -12356,7 +12356,7 @@ "data stream" ], "summary": "Get data stream stats", - "description": "Retrieves statistics for one or more data streams.", + "description": "Get statistics for one or more data streams.", "operationId": "indices-data-streams-stats", "parameters": [ { @@ -12377,7 +12377,7 @@ "data stream" ], "summary": "Get data stream stats", - "description": "Retrieves statistics for one or more data streams.", + "description": "Get statistics for one or more data streams.", "operationId": "indices-data-streams-stats-1", "parameters": [ { @@ -12521,7 +12521,7 @@ "indices" ], "summary": "Check aliases", - "description": "Checks if one or more data stream or index aliases exist.", + "description": "Check if one or more data stream or index aliases exist.", "operationId": "indices-exists-alias-1", "parameters": [ { @@ -12645,7 +12645,7 @@ "data stream" ], "summary": "Get data stream lifecycles", - "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get the data stream lifecycle configuration of one or more data streams.", "operationId": "indices-get-data-lifecycle", "parameters": [ { @@ -13439,7 +13439,7 @@ "indices" ], "summary": "Check aliases", - "description": "Checks if one or more data stream or index aliases exist.", + "description": "Check if one or more data stream or index aliases exist.", "operationId": "indices-exists-alias", "parameters": [ { @@ -13948,7 +13948,7 @@ "data stream" ], "summary": "Get data streams", - "description": "Retrieves information about one or more data streams.", + "description": "Get information about one or more data streams.", "operationId": "indices-get-data-stream", "parameters": [ { @@ -16375,6 +16375,7 @@ "inference" ], "summary": "Perform inference on the service", + "description": "This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", "operationId": "inference-inference", "parameters": [ { @@ -16471,6 +16472,7 @@ "inference" ], "summary": "Perform inference on the service", + "description": "This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", "operationId": "inference-inference-1", "parameters": [ { @@ -16873,7 +16875,7 @@ { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -16883,7 +16885,7 @@ { "in": "query", "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -17539,7 +17541,7 @@ "license" ], "summary": "Get license information", - "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "operationId": "license-get", "parameters": [ { @@ -17652,7 +17654,7 @@ { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -17662,7 +17664,7 @@ { "in": "query", "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -22419,7 +22421,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics", "requestBody": { "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" @@ -22436,7 +22438,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-1", "requestBody": { "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" @@ -22455,7 +22457,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-2", "parameters": [ { @@ -22477,7 +22479,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-3", "parameters": [ { @@ -24202,7 +24204,7 @@ "ml anomaly" ], "summary": "Upgrade a snapshot", - "description": "Upgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "operationId": "ml-upgrade-job-snapshot", "parameters": [ { @@ -28152,7 +28154,7 @@ { "in": "path", "name": "name", - "description": "The name of the search application to delete", + "description": "The name of the search application to delete.", "required": true, "deprecated": false, "schema": { @@ -37524,7 +37526,7 @@ "transform" ], "summary": "Get transforms", - "description": "Retrieves configuration information for transforms.", + "description": "Get configuration information for transforms.", "operationId": "transform-get-transform", "parameters": [ { @@ -37656,7 +37658,6 @@ "transform" ], "summary": "Delete a transform", - "description": "Deletes a transform.", "operationId": "transform-delete-transform", "parameters": [ { @@ -37722,7 +37723,7 @@ "transform" ], "summary": "Get transforms", - "description": "Retrieves configuration information for transforms.", + "description": "Get configuration information for transforms.", "operationId": "transform-get-transform-1", "parameters": [ { @@ -37752,7 +37753,7 @@ "transform" ], "summary": "Get transform stats", - "description": "Retrieves usage information for transforms.", + "description": "Get usage information for transforms.", "operationId": "transform-get-transform-stats", "parameters": [ { @@ -102961,7 +102962,7 @@ "inference.delete#inference_id": { "in": "path", "name": "inference_id", - "description": "The inference Id", + "description": "The inference identifier.", "required": true, "deprecated": false, "schema": { @@ -102972,7 +102973,7 @@ "inference.delete#dry_run": { "in": "query", "name": "dry_run", - "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", + "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.", "deprecated": false, "schema": { "type": "boolean" @@ -102982,7 +102983,7 @@ "inference.delete#force": { "in": "query", "name": "force", - "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "deprecated": false, "schema": { "type": "boolean" @@ -103014,7 +103015,7 @@ "inference.inference#task_type": { "in": "path", "name": "task_type", - "description": "The task type", + "description": "The type of inference task that the model performs.", "required": true, "deprecated": false, "schema": { @@ -103025,7 +103026,7 @@ "inference.inference#inference_id": { "in": "path", "name": "inference_id", - "description": "The inference Id", + "description": "The unique identifier for the inference endpoint.", "required": true, "deprecated": false, "schema": { @@ -103036,7 +103037,7 @@ "inference.inference#timeout": { "in": "query", "name": "timeout", - "description": "Specifies the amount of time to wait for the inference request to complete.", + "description": "The amount of time to wait for the inference request to complete.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -103144,7 +103145,7 @@ "ingest.get_geoip_database#id": { "in": "path", "name": "id", - "description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", + "description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "required": true, "deprecated": false, "schema": { @@ -103207,7 +103208,7 @@ "ingest.simulate#id": { "in": "path", "name": "id", - "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", + "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "required": true, "deprecated": false, "schema": { @@ -103259,7 +103260,7 @@ "license.post#master_timeout": { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.", + "description": "The period to wait for a connection to the master node.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -103269,7 +103270,7 @@ "license.post#timeout": { "in": "query", "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -108666,11 +108667,11 @@ "type": "object", "properties": { "query": { - "description": "Query input, required for rerank task.\nNot required for other tasks.", + "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "type": "string" }, "input": { - "description": "Inference input.\nEither a string or an array of strings.", + "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "oneOf": [ { "type": "string" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index c304c4f9d3..ac92cf5e71 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6007,13 +6007,13 @@ "indices" ], "summary": "Add an index block", - "description": "Limits the operations allowed on an index by blocking specific operation types.", + "description": "Add an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "operationId": "indices-add-block", "parameters": [ { "in": "path", "name": "index", - "description": "A comma separated list of indices to add a block to", + "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "required": true, "deprecated": false, "schema": { @@ -6024,7 +6024,7 @@ { "in": "path", "name": "block", - "description": "The block to add (one of read, write, read_only or metadata)", + "description": "The block type to add to the index.", "required": true, "deprecated": false, "schema": { @@ -6035,7 +6035,7 @@ { "in": "query", "name": "allow_no_indices", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "deprecated": false, "schema": { "type": "boolean" @@ -6045,7 +6045,7 @@ { "in": "query", "name": "expand_wildcards", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:ExpandWildcards" @@ -6055,7 +6055,7 @@ { "in": "query", "name": "ignore_unavailable", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "deprecated": false, "schema": { "type": "boolean" @@ -6065,7 +6065,7 @@ { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -6075,7 +6075,7 @@ { "in": "query", "name": "timeout", - "description": "Explicit operation timeout", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -6606,7 +6606,7 @@ "data stream" ], "summary": "Get data streams", - "description": "Retrieves information about one or more data streams.", + "description": "Get information about one or more data streams.", "operationId": "indices-get-data-stream-1", "parameters": [ { @@ -6637,7 +6637,7 @@ "data stream" ], "summary": "Create a data stream", - "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "You must have a matching index template with data stream enabled.", "operationId": "indices-create-data-stream", "parameters": [ { @@ -6747,7 +6747,7 @@ "data stream" ], "summary": "Get data stream stats", - "description": "Retrieves statistics for one or more data streams.", + "description": "Get statistics for one or more data streams.", "operationId": "indices-data-streams-stats", "parameters": [ { @@ -6768,7 +6768,7 @@ "data stream" ], "summary": "Get data stream stats", - "description": "Retrieves statistics for one or more data streams.", + "description": "Get statistics for one or more data streams.", "operationId": "indices-data-streams-stats-1", "parameters": [ { @@ -6912,7 +6912,7 @@ "indices" ], "summary": "Check aliases", - "description": "Checks if one or more data stream or index aliases exist.", + "description": "Check if one or more data stream or index aliases exist.", "operationId": "indices-exists-alias-1", "parameters": [ { @@ -7036,7 +7036,7 @@ "data stream" ], "summary": "Get data stream lifecycles", - "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get the data stream lifecycle configuration of one or more data streams.", "operationId": "indices-get-data-lifecycle", "parameters": [ { @@ -7469,7 +7469,7 @@ "indices" ], "summary": "Check aliases", - "description": "Checks if one or more data stream or index aliases exist.", + "description": "Check if one or more data stream or index aliases exist.", "operationId": "indices-exists-alias", "parameters": [ { @@ -7629,7 +7629,7 @@ "data stream" ], "summary": "Get data streams", - "description": "Retrieves information about one or more data streams.", + "description": "Get information about one or more data streams.", "operationId": "indices-get-data-stream", "parameters": [ { @@ -9003,6 +9003,7 @@ "inference" ], "summary": "Perform inference on the service", + "description": "This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", "operationId": "inference-inference", "parameters": [ { @@ -9099,6 +9100,7 @@ "inference" ], "summary": "Perform inference on the service", + "description": "This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", "operationId": "inference-inference-1", "parameters": [ { @@ -9643,7 +9645,7 @@ "license" ], "summary": "Get license information", - "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "operationId": "license-get", "parameters": [ { @@ -12703,7 +12705,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics", "requestBody": { "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" @@ -12720,7 +12722,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-1", "requestBody": { "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics" @@ -12739,7 +12741,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-2", "parameters": [ { @@ -12761,7 +12763,7 @@ "ml data frame" ], "summary": "Preview features used by data frame analytics", - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview the extracted features used by a data frame analytics config.", "operationId": "ml-preview-data-frame-analytics-3", "parameters": [ { @@ -16732,7 +16734,7 @@ { "in": "path", "name": "name", - "description": "The name of the search application to delete", + "description": "The name of the search application to delete.", "required": true, "deprecated": false, "schema": { @@ -19006,7 +19008,7 @@ "transform" ], "summary": "Get transforms", - "description": "Retrieves configuration information for transforms.", + "description": "Get configuration information for transforms.", "operationId": "transform-get-transform", "parameters": [ { @@ -19138,7 +19140,6 @@ "transform" ], "summary": "Delete a transform", - "description": "Deletes a transform.", "operationId": "transform-delete-transform", "parameters": [ { @@ -19204,7 +19205,7 @@ "transform" ], "summary": "Get transforms", - "description": "Retrieves configuration information for transforms.", + "description": "Get configuration information for transforms.", "operationId": "transform-get-transform-1", "parameters": [ { @@ -19234,7 +19235,7 @@ "transform" ], "summary": "Get transform stats", - "description": "Retrieves usage information for transforms.", + "description": "Get usage information for transforms.", "operationId": "transform-get-transform-stats", "parameters": [ { @@ -60817,7 +60818,7 @@ "inference.delete#inference_id": { "in": "path", "name": "inference_id", - "description": "The inference Id", + "description": "The inference identifier.", "required": true, "deprecated": false, "schema": { @@ -60828,7 +60829,7 @@ "inference.delete#dry_run": { "in": "query", "name": "dry_run", - "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", + "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.", "deprecated": false, "schema": { "type": "boolean" @@ -60838,7 +60839,7 @@ "inference.delete#force": { "in": "query", "name": "force", - "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "deprecated": false, "schema": { "type": "boolean" @@ -60870,7 +60871,7 @@ "inference.inference#task_type": { "in": "path", "name": "task_type", - "description": "The task type", + "description": "The type of inference task that the model performs.", "required": true, "deprecated": false, "schema": { @@ -60881,7 +60882,7 @@ "inference.inference#inference_id": { "in": "path", "name": "inference_id", - "description": "The inference Id", + "description": "The unique identifier for the inference endpoint.", "required": true, "deprecated": false, "schema": { @@ -60892,7 +60893,7 @@ "inference.inference#timeout": { "in": "query", "name": "timeout", - "description": "Specifies the amount of time to wait for the inference request to complete.", + "description": "The amount of time to wait for the inference request to complete.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -60987,7 +60988,7 @@ "ingest.simulate#id": { "in": "path", "name": "id", - "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", + "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "required": true, "deprecated": false, "schema": { @@ -64013,11 +64014,11 @@ "type": "object", "properties": { "query": { - "description": "Query input, required for rerank task.\nNot required for other tasks.", + "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "type": "string" }, "input": { - "description": "Inference input.\nEither a string or an array of strings.", + "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "oneOf": [ { "type": "string" diff --git a/output/schema/schema.json b/output/schema/schema.json index 40f9986de2..871a91edb5 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -1539,8 +1539,8 @@ } }, "description": "Get task information.\n\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", - "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "docId": "cat-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-tasks.html", "name": "cat.tasks", "privileges": { "cluster": [ @@ -4535,7 +4535,8 @@ } }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", + "docId": "delete-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html", "name": "enrich.delete_policy", "request": { "name": "Request", @@ -4606,7 +4607,8 @@ } }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", + "docId": "get-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html", "name": "enrich.get_policy", "request": { "name": "Request", @@ -4686,7 +4688,8 @@ } }, "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", + "docId": "enrich-stats-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html", "name": "enrich.stats", "request": { "name": "Request", @@ -4721,7 +4724,8 @@ } }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "docId": "eql-async-search-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-eql-delete", "name": "eql.delete", "request": { "name": "Request", @@ -4828,7 +4832,8 @@ } }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "docId": "eql-search-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html", "extDocId": "eql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", @@ -5140,7 +5145,8 @@ } }, "description": "Get the features.\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", + "docId": "get-features-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-features-api.html", "extDocId": "snapshot-create", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html", "name": "features.get_features", @@ -5177,7 +5183,8 @@ } }, "description": "Reset the features.\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", + "docId": "features-reset", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-features-api.html", "name": "features.reset_features", "request": { "name": "Request", @@ -5315,8 +5322,9 @@ "stability": "stable" } }, - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", + "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", + "docId": "get-global-checkpoints", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-global-checkpoints.html", "name": "fleet.global_checkpoints", "request": { "name": "Request", @@ -5354,7 +5362,8 @@ } }, "description": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.\nThe API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", - "docUrl": null, + "docId": "fleet-multi-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-multi-search.html", "name": "fleet.msearch", "privileges": { "index": [ @@ -5430,7 +5439,8 @@ } }, "description": "The purpose of the fleet search api is to provide a search api where the search will only be executed\nafter provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", - "docUrl": null, + "docId": "fleet-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-search.html", "name": "fleet.search", "privileges": { "index": [ @@ -5514,8 +5524,9 @@ } }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", + "docId": "script-get", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-stored-script-api.html", "name": "get_script", "privileges": { "cluster": [ @@ -5713,7 +5724,8 @@ } }, "description": "Get the cluster health.\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", + "docId": "health-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/health-api.html", "name": "health_report", "request": { "name": "Request", @@ -5750,7 +5762,8 @@ } }, "description": "Delete a lifecycle policy.\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", + "docId": "ilm-delete-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html", "name": "ilm.delete_lifecycle", "privileges": { "cluster": [ @@ -5786,7 +5799,8 @@ } }, "description": "Explain the lifecycle state.\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", + "docId": "ilm-explain-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-explain-lifecycle.html", "name": "ilm.explain_lifecycle", "privileges": { "index": [ @@ -5823,7 +5837,8 @@ } }, "description": "Get lifecycle policies.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", + "docId": "ilm-get-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-lifecycle.html", "name": "ilm.get_lifecycle", "privileges": { "cluster": [ @@ -5865,8 +5880,9 @@ "stability": "stable" } }, - "description": "Get the ILM status.\nGet the current index lifecycle management status.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", + "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", + "docId": "ilm-get-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-status.html", "name": "ilm.get_status", "privileges": { "cluster": [ @@ -5902,7 +5918,8 @@ } }, "description": "Migrate to data tiers routing.\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", + "docId": "ilm-migrate-to-data-tiers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-migrate-to-data-tiers.html", "extDocId": "migrate-index-allocation-filters", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-index-allocation-filters.html", "name": "ilm.migrate_to_data_tiers", @@ -5938,7 +5955,8 @@ } }, "description": "Move to a lifecycle step.\nManually move an index into a specific step in the lifecycle policy and run that step.\n\nWARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.\n\nYou must specify both the current step and the step to be executed in the body of the request.\nThe request will fail if the current step does not match the step currently running for the index\nThis is to prevent the index from being moved from an unexpected step into the next step.\n\nWhen specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.\nIf only the phase is specified, the index will move to the first step of the first action in the target phase.\nIf the phase and action are specified, the index will move to the first step of the specified action in the specified phase.\nOnly actions specified in the ILM policy are considered valid.\nAn index cannot move to a step that is not part of its policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", + "docId": "ilm-move-to-step", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-move-to-step.html", "name": "ilm.move_to_step", "privileges": { "index": [ @@ -5977,7 +5995,8 @@ } }, "description": "Create or update a lifecycle policy.\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", + "docId": "ilm-put-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-put-lifecycle.html", "extDocId": "ilm-index-lifecycle", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-index-lifecycle.html", "name": "ilm.put_lifecycle", @@ -6021,7 +6040,8 @@ } }, "description": "Remove policies from an index.\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", + "docId": "ilm-remove-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-remove-policy.html", "name": "ilm.remove_policy", "privileges": { "index": [ @@ -6057,7 +6077,8 @@ } }, "description": "Retry a policy.\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", + "docId": "ilm-retry-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-retry-policy.html", "name": "ilm.retry", "privileges": { "index": [ @@ -6093,7 +6114,8 @@ } }, "description": "Start the ILM plugin.\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", + "docId": "ilm-start", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-start.html", "name": "ilm.start", "privileges": { "cluster": [ @@ -6129,7 +6151,8 @@ } }, "description": "Stop the ILM plugin.\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", + "docId": "ilm-stop", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-stop.html", "name": "ilm.stop", "privileges": { "cluster": [ @@ -6221,8 +6244,9 @@ "stability": "stable" } }, - "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", + "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", + "docId": "index-block-add", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-blocks.html#add-index-block", "name": "indices.add_block", "request": { "name": "Request", @@ -6349,7 +6373,8 @@ } }, "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", + "docId": "indices-clearcache", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html", "name": "indices.clear_cache", "privileges": { "index": [ @@ -6391,7 +6416,8 @@ } }, "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", + "docId": "indices-clone-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html", "name": "indices.clone", "privileges": { "index": [ @@ -6518,9 +6544,10 @@ "stability": "stable" } }, - "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", + "docId": "indices-create-data-stream", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html", "name": "indices.create_data_stream", "privileges": { "index": [ @@ -6600,9 +6627,10 @@ "stability": "stable" } }, - "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", + "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", + "docId": "data-stream-stats-api", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-stats-api.html", "name": "indices.data_streams_stats", "privileges": { "index": [ @@ -6734,7 +6762,8 @@ } }, "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", + "docId": "data-stream-delete-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-delete-lifecycle.html", "name": "indices.delete_data_lifecycle", "request": { "name": "Request", @@ -6769,8 +6798,9 @@ } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", + "docId": "data-stream-delete", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-data-stream.html", "name": "indices.delete_data_stream", "privileges": { "index": [ @@ -6996,8 +7026,9 @@ "stability": "stable" } }, - "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", + "docId": "indices-aliases-exist", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias", "name": "indices.exists_alias", "request": { "name": "Request", @@ -7036,8 +7067,9 @@ "stability": "stable" } }, - "description": "Check index templates.\nCheck whether index templates exist.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", + "description": "Check index templates.\n\nCheck whether index templates exist.", + "docId": "index-templates-exist", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-index-template", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -7110,8 +7142,9 @@ } }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "docId": "data-stream-explain-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", @@ -7382,9 +7415,10 @@ "stability": "stable" } }, - "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", + "docId": "data-stream-get-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { "name": "Request", @@ -7456,9 +7490,10 @@ "stability": "stable" } }, - "description": "Get data streams.\nRetrieves information about one or more data streams.", + "description": "Get data streams.\n\nGet information about one or more data streams.", + "docId": "data-stream-get", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-data-stream.html", "name": "indices.get_data_stream", "privileges": { "index": [ @@ -8955,7 +8990,8 @@ } }, "description": "Delete an inference endpoint", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "docId": "inference-api-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-inference-api.html", "name": "inference.delete", "request": { "name": "Request", @@ -8997,7 +9033,8 @@ } }, "description": "Get an inference endpoint", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "docId": "inference-api-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-inference-api.html", "name": "inference.get", "request": { "name": "Request", @@ -9044,9 +9081,15 @@ "visibility": "public" } }, - "description": "Perform inference on the service", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", + "docId": "inference-api-post", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/post-inference-api.html", "name": "inference.inference", + "privileges": { + "cluster": [ + "monitor_inference" + ] + }, "request": { "name": "Request", "namespace": "inference.inference" @@ -9090,7 +9133,8 @@ } }, "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", + "docId": "inference-api-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-inference-api.html", "name": "inference.put", "privileges": { "cluster": [ @@ -9316,8 +9360,9 @@ "stability": "stable" } }, - "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-geoip-database-api.html", + "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", + "docId": "geoip-delete-database", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database", "name": "ingest.delete_geoip_database", "request": { "name": "Request", @@ -9351,7 +9396,8 @@ } }, "description": "Delete IP geolocation database configurations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html", + "docId": "ip-location-delete-database", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-ip-location-database-api.html", "name": "ingest.delete_ip_location_database", "privileges": { "cluster": [ @@ -9391,7 +9437,8 @@ } }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", + "docId": "delete-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", @@ -9464,8 +9511,9 @@ "stability": "stable" } }, - "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-geoip-database-api.html", + "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", + "docId": "geoip-get-database", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database", "name": "ingest.get_geoip_database", "request": { "name": "Request", @@ -9505,7 +9553,8 @@ } }, "description": "Get IP geolocation database configurations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html", + "docId": "ip-location-get-database", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ip-location-database-api.html", "name": "ingest.get_ip_location_database", "privileges": { "cluster": [ @@ -9550,8 +9599,9 @@ "stability": "stable" } }, - "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", + "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "docId": "get-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", @@ -9630,8 +9680,9 @@ "stability": "stable" } }, - "description": "Create or update a GeoIP database configuration.\nRefer to the create or update IP geolocation database configuration API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", + "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", + "docId": "geoip-put-database", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database", "name": "ingest.put_geoip_database", "request": { "name": "Request", @@ -9668,7 +9719,8 @@ } }, "description": "Create or update an IP geolocation database configuration.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html", + "docId": "ip-location-put-database", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-ip-location-database-api.html", "name": "ingest.put_ip_location_database", "privileges": { "cluster": [ @@ -9751,9 +9803,15 @@ "stability": "stable" } }, - "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", + "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "docId": "simulate-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html", "name": "ingest.simulate", + "privileges": { + "cluster": [ + "read_pipeline" + ] + }, "request": { "name": "Request", "namespace": "ingest.simulate" @@ -9833,8 +9891,9 @@ "stability": "stable" } }, - "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", + "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "docId": "delete-license", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html", "extDocId": "license-management", "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html", "name": "license.delete", @@ -9874,8 +9933,9 @@ "stability": "stable" } }, - "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", + "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "docId": "get-license", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html", "name": "license.get", "request": { "name": "Request", @@ -9906,7 +9966,8 @@ } }, "description": "Get the basic license status.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", + "docId": "get-basic-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-basic-status.html", "name": "license.get_basic_status", "privileges": { "cluster": [ @@ -9942,7 +10003,8 @@ } }, "description": "Get the trial status.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", + "docId": "get-trial-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html", "name": "license.get_trial_status", "privileges": { "cluster": [ @@ -9976,8 +10038,9 @@ "stability": "stable" } }, - "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", + "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", + "docId": "update-license", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-license.html", "name": "license.post", "privileges": { "cluster": [ @@ -10016,8 +10079,9 @@ "stability": "stable" } }, - "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", + "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", + "docId": "start-basic", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-basic.html", "name": "license.post_start_basic", "privileges": { "cluster": [ @@ -10408,8 +10472,9 @@ } }, "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "docId": "clear-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-trained-model-deployment-cache.html", "name": "ml.clear_trained_model_deployment_cache", "privileges": { "cluster": [ @@ -10702,8 +10767,9 @@ } }, "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "docId": "ml-delete-expired-data", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-expired-data.html", "name": "ml.delete_expired_data", "privileges": { "cluster": [ @@ -10752,8 +10818,9 @@ } }, "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "docId": "ml-delete-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-filter.html", "name": "ml.delete_filter", "privileges": { "cluster": [ @@ -10793,8 +10860,9 @@ } }, "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "docId": "ml-delete-forecast", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-forecast.html", "name": "ml.delete_forecast", "privileges": { "cluster": [ @@ -10840,8 +10908,9 @@ } }, "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "docId": "ml-delete-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-job.html", "name": "ml.delete_job", "privileges": { "cluster": [ @@ -10881,8 +10950,9 @@ } }, "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "docId": "ml-delete-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-snapshot.html", "name": "ml.delete_model_snapshot", "privileges": { "cluster": [ @@ -10922,8 +10992,9 @@ } }, "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "docId": "delete-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html", "name": "ml.delete_trained_model", "privileges": { "cluster": [ @@ -10963,8 +11034,9 @@ } }, "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "docId": "delete-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ @@ -11007,8 +11079,9 @@ } }, "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "docId": "ml-estimate-memory", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-estimate-model-memory.html", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ @@ -11051,8 +11124,9 @@ } }, "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "docId": "evaluate-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ @@ -11095,8 +11169,9 @@ } }, "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "docId": "explain-dfanalytics", "docTag": "ml data frame", - "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/explain-dfanalytics.html", "name": "ml.explain_data_frame_analytics", "privileges": { "cluster": [ @@ -11147,8 +11222,9 @@ } }, "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", + "docId": "ml-flush-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-flush-job.html", "name": "ml.flush_job", "privileges": { "cluster": [ @@ -11191,8 +11267,9 @@ } }, "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", + "docId": "ml-forecast", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-forecast.html", "name": "ml.forecast", "privileges": { "cluster": [ @@ -11235,8 +11312,9 @@ } }, "description": "Get anomaly detection job results for buckets.\nThe API presents a chronological view of the records, grouped by bucket.", + "docId": "ml-get-bucket", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-bucket.html", "name": "ml.get_buckets", "privileges": { "cluster": [ @@ -11287,8 +11365,9 @@ } }, "description": "Get info about events in calendars.", + "docId": "ml-get-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar-event.html", "name": "ml.get_calendar_events", "privileges": { "cluster": [ @@ -11328,8 +11407,9 @@ } }, "description": "Get calendar configuration info.", + "docId": "ml-get-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar.html", "name": "ml.get_calendars", "privileges": { "cluster": [ @@ -11380,8 +11460,9 @@ } }, "description": "Get anomaly detection job results for categories.", + "docId": "ml-get-category", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-category.html", "name": "ml.get_categories", "privileges": { "cluster": [ @@ -11432,8 +11513,9 @@ } }, "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "docId": "get-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ @@ -11479,8 +11561,9 @@ } }, "description": "Get data frame analytics jobs usage info.", + "docId": "get-dfanalytics-stats", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ @@ -11526,8 +11609,9 @@ } }, "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ @@ -11573,8 +11657,9 @@ } }, "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "docId": "ml-get-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed.html", "name": "ml.get_datafeeds", "privileges": { "cluster": [ @@ -11620,8 +11705,9 @@ } }, "description": "Get filters.\nYou can get a single filter or all filters.", + "docId": "ml-get-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-filter.html", "name": "ml.get_filters", "privileges": { "cluster": [ @@ -11667,8 +11753,9 @@ } }, "description": "Get anomaly detection job results for influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", + "docId": "ml-get-influencer", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-influencer.html", "name": "ml.get_influencers", "privileges": { "cluster": [ @@ -11712,8 +11799,9 @@ } }, "description": "Get anomaly detection jobs usage info.", + "docId": "ml-get-job-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-stats.html", "name": "ml.get_job_stats", "privileges": { "cluster": [ @@ -11759,8 +11847,9 @@ } }, "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", + "docId": "ml-get-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job.html", "name": "ml.get_jobs", "privileges": { "cluster": [ @@ -11806,7 +11895,8 @@ } }, "description": "Get machine learning memory usage info.\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", + "docId": "ml-get-memory", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-memory.html", "name": "ml.get_memory_stats", "privileges": { "cluster": [ @@ -11852,8 +11942,9 @@ } }, "description": "Get anomaly detection job model snapshot upgrade usage info.", + "docId": "ml-get-job-model-snapshot-upgrade-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-model-snapshot-upgrade-stats.html", "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { "cluster": [ @@ -11893,8 +11984,9 @@ } }, "description": "Get model snapshots info.", + "docId": "ml-get-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-snapshot.html", "name": "ml.get_model_snapshots", "privileges": { "cluster": [ @@ -11945,8 +12037,9 @@ } }, "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", + "docId": "ml-get-overall-buckets", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ @@ -11990,8 +12083,9 @@ } }, "description": "Get anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", + "docId": "ml-get-record", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-record.html", "name": "ml.get_records", "privileges": { "cluster": [ @@ -12035,8 +12129,9 @@ } }, "description": "Get trained model configuration info.", + "docId": "get-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html", "name": "ml.get_trained_models", "privileges": { "cluster": [ @@ -12082,8 +12177,9 @@ } }, "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "docId": "get-trained-models-stats", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ @@ -12129,8 +12225,9 @@ } }, "description": "Evaluate a trained model.", + "docId": "infer-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model.html", "name": "ml.infer_trained_model", "request": { "name": "Request", @@ -12178,7 +12275,8 @@ } }, "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", + "docId": "get-ml-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-info.html", "name": "ml.info", "privileges": { "cluster": [ @@ -12218,8 +12316,9 @@ } }, "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "docId": "ml-open-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-open-job.html", "name": "ml.open_job", "privileges": { "cluster": [ @@ -12262,8 +12361,9 @@ } }, "description": "Add scheduled events to the calendar.", + "docId": "ml-post-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-calendar-event.html", "name": "ml.post_calendar_events", "privileges": { "cluster": [ @@ -12306,8 +12406,9 @@ "version": "7.11.0" }, "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", + "docId": "ml-post-data", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-data.html", "name": "ml.post_data", "privileges": { "cluster": [ @@ -12350,9 +12451,10 @@ "stability": "stable" } }, - "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "docId": "preview-dfanalytics", "docTag": "ml data frame", - "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ @@ -12403,8 +12505,9 @@ } }, "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "docId": "ml-preview-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-preview-datafeed.html", "name": "ml.preview_datafeed", "privileges": { "cluster": [ @@ -12458,8 +12561,9 @@ } }, "description": "Create a calendar.", + "docId": "ml-put-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar.html", "name": "ml.put_calendar", "privileges": { "cluster": [ @@ -12502,8 +12606,9 @@ } }, "description": "Add anomaly detection job to calendar.", + "docId": "ml-put-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar-job.html", "name": "ml.put_calendar_job", "privileges": { "cluster": [ @@ -12595,8 +12700,9 @@ } }, "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "docId": "ml-put-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-datafeed.html", "name": "ml.put_datafeed", "privileges": { "cluster": [ @@ -12642,8 +12748,9 @@ } }, "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "docId": "ml-put-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-filter.html", "name": "ml.put_filter", "privileges": { "cluster": [ @@ -12686,8 +12793,9 @@ } }, "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "docId": "ml-put-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html", "name": "ml.put_job", "privileges": { "cluster": [ @@ -12733,8 +12841,9 @@ } }, "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", + "docId": "put-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { "cluster": [ @@ -12777,8 +12886,9 @@ } }, "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "docId": "put-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ @@ -12821,8 +12931,9 @@ } }, "description": "Create part of a trained model definition.", + "docId": "put-trained-model-definition-part", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ @@ -12865,8 +12976,9 @@ } }, "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "docId": "put-trained-model-vocabulary", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ @@ -12909,8 +13021,9 @@ } }, "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "docId": "ml-reset-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-reset-job.html", "name": "ml.reset_job", "privileges": { "cluster": [ @@ -12950,8 +13063,9 @@ } }, "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", + "docId": "ml-revert-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-revert-snapshot.html", "name": "ml.revert_model_snapshot", "privileges": { "cluster": [ @@ -12994,7 +13108,8 @@ } }, "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", + "docId": "ml-set-upgrade-mode", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-set-upgrade-mode.html", "name": "ml.set_upgrade_mode", "privileges": { "cluster": [ @@ -13034,8 +13149,9 @@ } }, "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "docId": "start-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ @@ -13085,8 +13201,9 @@ } }, "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", + "docId": "ml-start-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-start-datafeed.html", "name": "ml.start_datafeed", "privileges": { "cluster": [ @@ -13129,8 +13246,9 @@ } }, "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", + "docId": "start-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trained-model-deployment.html", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ @@ -13173,8 +13291,9 @@ } }, "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "docId": "stop-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ @@ -13217,8 +13336,9 @@ } }, "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "docId": "ml-stop-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-stop-datafeed.html", "name": "ml.stop_datafeed", "privileges": { "cluster": [ @@ -13261,8 +13381,9 @@ } }, "description": "Stop a trained model deployment.", + "docId": "stop-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ @@ -13305,8 +13426,9 @@ } }, "description": "Update a data frame analytics job.", + "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -13356,8 +13478,9 @@ } }, "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "docId": "ml-update-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-datafeed.html", "name": "ml.update_datafeed", "privileges": { "cluster": [ @@ -13400,8 +13523,9 @@ } }, "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", + "docId": "ml-update-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-filter.html", "name": "ml.update_filter", "privileges": { "cluster": [ @@ -13444,8 +13568,9 @@ } }, "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", + "docId": "ml-update-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-job.html", "name": "ml.update_job", "privileges": { "cluster": [ @@ -13488,8 +13613,9 @@ } }, "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", + "docId": "ml-update-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-snapshot.html", "name": "ml.update_model_snapshot", "privileges": { "cluster": [ @@ -13532,8 +13658,9 @@ } }, "description": "Update a trained model deployment.", + "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-trained-model-deployment.html", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -13575,9 +13702,10 @@ "stability": "stable" } }, - "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "docId": "ml-upgrade-job-model-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-upgrade-job-model-snapshot.html", "name": "ml.upgrade_job_snapshot", "privileges": { "cluster": [ @@ -13658,8 +13786,9 @@ } }, "description": "Validate an anomaly detection job.", + "docId": "apis", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8", "name": "ml.validate_detector", "request": { "name": "Request", @@ -13694,7 +13823,8 @@ } }, "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", + "docId": "apis", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8", "name": "monitoring.bulk", "request": { "name": "Request", @@ -13744,8 +13874,9 @@ } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "docId": "search-multi-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html", "name": "msearch", "privileges": { "index": [ @@ -14088,8 +14219,9 @@ } }, "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.", + "docId": "cluster-nodes-reload-secure-settings", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-reload-secure-settings.html", "name": "nodes.reload_secure_settings", "request": { "name": "Request", @@ -14310,8 +14442,9 @@ } }, "description": "Ping the cluster.\nGet information about whether the cluster is running.", + "docId": "cluster-ping", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html", "name": "ping", "request": { "name": "Request", @@ -14850,8 +14983,9 @@ } }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", + "docId": "search-rank-eval", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html", "name": "rank_eval", "privileges": { "index": [ @@ -15530,8 +15664,9 @@ "stability": "beta" } }, - "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", + "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "docId": "search-application-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-search-application.html", "name": "search_application.delete", "privileges": { "cluster": [ @@ -15574,8 +15709,9 @@ } }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", + "docId": "delete-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", @@ -15610,7 +15746,8 @@ } }, "description": "Get search application details.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", + "docId": "search-application-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-search-application.html", "name": "search_application.get", "privileges": { "cluster": [ @@ -15650,8 +15787,9 @@ } }, "description": "Get behavioral analytics collections.", + "docId": "list-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", @@ -15692,7 +15830,8 @@ } }, "description": "Get search applications.\nGet information about search applications.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", + "docId": "list-analytics-collection", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", "name": "search_application.list", "privileges": { "cluster": [ @@ -15770,7 +15909,8 @@ } }, "description": "Create or update a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "docId": "search-application-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-search-application.html", "name": "search_application.put", "privileges": { "cluster": [ @@ -15816,8 +15956,9 @@ } }, "description": "Create a behavioral analytics collection.", + "docId": "put-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", @@ -15888,7 +16029,8 @@ } }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", + "docId": "search-application-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-search.html", "name": "search_application.search", "request": { "name": "Request", @@ -16337,7 +16479,8 @@ } }, "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", + "docId": "security-api-bulk-delete-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { "cluster": [ @@ -16380,7 +16523,8 @@ } }, "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", + "docId": "security-api-bulk-put-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { "cluster": [ @@ -21011,7 +21155,8 @@ } }, "description": "Test a Grok pattern.\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", + "docId": "test-grok-pattern", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/test-grok-pattern.html", "extDocId": "grok", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok.html", "name": "text_structure.test_grok_pattern", @@ -21051,8 +21196,9 @@ "stability": "stable" } }, - "description": "Delete a transform.\nDeletes a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", + "description": "Delete a transform.", + "docId": "delete-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html", "name": "transform.delete_transform", "privileges": { "cluster": [ @@ -21116,8 +21262,9 @@ "stability": "stable" } }, - "description": "Get transforms.\nRetrieves configuration information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", + "description": "Get transforms.\nGet configuration information for transforms.", + "docId": "get-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html", "name": "transform.get_transform", "privileges": { "cluster": [ @@ -21162,8 +21309,9 @@ "stability": "stable" } }, - "description": "Get transform stats.\nRetrieves usage information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", + "description": "Get transform stats.\nGet usage information for transforms.", + "docId": "get-transform-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html", "name": "transform.get_transform_stats", "privileges": { "cluster": [ @@ -21207,7 +21355,8 @@ } }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", + "docId": "preview-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html", "name": "transform.preview_transform", "privileges": { "cluster": [ @@ -21262,7 +21411,8 @@ } }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", + "docId": "put-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-transform.html", "name": "transform.put_transform", "privileges": { "cluster": [ @@ -21311,7 +21461,8 @@ } }, "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", + "docId": "reset-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html", "name": "transform.reset_transform", "privileges": { "cluster": [ @@ -21351,7 +21502,8 @@ } }, "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", + "docId": "schedule-now-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/schedule-now-transform.html", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ @@ -21394,7 +21546,8 @@ } }, "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", + "docId": "start-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html", "name": "transform.start_transform", "privileges": { "cluster": [ @@ -21438,7 +21591,8 @@ } }, "description": "Stop transforms.\nStops one or more transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", + "docId": "stop-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html", "name": "transform.stop_transform", "privileges": { "cluster": [ @@ -21478,7 +21632,8 @@ } }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", + "docId": "update-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -21526,7 +21681,8 @@ } }, "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", + "docId": "upgrade-transforms", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html", "name": "transform.upgrade_transforms", "privileges": { "cluster": [ @@ -26536,7 +26692,7 @@ } } ], - "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L55" + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L56" }, { "kind": "response", @@ -28064,7 +28220,7 @@ } } ], - "specLocation": "_global/health_report/Request.ts#L24-L80" + "specLocation": "_global/health_report/Request.ts#L24-L81" }, { "kind": "response", @@ -30465,7 +30621,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L134" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L135" }, { "kind": "type_alias", @@ -31530,7 +31686,7 @@ }, "path": [], "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L37" + "specLocation": "_global/ping/PingRequest.ts#L22-L38" }, { "kind": "response", @@ -32353,7 +32509,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L75" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L76" }, { "kind": "response", @@ -119677,7 +119833,7 @@ } } ], - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L24-L51" + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L24-L52" }, { "kind": "response", @@ -119886,7 +120042,7 @@ } } ], - "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L24-L56" + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L24-L57" }, { "kind": "response", @@ -120269,7 +120425,7 @@ } } ], - "specLocation": "enrich/stats/EnrichStatsRequest.ts#L23-L44" + "specLocation": "enrich/stats/EnrichStatsRequest.ts#L23-L45" }, { "kind": "response", @@ -120708,7 +120864,7 @@ } ], "query": [], - "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L46" + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L47" }, { "kind": "response", @@ -121341,7 +121497,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L148" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L149" }, { "kind": "response", @@ -122299,7 +122455,7 @@ } } ], - "specLocation": "features/get_features/GetFeaturesRequest.ts#L23-L52" + "specLocation": "features/get_features/GetFeaturesRequest.ts#L23-L53" }, { "kind": "response", @@ -122363,7 +122519,7 @@ } } ], - "specLocation": "features/reset_features/ResetFeaturesRequest.ts#L23-L59" + "specLocation": "features/reset_features/ResetFeaturesRequest.ts#L23-L60" }, { "kind": "response", @@ -122415,7 +122571,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "inherits": { "type": { "name": "RequestBase", @@ -122509,7 +122665,7 @@ } } ], - "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L69" + "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L74" }, { "kind": "response", @@ -122774,7 +122930,7 @@ } } ], - "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L124" + "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L125" }, { "kind": "response", @@ -123817,7 +123973,7 @@ } } ], - "specLocation": "fleet/search/SearchRequest.ts#L55-L266" + "specLocation": "fleet/search/SearchRequest.ts#L55-L267" }, { "kind": "response", @@ -125409,7 +125565,7 @@ } } ], - "specLocation": "ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L57" + "specLocation": "ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L58" }, { "kind": "response", @@ -125925,7 +126081,7 @@ } } ], - "specLocation": "ilm/explain_lifecycle/ExplainLifecycleRequest.ts#L24-L63" + "specLocation": "ilm/explain_lifecycle/ExplainLifecycleRequest.ts#L24-L64" }, { "kind": "response", @@ -126067,7 +126223,7 @@ } } ], - "specLocation": "ilm/get_lifecycle/GetLifecycleRequest.ts#L24-L60" + "specLocation": "ilm/get_lifecycle/GetLifecycleRequest.ts#L24-L61" }, { "kind": "response", @@ -126106,7 +126262,7 @@ "body": { "kind": "no_body" }, - "description": "Get the ILM status.\nGet the current index lifecycle management status.", + "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", "inherits": { "type": { "name": "RequestBase", @@ -126119,7 +126275,7 @@ }, "path": [], "query": [], - "specLocation": "ilm/get_status/GetIlmStatusRequest.ts#L22-L36" + "specLocation": "ilm/get_status/GetIlmStatusRequest.ts#L22-L38" }, { "kind": "response", @@ -126204,7 +126360,7 @@ } } ], - "specLocation": "ilm/migrate_to_data_tiers/Request.ts#L22-L60" + "specLocation": "ilm/migrate_to_data_tiers/Request.ts#L22-L61" }, { "kind": "response", @@ -126374,7 +126530,7 @@ } ], "query": [], - "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L63" + "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L64" }, { "kind": "response", @@ -126514,7 +126670,7 @@ } } ], - "specLocation": "ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L65" + "specLocation": "ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L66" }, { "kind": "response", @@ -126568,7 +126724,7 @@ } ], "query": [], - "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L41" + "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L42" }, { "kind": "response", @@ -126642,7 +126798,7 @@ } ], "query": [], - "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L42" + "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L43" }, { "kind": "response", @@ -126710,7 +126866,7 @@ } } ], - "specLocation": "ilm/start/StartIlmRequest.ts#L23-L51" + "specLocation": "ilm/start/StartIlmRequest.ts#L23-L52" }, { "kind": "response", @@ -126778,7 +126934,7 @@ } } ], - "specLocation": "ilm/stop/StopIlmRequest.ts#L23-L53" + "specLocation": "ilm/stop/StopIlmRequest.ts#L23-L54" }, { "kind": "response", @@ -131264,15 +131420,19 @@ "kind": "enum", "members": [ { + "description": "Disable metadata changes, such as closing the index.", "name": "metadata" }, { + "description": "Disable read operations.", "name": "read" }, { + "description": "Disable write operations and metadata changes.", "name": "read_only" }, { + "description": "Disable write operations. However, metadata changes are still allowed.", "name": "write" } ], @@ -131280,7 +131440,7 @@ "name": "IndicesBlockOptions", "namespace": "indices.add_block" }, - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L51-L56" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L91-L100" }, { "kind": "interface", @@ -131322,7 +131482,7 @@ "body": { "kind": "no_body" }, - "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", + "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "inherits": { "type": { "name": "RequestBase", @@ -131335,7 +131495,7 @@ }, "path": [ { - "description": "A comma separated list of indices to add a block to", + "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "name": "index", "required": true, "type": { @@ -131347,7 +131507,7 @@ } }, { - "description": "The block to add (one of read, write, read_only or metadata)", + "description": "The block type to add to the index.", "name": "block", "required": true, "type": { @@ -131361,9 +131521,10 @@ ], "query": [ { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -131373,9 +131534,10 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -131385,9 +131547,10 @@ } }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -131397,9 +131560,10 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131409,9 +131573,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131421,7 +131586,7 @@ } } ], - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L49" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L89" }, { "kind": "response", @@ -132272,7 +132437,7 @@ } } ], - "specLocation": "indices/clear_cache/IndicesClearCacheRequest.ts#L23-L93" + "specLocation": "indices/clear_cache/IndicesClearCacheRequest.ts#L23-L94" }, { "kind": "response", @@ -132426,7 +132591,7 @@ } } ], - "specLocation": "indices/clone/IndicesCloneRequest.ts#L27-L126" + "specLocation": "indices/clone/IndicesCloneRequest.ts#L27-L127" }, { "kind": "response", @@ -132894,7 +133059,7 @@ "body": { "kind": "no_body" }, - "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", "inherits": { "type": { "name": "RequestBase", @@ -132947,7 +133112,7 @@ } } ], - "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L64" + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L65" }, { "kind": "response", @@ -133203,7 +133368,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", + "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -133243,7 +133408,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L59" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L61" }, { "kind": "response", @@ -133617,7 +133782,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L46" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L47" }, { "kind": "response", @@ -133698,7 +133863,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L58" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L59" }, { "kind": "response", @@ -134200,7 +134365,7 @@ "body": { "kind": "no_body" }, - "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", + "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", "inherits": { "type": { "name": "RequestBase", @@ -134295,7 +134460,7 @@ } } ], - "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L79" + "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L81" }, { "kind": "response", @@ -134316,7 +134481,7 @@ "body": { "kind": "no_body" }, - "description": "Check index templates.\nCheck whether index templates exist.", + "description": "Check index templates.\n\nCheck whether index templates exist.", "inherits": { "type": { "name": "RequestBase", @@ -134356,7 +134521,7 @@ } } ], - "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L49" + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L51" }, { "kind": "response", @@ -134642,7 +134807,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L46" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L47" }, { "kind": "response", @@ -135910,7 +136075,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -135976,7 +136141,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L66" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L68" }, { "kind": "response", @@ -136164,7 +136329,7 @@ "body": { "kind": "no_body" }, - "description": "Get data streams.\nRetrieves information about one or more data streams.", + "description": "Get data streams.\n\nGet information about one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -136252,7 +136417,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L76" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L78" }, { "kind": "response", @@ -145804,7 +145969,7 @@ } }, { - "description": "The inference Id", + "description": "The inference identifier.", "name": "inference_id", "required": true, "type": { @@ -145818,7 +145983,7 @@ ], "query": [ { - "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", + "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.", "name": "dry_run", "required": false, "serverDefault": false, @@ -145831,7 +145996,7 @@ } }, { - "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "name": "force", "required": false, "serverDefault": false, @@ -145844,7 +146009,7 @@ } } ], - "specLocation": "inference/delete/DeleteRequest.ts#L24-L65" + "specLocation": "inference/delete/DeleteRequest.ts#L24-L66" }, { "kind": "response", @@ -145910,7 +146075,7 @@ } ], "query": [], - "specLocation": "inference/get/GetRequest.ts#L24-L55" + "specLocation": "inference/get/GetRequest.ts#L24-L56" }, { "kind": "response", @@ -145948,7 +146113,7 @@ "kind": "properties", "properties": [ { - "description": "Query input, required for rerank task.\nNot required for other tasks.", + "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "name": "query", "required": false, "type": { @@ -145960,7 +146125,7 @@ } }, { - "description": "Inference input.\nEither a string or an array of strings.", + "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "name": "input", "required": true, "type": { @@ -145987,7 +146152,7 @@ } }, { - "description": "Optional task settings", + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "name": "task_settings", "required": false, "type": { @@ -146000,7 +146165,7 @@ } ] }, - "description": "Perform inference on the service", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.", "inherits": { "type": { "name": "RequestBase", @@ -146013,7 +146178,7 @@ }, "path": [ { - "description": "The task type", + "description": "The type of inference task that the model performs.", "name": "task_type", "required": false, "type": { @@ -146025,7 +146190,7 @@ } }, { - "description": "The inference Id", + "description": "The unique identifier for the inference endpoint.", "name": "inference_id", "required": true, "type": { @@ -146039,7 +146204,7 @@ ], "query": [ { - "description": "Specifies the amount of time to wait for the inference request to complete.", + "description": "The amount of time to wait for the inference request to complete.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -146052,7 +146217,7 @@ } } ], - "specLocation": "inference/inference/InferenceRequest.ts#L26-L76" + "specLocation": "inference/inference/InferenceRequest.ts#L26-L89" }, { "kind": "response", @@ -146126,7 +146291,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L64" + "specLocation": "inference/put/PutRequest.ts#L25-L65" }, { "kind": "response", @@ -152065,7 +152230,7 @@ "body": { "kind": "no_body" }, - "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", + "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -152092,7 +152257,7 @@ ], "query": [ { - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -152105,7 +152270,7 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -152118,7 +152283,7 @@ } } ], - "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L55" + "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L57" }, { "kind": "response", @@ -152199,7 +152364,7 @@ } } ], - "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts#L24-L59" + "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts#L24-L60" }, { "kind": "response", @@ -152280,7 +152445,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L60" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L61" }, { "kind": "response", @@ -152596,7 +152761,7 @@ "body": { "kind": "no_body" }, - "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", + "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -152609,7 +152774,7 @@ }, "path": [ { - "description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", + "description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "name": "id", "required": false, "type": { @@ -152622,7 +152787,7 @@ } ], "query": [], - "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L23-L49" + "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L23-L51" }, { "kind": "response", @@ -152782,7 +152947,7 @@ } } ], - "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts#L24-L58" + "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts#L24-L59" }, { "kind": "response", @@ -152819,7 +152984,7 @@ "body": { "kind": "no_body" }, - "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -152872,7 +153037,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L62" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" }, { "kind": "response", @@ -152995,7 +153160,7 @@ } ] }, - "description": "Create or update a GeoIP database configuration.\nRefer to the create or update IP geolocation database configuration API.", + "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", "inherits": { "type": { "name": "RequestBase", @@ -153048,7 +153213,7 @@ } } ], - "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L64" + "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L66" }, { "kind": "response", @@ -153137,7 +153302,7 @@ } } ], - "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts#L25-L61" + "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts#L25-L62" }, { "kind": "response", @@ -153355,7 +153520,7 @@ } }, { - "description": "Pipeline to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "name": "pipeline", "required": false, "type": { @@ -153368,7 +153533,7 @@ } ] }, - "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "inherits": { "type": { "name": "RequestBase", @@ -153381,7 +153546,7 @@ }, "path": [ { - "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", + "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "name": "id", "required": false, "type": { @@ -153407,7 +153572,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L69" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" }, { "kind": "response", @@ -153662,7 +153827,7 @@ "body": { "kind": "no_body" }, - "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -153676,7 +153841,7 @@ "path": [], "query": [ { - "description": "Period to wait for a connection to the master node.", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -153689,7 +153854,7 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -153702,7 +153867,7 @@ } } ], - "specLocation": "license/delete/DeleteLicenseRequest.ts#L23-L52" + "specLocation": "license/delete/DeleteLicenseRequest.ts#L23-L54" }, { "kind": "response", @@ -153923,7 +154088,7 @@ "body": { "kind": "no_body" }, - "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "inherits": { "type": { "name": "RequestBase", @@ -153967,7 +154132,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L53" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L56" }, { "kind": "response", @@ -154014,7 +154179,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L35" + "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L36" }, { "kind": "response", @@ -154061,7 +154226,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L35" + "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L36" }, { "kind": "response", @@ -154158,7 +154323,7 @@ } ] }, - "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", + "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -154185,7 +154350,7 @@ } }, { - "description": "Period to wait for a connection to the master node.", + "description": "The period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -154198,7 +154363,7 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -154211,7 +154376,7 @@ } } ], - "specLocation": "license/post/PostLicenseRequest.ts#L24-L68" + "specLocation": "license/post/PostLicenseRequest.ts#L24-L70" }, { "kind": "response", @@ -154267,7 +154432,7 @@ "body": { "kind": "no_body" }, - "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", + "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "inherits": { "type": { "name": "RequestBase", @@ -154319,7 +154484,7 @@ } } ], - "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L23-L57" + "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L23-L59" }, { "kind": "response", @@ -167969,7 +168134,7 @@ } ], "query": [], - "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L48" + "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L49" }, { "kind": "response", @@ -168588,7 +168753,7 @@ } } ], - "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L83" + "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L84" }, { "kind": "response", @@ -168648,7 +168813,7 @@ } ], "query": [], - "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L46" + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L47" }, { "kind": "response", @@ -168741,7 +168906,7 @@ } } ], - "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L76" + "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L77" }, { "kind": "response", @@ -168834,7 +168999,7 @@ } } ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L70" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L71" }, { "kind": "response", @@ -168900,7 +169065,7 @@ } ], "query": [], - "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L51" + "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L52" }, { "kind": "response", @@ -168980,7 +169145,7 @@ } } ], - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L55" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L56" }, { "kind": "response", @@ -169046,7 +169211,7 @@ } ], "query": [], - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L51" + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L52" }, { "kind": "response", @@ -169147,7 +169312,7 @@ }, "path": [], "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L69" + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L70" }, { "kind": "response", @@ -169866,7 +170031,7 @@ }, "path": [], "query": [], - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L59" + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L60" }, { "kind": "response", @@ -170056,7 +170221,7 @@ } ], "query": [], - "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L118" + "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L119" }, { "kind": "response", @@ -170255,7 +170420,7 @@ } } ], - "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L106" + "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L107" }, { "kind": "response", @@ -170408,7 +170573,7 @@ } } ], - "specLocation": "ml/forecast/MlForecastJobRequest.ts#L24-L94" + "specLocation": "ml/forecast/MlForecastJobRequest.ts#L24-L95" }, { "kind": "response", @@ -170713,7 +170878,7 @@ } } ], - "specLocation": "ml/get_buckets/MlGetBucketsRequest.ts#L26-L144" + "specLocation": "ml/get_buckets/MlGetBucketsRequest.ts#L26-L145" }, { "kind": "response", @@ -170850,7 +171015,7 @@ } } ], - "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L60" + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L61" }, { "kind": "response", @@ -171014,7 +171179,7 @@ } } ], - "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L62" + "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L63" }, { "kind": "response", @@ -171153,7 +171318,7 @@ } } ], - "specLocation": "ml/get_categories/MlGetCategoriesRequest.ts#L25-L81" + "specLocation": "ml/get_categories/MlGetCategoriesRequest.ts#L25-L82" }, { "kind": "response", @@ -171280,7 +171445,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L88" + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L89" }, { "kind": "response", @@ -171408,7 +171573,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L83" + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L84" }, { "kind": "response", @@ -171496,7 +171661,7 @@ } } ], - "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L71" + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L72" }, { "kind": "response", @@ -171596,7 +171761,7 @@ } } ], - "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L77" + "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L78" }, { "kind": "response", @@ -171697,7 +171862,7 @@ } } ], - "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L62" + "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L63" }, { "kind": "response", @@ -171889,7 +172054,7 @@ } } ], - "specLocation": "ml/get_influencers/MlGetInfluencersRequest.ts#L26-L104" + "specLocation": "ml/get_influencers/MlGetInfluencersRequest.ts#L26-L105" }, { "kind": "response", @@ -171978,7 +172143,7 @@ } } ], - "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L67" + "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L68" }, { "kind": "response", @@ -172079,7 +172244,7 @@ } } ], - "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L77" + "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L78" }, { "kind": "response", @@ -172568,7 +172733,7 @@ } } ], - "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L65" + "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L66" }, { "kind": "response", @@ -172686,7 +172851,7 @@ } } ], - "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts#L23-L64" + "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts#L23-L65" }, { "kind": "response", @@ -172910,7 +173075,7 @@ } } ], - "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts#L26-L107" + "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts#L26-L108" }, { "kind": "response", @@ -173185,7 +173350,7 @@ } } ], - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L152" + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L153" }, { "kind": "response", @@ -173456,7 +173621,7 @@ } } ], - "specLocation": "ml/get_records/MlGetAnomalyRecordsRequest.ts#L26-L134" + "specLocation": "ml/get_records/MlGetAnomalyRecordsRequest.ts#L26-L135" }, { "kind": "response", @@ -173651,7 +173816,7 @@ } } ], - "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L109" + "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L110" }, { "kind": "response", @@ -173766,7 +173931,7 @@ } } ], - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L76" + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L77" }, { "kind": "response", @@ -173892,7 +174057,7 @@ } } ], - "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L71" + "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L72" }, { "kind": "response", @@ -174157,7 +174322,7 @@ }, "path": [], "query": [], - "specLocation": "ml/info/MlInfoRequest.ts#L22-L43" + "specLocation": "ml/info/MlInfoRequest.ts#L22-L44" }, { "kind": "response", @@ -174279,7 +174444,7 @@ } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L65" + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L66" }, { "kind": "response", @@ -174368,7 +174533,7 @@ } ], "query": [], - "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L47" + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L48" }, { "kind": "response", @@ -174477,7 +174642,7 @@ } } ], - "specLocation": "ml/post_data/MlPostJobDataRequest.ts#L24-L75" + "specLocation": "ml/post_data/MlPostJobDataRequest.ts#L24-L76" }, { "kind": "response", @@ -174833,7 +174998,7 @@ } ] }, - "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", "inherits": { "type": { "name": "RequestBase", @@ -174859,7 +175024,7 @@ } ], "query": [], - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L59" + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L60" }, { "kind": "response", @@ -174985,7 +175150,7 @@ } } ], - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L80" + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L81" }, { "kind": "response", @@ -175077,7 +175242,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L50" + "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L51" }, { "kind": "response", @@ -175174,7 +175339,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L44" + "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L45" }, { "kind": "response", @@ -175870,7 +176035,7 @@ } } ], - "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L183" + "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L184" }, { "kind": "response", @@ -176138,7 +176303,7 @@ } ], "query": [], - "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L57" + "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L58" }, { "kind": "response", @@ -176481,7 +176646,7 @@ } } ], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L155" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L156" }, { "kind": "response", @@ -177259,7 +177424,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L134" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" }, { "kind": "response", @@ -177643,7 +177808,7 @@ } } ], - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L73" + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L74" }, { "kind": "response", @@ -177747,7 +177912,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L64" + "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L65" }, { "kind": "response", @@ -177860,7 +178025,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L67" + "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68" }, { "kind": "response", @@ -177941,7 +178106,7 @@ } } ], - "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L64" + "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L65" }, { "kind": "response", @@ -178036,7 +178201,7 @@ } } ], - "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L76" + "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L77" }, { "kind": "response", @@ -178110,7 +178275,7 @@ } } ], - "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L63" + "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L64" }, { "kind": "response", @@ -178178,7 +178343,7 @@ } } ], - "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L67" + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L68" }, { "kind": "response", @@ -178327,7 +178492,7 @@ } } ], - "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L98" + "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L99" }, { "kind": "response", @@ -178507,7 +178672,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L100" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L101" }, { "kind": "response", @@ -178607,7 +178772,7 @@ } } ], - "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L77" + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L78" }, { "kind": "response", @@ -178748,7 +178913,7 @@ } } ], - "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L85" + "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L86" }, { "kind": "response", @@ -178835,7 +179000,7 @@ } } ], - "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L60" + "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L61" }, { "kind": "response", @@ -178952,7 +179117,7 @@ } ], "query": [], - "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L79" + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L80" }, { "kind": "response", @@ -179377,7 +179542,7 @@ } } ], - "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L169" + "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L170" }, { "kind": "response", @@ -179660,7 +179825,7 @@ } ], "query": [], - "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L59" + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L60" }, { "kind": "response", @@ -179949,7 +180114,7 @@ } ], "query": [], - "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L146" + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L147" }, { "kind": "response", @@ -180300,7 +180465,7 @@ } ], "query": [], - "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L62" + "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L63" }, { "kind": "response", @@ -180400,7 +180565,7 @@ } } ], - "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L69" + "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L70" }, { "kind": "response", @@ -180434,7 +180599,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "inherits": { "type": { "name": "RequestBase", @@ -180499,7 +180664,7 @@ } } ], - "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L71" + "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L72" }, { "kind": "response", @@ -180709,7 +180874,7 @@ }, "path": [], "query": [], - "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L39" + "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L40" }, { "kind": "response", @@ -180860,7 +181025,7 @@ } } ], - "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L72" + "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L73" }, { "kind": "response", @@ -189153,7 +189318,7 @@ } } ], - "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L69" + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L70" }, { "kind": "response", @@ -192649,7 +192814,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "inherits": { "type": { "name": "RequestBase", @@ -192662,7 +192827,7 @@ }, "path": [ { - "description": "The name of the search application to delete", + "description": "The name of the search application to delete.", "name": "name", "required": true, "type": { @@ -192675,7 +192840,7 @@ } ], "query": [], - "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L44" + "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L46" }, { "kind": "response", @@ -192729,7 +192894,7 @@ } ], "query": [], - "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L43" + "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L44" }, { "kind": "response", @@ -192783,7 +192948,7 @@ } ], "query": [], - "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L42" + "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L43" }, { "kind": "response", @@ -192840,7 +193005,7 @@ } ], "query": [], - "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L46" + "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L47" }, { "kind": "response", @@ -192930,7 +193095,7 @@ } } ], - "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L52" + "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L53" }, { "kind": "response", @@ -193151,7 +193316,7 @@ } } ], - "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L56" + "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L57" }, { "kind": "response", @@ -193239,7 +193404,7 @@ } ], "query": [], - "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L42" + "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L43" }, { "kind": "response", @@ -193402,7 +193567,7 @@ } } ], - "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L60" + "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L61" }, { "kind": "response", @@ -197185,7 +197350,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L49" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L50" }, { "kind": "response", @@ -197301,7 +197466,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L51" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L52" }, { "kind": "response", @@ -218119,7 +218284,7 @@ } } ], - "specLocation": "text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L23-L58" + "specLocation": "text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L23-L59" }, { "kind": "response", @@ -218608,7 +218773,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a transform.\nDeletes a transform.", + "description": "Delete a transform.", "inherits": { "type": { "name": "RequestBase", @@ -218702,7 +218867,7 @@ "body": { "kind": "no_body" }, - "description": "Get transforms.\nRetrieves configuration information for transforms.", + "description": "Get transforms.\nGet configuration information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -218781,7 +218946,7 @@ } } ], - "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L83" + "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L84" }, { "kind": "response", @@ -219181,7 +219346,7 @@ "body": { "kind": "no_body" }, - "description": "Get transform stats.\nRetrieves usage information for transforms.", + "description": "Get transform stats.\nGet usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -219259,7 +219424,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L75" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L76" }, { "kind": "response", @@ -219876,7 +220041,7 @@ } } ], - "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L118" + "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L119" }, { "kind": "response", @@ -220106,7 +220271,7 @@ } } ], - "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L129" + "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L130" }, { "kind": "response", @@ -220187,7 +220352,7 @@ } } ], - "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L24-L61" + "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L24-L62" }, { "kind": "response", @@ -220255,7 +220420,7 @@ } } ], - "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L56" + "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L57" }, { "kind": "response", @@ -220335,7 +220500,7 @@ } } ], - "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L72" + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L73" }, { "kind": "response", @@ -220455,7 +220620,7 @@ } } ], - "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L83" + "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L84" }, { "kind": "response", @@ -220646,7 +220811,7 @@ } } ], - "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L112" + "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L113" }, { "kind": "response", @@ -220863,7 +221028,7 @@ } } ], - "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L63" + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L64" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index bbf1f526df..6f32734a1a 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -1,3 +1,4 @@ +apis,https://www.elastic.co/docs/api/doc/elasticsearch/v8 add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html @@ -45,6 +46,7 @@ cat-repositories,https://www.elastic.co/guide/en/elasticsearch/reference/{branch cat-segments,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html cat-shards,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html cat-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html +cat-tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-tasks.html cat-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html cat-thread-pool,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html cat-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html @@ -70,6 +72,7 @@ ccs-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ clean-up-snapshot-repo,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-cleanup 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 +clear-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-trained-model-deployment-cache.html cluster-allocation-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html cluster-get-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html cluster-health,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html @@ -77,10 +80,12 @@ cluster-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cl cluster-name,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html#cluster-name cluster-nodes-hot-threads,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html cluster-nodes-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html +cluster-nodes-reload-secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-reload-secure-settings.html cluster-nodes-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html cluster-nodes-usage,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html cluster-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes cluster-pending,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-pending.html +cluster-ping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html cluster-remote-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html cluster-reroute,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-reroute.html cluster-state,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-state.html @@ -126,15 +131,25 @@ dangling-index-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{b dangling-index-import,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-import.html dangling-indices-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-indices-list.html data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html +data-stream-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-data-stream.html +data-stream-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-delete-lifecycle.html +data-stream-explain-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-explain-lifecycle.html +data-stream-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-data-stream.html +data-stream-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html data-stream-lifecycle-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params +data-stream-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-stats-api.html data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg defining-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html +delete-analytics-collection,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-analytics-collection.html +delete-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html delete-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html delete-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html +delete-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-synonym-rule.html +delete-synonyms-set,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-synonyms-set.html delete-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html delete-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html delete-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html @@ -159,6 +174,7 @@ drop-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ enrich-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-processor.html enrich-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html eql-async-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html +eql-async-search-delete,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-eql-delete eql-async-search-status-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html eql-basic-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-basic-syntax eql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html @@ -178,17 +194,23 @@ execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/referenc expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err explain-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/explain-dfanalytics.html fail-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fail-processor.html +features-reset,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-features-api.html field-and-document-access-control,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html field-usage-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-usage-stats.html find-field-structure,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-field-structure.html find-message-structure,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-message-structure.html find-structure,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-structure.html fingerprint-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fingerprint-processor.html +fleet-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-multi-search.html +fleet-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-search.html foreach-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/foreach-processor.html fuzziness,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy geo-shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geo-shape.html geo-grid-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-geo-grid-processor.html +geoip-delete-database,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database +geoip-get-database,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database +geoip-put-database,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database geoip-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html geoip-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-stats-api.html get-basic-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-basic-status.html @@ -201,6 +223,8 @@ get-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get get-ml-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-info.html get-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html get-repositories-metering-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-repositories-metering-api.html +get-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonym-rule.html +get-synonyms-set,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonyms-set.html get-trained-models-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html get-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html get-transform-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html @@ -211,6 +235,7 @@ graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branc grok,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok.html grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html +health-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/health-api.html ilm-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html ilm-explain-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-explain-lifecycle.html ilm-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-lifecycle.html @@ -224,6 +249,7 @@ ilm-retry-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch ilm-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-start.html ilm-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-stop.html important-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html +index-block-add,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-blocks.html#add-index-block index-modules-blocks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-blocks.html index-modules-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings index-modules-slowlog-slowlog,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log @@ -232,8 +258,10 @@ index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index.htm indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html index-modules-merge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html index-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html +index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-index-template index-templates-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates-v1.html indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html +indices-aliases-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html indices-clone-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html @@ -275,7 +303,12 @@ indices-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/i indices-template-exists-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-template-exists-v1.html indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates.html indices-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-update-settings.html +infer-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model.html infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model-deployment.html +inference-api-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-inference-api.html +inference-api-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-inference-api.html +inference-api-post,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/post-inference-api.html +inference-api-put,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-inference-api.html inference-api-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stream-inference-api.html inference-api-update,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-inference-api.html inference-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inference-processor.html @@ -284,6 +317,9 @@ ingest,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.h ingest-circle-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-circle-processor.html ingest-node-set-security-user-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{banch}/ingest-node-set-security-user-processor.html inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html +ip-location-delete-database,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-ip-location-database-api.html +ip-location-get-database,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ip-location-database-api.html +ip-location-put-database,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-ip-location-database-api.html join-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/join-processor.html json-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/json-processor.html k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-precision @@ -292,6 +328,8 @@ kv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv knn-approximate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn-search.html#approximate-knn knn-inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn-search.html#nested-knn-search-inner-hits license-management,https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html +list-analytics-collection,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html +list-synonyms-sets,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-synonyms-sets.html 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 @@ -327,6 +365,7 @@ ml-delete-filter,https://www.elastic.co/guide/en/elasticsearch/reference/{branch ml-delete-forecast,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-forecast.html ml-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-job.html ml-delete-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-snapshot.html +ml-estimate-memory,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-estimate-model-memory.html ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html ml-flush-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-flush-job.html ml-forecast,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-forecast.html @@ -342,6 +381,7 @@ ml-get-influencer,https://www.elastic.co/guide/en/elasticsearch/reference/{branc ml-get-job-model-snapshot-upgrade-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-model-snapshot-upgrade-stats.html ml-get-job-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-stats.html ml-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job.html +ml-get-memory,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-memory.html ml-get-overall-buckets,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-overall-buckets.html ml-get-record,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-record.html ml-get-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-snapshot.html @@ -392,11 +432,15 @@ painless-execute-api,https://www.elastic.co/guide/en/elasticsearch/painless/{bra pipeline-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html pki-realm,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pki-realm.html point-in-time-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html +prevalidate-node-removal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/prevalidate-node-removal-api.html preview-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html preview-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html +put-analytics-collection,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-analytics-collection.html put-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html put-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html put-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-pipeline-api.html +put-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-synonym-rule.html +put-synonyms-set,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-synonyms-set.html put-trained-model-definition-part,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html put-trained-model-vocabulary,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html put-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html @@ -500,8 +544,10 @@ rollup-stop-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} routing,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html +schedule-now-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/schedule-now-transform.html script-contexts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-script-contexts-api.html script-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-stored-script-api.html +script-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-stored-script-api.html script-languages,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-script-languages-api.html script-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/script-processor.html script-put,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-stored-script-api.html @@ -590,6 +636,10 @@ search-aggregations-metrics-valuecount-aggregation,https://www.elastic.co/guide/ search-aggregations-metrics-weight-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-weight-avg-aggregation.html search-aggregations-bucket-variablewidthhistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html search-analyzer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-analyzer.html +search-application-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-search-application.html +search-application-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-search-application.html +search-application-put,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-search-application.html +search-application-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-search.html search-render-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-render-query.html search-count,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-count.html search-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html @@ -598,7 +648,6 @@ search-knn,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn- search-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html search-multi-search-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-search-template.html search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html -search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html search-request-body,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-request-body.html search-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html search-shards,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-shards.html @@ -617,6 +666,8 @@ search-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html security-api-activate-user-profile,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-activate-user-profile.html security-api-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-authenticate.html +security-api-bulk-delete-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-delete-role.html +security-api-bulk-put-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-put-role.html security-api-bulk-update-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-update-api-keys.html security-api-change-password,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-change-password.html security-api-clear-api-key-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-api-key-cache.html @@ -750,12 +801,15 @@ supported-flags,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query terminate-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/terminate-processor.html +test-grok-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/test-grok-pattern.html time-value,https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java time-zone-id,https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html trim-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html unfreeze-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/unfreeze-index-api.html update-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html +update-desired-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-desired-nodes.html update-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-license.html +update-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-trained-model-deployment.html update-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html upgrade-transforms,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html uppercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/uppercase-processor.html diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index ee1b49fd01..422e1fbf24 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage * @doc_tag script + * @doc_id script-get */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/health_report/Request.ts b/specification/_global/health_report/Request.ts index ffeb4423f9..50ba8b6816 100644 --- a/specification/_global/health_report/Request.ts +++ b/specification/_global/health_report/Request.ts @@ -43,6 +43,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name health_report * @availability stack since=8.7.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_id health-api */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/msearch/MultiSearchRequest.ts b/specification/_global/msearch/MultiSearchRequest.ts index 58362b47a1..96081977dd 100644 --- a/specification/_global/msearch/MultiSearchRequest.ts +++ b/specification/_global/msearch/MultiSearchRequest.ts @@ -45,6 +45,7 @@ import { RequestItem } from './types' * @availability serverless stability=stable visibility=public * @index_privileges read * @doc_tag search + * @doc_id search-multi-search */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts index 0bc43e8de5..5d6e45ac2f 100644 --- a/specification/_global/ping/PingRequest.ts +++ b/specification/_global/ping/PingRequest.ts @@ -26,6 +26,7 @@ import { RequestBase } from '@_types/Base' * @availability stack stability=stable * @availability serverless stability=stable visibility=public * @doc_tag cluster + * @doc_id cluster-ping */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index ee4e2749fb..4e63e4ea0c 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -30,6 +30,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types' * @availability serverless stability=stable visibility=public * @index_privileges read * @doc_tag search + * @doc_id search-rank-eval */ export interface Request extends RequestBase { urls: [ diff --git a/specification/cat/tasks/CatTasksRequest.ts b/specification/cat/tasks/CatTasksRequest.ts index 8578379e41..dace6a6951 100644 --- a/specification/cat/tasks/CatTasksRequest.ts +++ b/specification/cat/tasks/CatTasksRequest.ts @@ -28,7 +28,7 @@ import { Duration, TimeUnit } from '@_types/Time' * @rest_spec_name cat.tasks * @availability stack since=5.0.0 stability=experimental * @availability serverless stability=experimental visibility=private - * @doc_id tasks + * @doc_id cat-tasks * @cluster_privileges monitor */ export interface Request extends CatRequestBase { diff --git a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts index 0a3a0d2d0d..9f2ef71295 100644 --- a/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts +++ b/specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name enrich.delete_policy * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id delete-enrich-policy-api */ export interface Request extends RequestBase { urls: [ diff --git a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts index a2283f32da..361c662662 100644 --- a/specification/enrich/get_policy/GetEnrichPolicyRequest.ts +++ b/specification/enrich/get_policy/GetEnrichPolicyRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name enrich.get_policy * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id get-enrich-policy-api */ export interface Request extends RequestBase { urls: [ diff --git a/specification/enrich/stats/EnrichStatsRequest.ts b/specification/enrich/stats/EnrichStatsRequest.ts index af9ed6e891..0f43ce5c8b 100644 --- a/specification/enrich/stats/EnrichStatsRequest.ts +++ b/specification/enrich/stats/EnrichStatsRequest.ts @@ -26,6 +26,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name enrich.stats * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id enrich-stats-api */ export interface Request extends RequestBase { urls: [ diff --git a/specification/eql/delete/EqlDeleteRequest.ts b/specification/eql/delete/EqlDeleteRequest.ts index 34daebaceb..aeb140631c 100644 --- a/specification/eql/delete/EqlDeleteRequest.ts +++ b/specification/eql/delete/EqlDeleteRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @rest_spec_name eql.delete * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id eql-async-search-delete */ export interface Request extends RequestBase { urls: [ diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 4d878597ec..e35f51418b 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -32,6 +32,7 @@ import { ResultPosition } from './types' * @rest_spec_name eql.search * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id eql-search-api * @ext_doc_id eql */ export interface Request extends RequestBase { diff --git a/specification/features/get_features/GetFeaturesRequest.ts b/specification/features/get_features/GetFeaturesRequest.ts index 076798353b..3e85c362b3 100644 --- a/specification/features/get_features/GetFeaturesRequest.ts +++ b/specification/features/get_features/GetFeaturesRequest.ts @@ -33,6 +33,7 @@ import { Duration } from '@_types/Time' * In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. * @rest_spec_name features.get_features * @availability stack since=7.12.0 stability=stable + * @doc_id get-features-api * @ext_doc_id snapshot-create */ export interface Request extends RequestBase { diff --git a/specification/features/reset_features/ResetFeaturesRequest.ts b/specification/features/reset_features/ResetFeaturesRequest.ts index 7b017ceb65..41d2414330 100644 --- a/specification/features/reset_features/ResetFeaturesRequest.ts +++ b/specification/features/reset_features/ResetFeaturesRequest.ts @@ -41,6 +41,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name features.reset_features * @availability stack since=7.12.0 stability=experimental * @availability serverless stability=experimental visibility=private + * @doc_id features-reset */ export interface Request extends RequestBase { urls: [ diff --git a/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts index 72acb752db..7919b91026 100644 --- a/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts +++ b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts @@ -23,9 +23,14 @@ import { Duration } from '@_types/Time' import { Checkpoint } from '../_types/Checkpoints' /** + * Get global checkpoints. + * + * Get the current global checkpoints for an index. + * This API is designed for internal use by the Fleet server project. * @rest_spec_name fleet.global_checkpoints * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_id get-global-checkpoints */ export interface Request extends RequestBase { urls: [ diff --git a/specification/fleet/msearch/MultiSearchRequest.ts b/specification/fleet/msearch/MultiSearchRequest.ts index 70c5e614eb..a62ec67394 100644 --- a/specification/fleet/msearch/MultiSearchRequest.ts +++ b/specification/fleet/msearch/MultiSearchRequest.ts @@ -36,6 +36,7 @@ import { Checkpoint } from '../_types/Checkpoints' * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private * @index_privileges read + * @doc_id fleet-multi-search */ export interface Request extends RequestBase { urls: [ diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts index 04745504dd..ae28deb0b4 100644 --- a/specification/fleet/search/SearchRequest.ts +++ b/specification/fleet/search/SearchRequest.ts @@ -59,6 +59,7 @@ import { Checkpoint } from '../_types/Checkpoints' * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private * @index_privileges read + * @doc_id fleet-search */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts index a5fd26e598..17e2be2796 100644 --- a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts +++ b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ilm.delete_lifecycle * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm + * @doc_id ilm-delete-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts index 3ede890443..e38ef3aaf8 100644 --- a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ilm.explain_lifecycle * @availability stack since=6.6.0 stability=stable * @index_privileges view_index_metadata,manage_ilm + * @doc_id ilm-explain-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts index 3d7aa0d1a6..a374e348ea 100644 --- a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts +++ b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts @@ -26,6 +26,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ilm.get_lifecycle * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm, read_ilm + * @doc_id ilm-get-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/get_status/GetIlmStatusRequest.ts b/specification/ilm/get_status/GetIlmStatusRequest.ts index ed54381d7e..5ca238aca2 100644 --- a/specification/ilm/get_status/GetIlmStatusRequest.ts +++ b/specification/ilm/get_status/GetIlmStatusRequest.ts @@ -21,10 +21,12 @@ import { RequestBase } from '@_types/Base' /** * Get the ILM status. + * * Get the current index lifecycle management status. * @rest_spec_name ilm.get_status * @availability stack since=6.6.0 stability=stable * @cluster_privileges read_ilm + * @doc_id ilm-get-status */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/migrate_to_data_tiers/Request.ts b/specification/ilm/migrate_to_data_tiers/Request.ts index 986ae809ee..1213488c69 100644 --- a/specification/ilm/migrate_to_data_tiers/Request.ts +++ b/specification/ilm/migrate_to_data_tiers/Request.ts @@ -36,6 +36,7 @@ import { RequestBase } from '@_types/Base' * Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. * @rest_spec_name ilm.migrate_to_data_tiers * @availability stack since=7.14.0 stability=stable + * @doc_id ilm-migrate-to-data-tiers * @ext_doc_id migrate-index-allocation-filters */ export interface Request extends RequestBase { diff --git a/specification/ilm/move_to_step/MoveToStepRequest.ts b/specification/ilm/move_to_step/MoveToStepRequest.ts index c7c8db6f42..387d769b0e 100644 --- a/specification/ilm/move_to_step/MoveToStepRequest.ts +++ b/specification/ilm/move_to_step/MoveToStepRequest.ts @@ -39,6 +39,7 @@ import { StepKey } from './types' * @rest_spec_name ilm.move_to_step * @availability stack since=6.6.0 stability=stable * @index_privileges manage_ilm + * @doc_id ilm-move-to-step */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts index b67fa9edf2..9471e6079e 100644 --- a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts +++ b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts @@ -31,6 +31,7 @@ import { Duration } from '@_types/Time' * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm * @index_privileges manage + * @doc_id ilm-put-lifecycle * @ext_doc_id ilm-index-lifecycle */ export interface Request extends RequestBase { diff --git a/specification/ilm/remove_policy/RemovePolicyRequest.ts b/specification/ilm/remove_policy/RemovePolicyRequest.ts index 9a0573b096..9e2181480a 100644 --- a/specification/ilm/remove_policy/RemovePolicyRequest.ts +++ b/specification/ilm/remove_policy/RemovePolicyRequest.ts @@ -27,6 +27,7 @@ import { IndexName } from '@_types/common' * @rest_spec_name ilm.remove_policy * @availability stack since=6.6.0 stability=stable * @index_privileges manage_ilm + * @doc_id ilm-remove-policy */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/retry/RetryIlmRequest.ts b/specification/ilm/retry/RetryIlmRequest.ts index ccbb342b58..c08af01285 100644 --- a/specification/ilm/retry/RetryIlmRequest.ts +++ b/specification/ilm/retry/RetryIlmRequest.ts @@ -28,6 +28,7 @@ import { IndexName } from '@_types/common' * @rest_spec_name ilm.retry * @availability stack since=6.6.0 stability=stable * @index_privileges manage_ilm + * @doc_id ilm-retry-policy */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/start/StartIlmRequest.ts b/specification/ilm/start/StartIlmRequest.ts index a12cf7a42b..0f57107f14 100644 --- a/specification/ilm/start/StartIlmRequest.ts +++ b/specification/ilm/start/StartIlmRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ilm.start * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm + * @doc_id ilm-start */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ilm/stop/StopIlmRequest.ts b/specification/ilm/stop/StopIlmRequest.ts index 769bc24312..6aa89ec787 100644 --- a/specification/ilm/stop/StopIlmRequest.ts +++ b/specification/ilm/stop/StopIlmRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ilm.stop * @availability stack since=6.6.0 stability=stable * @cluster_privileges manage_ilm + * @doc_id ilm-stop */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/add_block/IndicesAddBlockRequest.ts b/specification/indices/add_block/IndicesAddBlockRequest.ts index e34ab5c5bd..4e553ccb3e 100644 --- a/specification/indices/add_block/IndicesAddBlockRequest.ts +++ b/specification/indices/add_block/IndicesAddBlockRequest.ts @@ -23,10 +23,13 @@ import { Duration } from '@_types/Time' /** * Add an index block. - * Limits the operations allowed on an index by blocking specific operation types. + * + * Add an index block to an index. + * Index blocks limit the operations allowed on an index by blocking specific operation types. * @rest_spec_name indices.add_block * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id index-block-add */ export interface Request extends RequestBase { urls: [ @@ -36,21 +39,62 @@ export interface Request extends RequestBase { } ] path_parts: { + /** + * A comma-separated list or wildcard expression of index names used to limit the request. + * By default, you must explicitly name the indices you are adding blocks to. + * To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. + * You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. + */ index: IndexName + /** + * The block type to add to the index. + */ block: IndicesBlockOptions } query_parameters: { + /** + * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. + * This behavior applies even if the request targets other open indices. + * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @server_default true + */ allow_no_indices?: boolean // default: true + /** + * The type of index that wildcard patterns can match. + * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + * It supports comma-separated values, such as `open,hidden`. + * @server_default open + */ expand_wildcards?: ExpandWildcards // default: open + /** + * If `false`, the request returns an error if it targets a missing or closed index. + * @server_default false + */ ignore_unavailable?: boolean // default: false + /** + * The period to wait for the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. + * @server_default 30s + */ master_timeout?: Duration // default: 30s + /** + * The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + * If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + * It can also be set to `-1` to indicate that the request should never timeout. + * @server_default 30s + */ timeout?: Duration // default: 30s } } export enum IndicesBlockOptions { + /** Disable metadata changes, such as closing the index. */ metadata, + /** Disable read operations. */ read, + /** Disable write operations and metadata changes. */ read_only, + /** Disable write operations. However, metadata changes are still allowed. */ write } diff --git a/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml b/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml index fec4fafd17..8480375421 100644 --- a/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml +++ b/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml @@ -1,7 +1,13 @@ # summary: '' -description: 'A successful response for adding an index block to an index.' +description: A successful response from `PUT /my-index-000001/_block/write`, which adds an index block to an index.' # type: response # response_code: 200 -value: - "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true,\n \"indices\"\ - \ : [ {\n \"name\" : \"my-index-000001\",\n \"blocked\" : true\n } ]\n}" +value: |- + { + "acknowledged" : true, + "shards_acknowledged" : true, + "indices" : [ { + "name" : "my-index-000001", + "blocked" : true + } ] + } diff --git a/specification/indices/clear_cache/IndicesClearCacheRequest.ts b/specification/indices/clear_cache/IndicesClearCacheRequest.ts index 6f8e61911c..1dae397d52 100644 --- a/specification/indices/clear_cache/IndicesClearCacheRequest.ts +++ b/specification/indices/clear_cache/IndicesClearCacheRequest.ts @@ -32,6 +32,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common' * @availability stack stability=stable * @availability serverless stability=stable visibility=private * @index_privileges manage + * @doc_id indices-clearcache */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/clone/IndicesCloneRequest.ts b/specification/indices/clone/IndicesCloneRequest.ts index 1f8e551158..97a7444b65 100644 --- a/specification/indices/clone/IndicesCloneRequest.ts +++ b/specification/indices/clone/IndicesCloneRequest.ts @@ -73,6 +73,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.clone * @availability stack since=7.4.0 stability=stable * @index_privileges manage + * @doc_id indices-clone-index */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts index 10b14c29fa..82c443fab1 100644 --- a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts +++ b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts @@ -23,13 +23,14 @@ import { Duration } from '@_types/Time' /** * Create a data stream. - * Creates a data stream. + * * You must have a matching index template with data stream enabled. * @rest_spec_name indices.create_data_stream * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges create_index * @doc_tag data stream + * @doc_id indices-create-data-stream */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts index b31d4c3003..b5c02c6099 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts @@ -22,12 +22,14 @@ import { ExpandWildcards, IndexName } from '@_types/common' /** * Get data stream stats. - * Retrieves statistics for one or more data streams. + * + * Get statistics for one or more data streams. * @rest_spec_name indices.data_streams_stats * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges monitor * @doc_tag data stream + * @doc_id data-stream-stats-api */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts index 4c8e8fcf57..c84fd33a42 100644 --- a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts +++ b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.delete_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id data-stream-delete-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index c5f1d92317..8ae3d9ac38 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @index_privileges delete_index * @doc_tag data stream + * @doc_id data-stream-delete */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts index 2d5a0dab5b..a438ff16fd 100644 --- a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts +++ b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts @@ -22,10 +22,12 @@ import { ExpandWildcards, Indices, Names } from '@_types/common' /** * Check aliases. - * Checks if one or more data stream or index aliases exist. + * + * Check if one or more data stream or index aliases exist. * @rest_spec_name indices.exists_alias * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_id indices-aliases-exist */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts index 9ef8c2d900..a2ce737588 100644 --- a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts +++ b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts @@ -23,10 +23,12 @@ import { Duration } from '@_types/Time' /** * Check index templates. + * * Check whether index templates exist. * @rest_spec_name indices.exists_index_template * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_id index-templates-exist */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index 965afe3d8e..8e4e38f9ed 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag data stream + * @doc_id data-stream-explain-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts index 7e14aa1999..8455af3ea1 100644 --- a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts +++ b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts @@ -23,11 +23,13 @@ import { Duration } from '@_types/Time' /** * Get data stream lifecycles. - * Retrieves the data stream lifecycle configuration of one or more data streams. + * + * Get the data stream lifecycle configuration of one or more data streams. * @rest_spec_name indices.get_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag data stream + * @doc_id data-stream-get-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts index 7ee3e715d1..7a46d919c5 100644 --- a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts +++ b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts @@ -23,12 +23,14 @@ import { Duration } from '@_types/Time' /** * Get data streams. - * Retrieves information about one or more data streams. + * + * Get information about one or more data streams. * @rest_spec_name indices.get_data_stream * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges view_index_metadata * @doc_tag data stream + * @doc_id data-stream-get */ export interface Request extends RequestBase { urls: [ diff --git a/specification/inference/delete/DeleteRequest.ts b/specification/inference/delete/DeleteRequest.ts index fc1f86a739..b51f460201 100644 --- a/specification/inference/delete/DeleteRequest.ts +++ b/specification/inference/delete/DeleteRequest.ts @@ -26,6 +26,7 @@ import { Id } from '@_types/common' * @rest_spec_name inference.delete * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public + * @doc_id inference-api-delete */ export interface Request extends RequestBase { urls: [ @@ -45,19 +46,19 @@ export interface Request extends RequestBase { task_type?: TaskType /** - * The inference Id + * The inference identifier. */ inference_id: Id } query_parameters: { /** - * When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + * When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned. * @server_default false */ dry_run?: boolean /** - * When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + * When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. * @server_default false */ force?: boolean diff --git a/specification/inference/get/GetRequest.ts b/specification/inference/get/GetRequest.ts index e78e319872..3f50d66130 100644 --- a/specification/inference/get/GetRequest.ts +++ b/specification/inference/get/GetRequest.ts @@ -26,6 +26,7 @@ import { Id } from '@_types/common' * @rest_spec_name inference.get * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public + * @doc_id inference-api-get */ export interface Request extends RequestBase { urls: [ diff --git a/specification/inference/inference/InferenceRequest.ts b/specification/inference/inference/InferenceRequest.ts index 6bf28e1de2..c646fd5356 100644 --- a/specification/inference/inference/InferenceRequest.ts +++ b/specification/inference/inference/InferenceRequest.ts @@ -24,10 +24,19 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Perform inference on the service + * Perform inference on the service. + * + * This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. + * It returns a response with the results of the tasks. + * The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. + * + * > info + * > The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, 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.inference * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public + * @cluster_privileges monitor_inference + * @doc_id inference-api-post */ export interface Request extends RequestBase { urls: [ @@ -42,34 +51,38 @@ export interface Request extends RequestBase { ] path_parts: { /** - * The task type + * The type of inference task that the model performs. */ task_type?: TaskType /** - * The inference Id + * The unique identifier for the inference endpoint. */ inference_id: Id } query_parameters: { /** - * Specifies the amount of time to wait for the inference request to complete. + * The amount of time to wait for the inference request to complete. * @server_default 30s */ timeout?: Duration } body: { /** - * Query input, required for rerank task. - * Not required for other tasks. + * The query input, which is required only for the `rerank` task. + * It is not required for other tasks. */ query?: string /** - * Inference input. - * Either a string or an array of strings. + * The text on which you want to perform the inference task. + * It can be a single string or an array. + * + * > info + * > Inference endpoints for the `completion` task type currently only support a single string as input. */ input: string | Array /** - * Optional task settings + * Task settings for the individual inference request. + * These settings are specific to the task type you specified and override the task settings specified when initializing the service. */ task_settings?: TaskSettings } diff --git a/specification/inference/inference/examples/request/InferenceRequestExample1.yaml b/specification/inference/inference/examples/request/InferenceRequestExample1.yaml new file mode 100644 index 0000000000..3abff22bf6 --- /dev/null +++ b/specification/inference/inference/examples/request/InferenceRequestExample1.yaml @@ -0,0 +1,8 @@ +summary: Completion task +description: Run `POST _inference/completion/openai_chat_completions` to perform a completion on the example question. +# method_request: "POST _inference/completion/openai_chat_completions" +# type: "request" +value: |- + { + "input": "What is Elastic?" + } diff --git a/specification/inference/inference/examples/request/InferenceRequestExample2.yaml b/specification/inference/inference/examples/request/InferenceRequestExample2.yaml new file mode 100644 index 0000000000..53194bd50e --- /dev/null +++ b/specification/inference/inference/examples/request/InferenceRequestExample2.yaml @@ -0,0 +1,9 @@ +summary: Rerank task +description: Run `POST _inference/rerank/cohere_rerank` to perform reranking on the example input. +# method_request: "POST _inference/rerank/cohere_rerank" +# type: "request" +value: |- + { + "input": ["luke", "like", "leia", "chewy","r2d2", "star", "wars"], + "query": "star wars main character" + } diff --git a/specification/inference/inference/examples/request/InferenceRequestExample3.yaml b/specification/inference/inference/examples/request/InferenceRequestExample3.yaml new file mode 100644 index 0000000000..0f9f9b0294 --- /dev/null +++ b/specification/inference/inference/examples/request/InferenceRequestExample3.yaml @@ -0,0 +1,8 @@ +summary: Sparse embedding task +description: Run `POST _inference/sparse_embedding/my-elser-model` to perform sparse embedding on the example sentence. +# method_request: "POST _inference/sparse_embedding/my-elser-model" +# type: "request" +value: |- + { + "input": "The sky above the port was the color of television tuned to a dead channel." + } diff --git a/specification/inference/inference/examples/request/InferenceRequestExample4.yaml b/specification/inference/inference/examples/request/InferenceRequestExample4.yaml new file mode 100644 index 0000000000..e1de0d6b18 --- /dev/null +++ b/specification/inference/inference/examples/request/InferenceRequestExample4.yaml @@ -0,0 +1,11 @@ +summary: Text embedding task +description: Run `POST _inference/text_embedding/my-cohere-endpoint` to perform text embedding on the example sentence using the Cohere integration, +# method_request: "POST _inference/text_embedding/my-cohere-endpoint" +# type: "request" +value: |- + { + "input": "The sky above the port was the color of television tuned to a dead channel.", + "task_settings": { + "input_type": "ingest" + } + } diff --git a/specification/inference/inference/examples/response/InferenceResponseExample1.yaml b/specification/inference/inference/examples/response/InferenceResponseExample1.yaml new file mode 100644 index 0000000000..0f2b454856 --- /dev/null +++ b/specification/inference/inference/examples/response/InferenceResponseExample1.yaml @@ -0,0 +1,13 @@ +summary: Completion task +description: > + A successful response from `POST _inference/completion/openai_chat_completions`. +# type: "response" +# response_code: +value: |- + { + "completion": [ + { + "result": "Elastic is a company that provides a range of software solutions for search, logging, security, and analytics. Their flagship product is Elasticsearch, an open-source, distributed search engine that allows users to search, analyze, and visualize large volumes of data in real-time. Elastic also offers products such as Kibana, a data visualization tool, and Logstash, a log management and pipeline tool, as well as various other tools and solutions for data analysis and management." + } + ] + } diff --git a/specification/inference/inference/examples/response/InferenceResponseExample2.yaml b/specification/inference/inference/examples/response/InferenceResponseExample2.yaml new file mode 100644 index 0000000000..db18547f6d --- /dev/null +++ b/specification/inference/inference/examples/response/InferenceResponseExample2.yaml @@ -0,0 +1,45 @@ +summary: Rerank task +description: > + A successful response from `POST _inference/rerank/cohere_rerank`. +# type: "response" +# response_code: +value: |- + { + "rerank": [ + { + "index": "2", + "relevance_score": "0.011597361", + "text": "leia" + }, + { + "index": "0", + "relevance_score": "0.006338922", + "text": "luke" + }, + { + "index": "5", + "relevance_score": "0.0016166499", + "text": "star" + }, + { + "index": "4", + "relevance_score": "0.0011695103", + "text": "r2d2" + }, + { + "index": "1", + "relevance_score": "5.614787E-4", + "text": "like" + }, + { + "index": "6", + "relevance_score": "3.7850367E-4", + "text": "wars" + }, + { + "index": "3", + "relevance_score": "1.2508839E-5", + "text": "chewy" + } + ] + } diff --git a/specification/inference/inference/examples/response/InferenceResponseExample3.yaml b/specification/inference/inference/examples/response/InferenceResponseExample3.yaml new file mode 100644 index 0000000000..f3ec16545a --- /dev/null +++ b/specification/inference/inference/examples/response/InferenceResponseExample3.yaml @@ -0,0 +1,26 @@ +summary: Sparse embedding task +description: > + An abbreviated response from `POST _inference/sparse_embedding/my-elser-model`. +# type: "response" +# response_code: +value: |- + { + "sparse_embedding": [ + { + "port": 2.1259406, + "sky": 1.7073475, + "color": 1.6922266, + "dead": 1.6247464, + "television": 1.3525393, + "above": 1.2425821, + "tuned": 1.1440028, + "colors": 1.1218185, + "tv": 1.0111054, + "ports": 1.0067928, + "poem": 1.0042328, + "channel": 0.99471164, + "tune": 0.96235967, + "scene": 0.9020516 + } + ] + } diff --git a/specification/inference/inference/examples/response/InferenceResponseExample4.yaml b/specification/inference/inference/examples/response/InferenceResponseExample4.yaml new file mode 100644 index 0000000000..45c449746f --- /dev/null +++ b/specification/inference/inference/examples/response/InferenceResponseExample4.yaml @@ -0,0 +1,30 @@ +summary: Text embedding task +description: > + An abbreviated response from `POST _inference/text_embedding/my-cohere-endpoint`. +# type: "response" +# response_code: +value: |- + { + "text_embedding": [ + { + "embedding": [ + { + 0.018569946, + -0.036895752, + 0.01486969, + -0.0045204163, + -0.04385376, + 0.0075950623, + 0.04260254, + -0.004005432, + 0.007865906, + 0.030792236, + -0.050476074, + 0.011795044, + -0.011642456, + -0.010070801 + } + ] + } + ] + } diff --git a/specification/inference/put/PutRequest.ts b/specification/inference/put/PutRequest.ts index 7051b43b9f..0706189d1b 100644 --- a/specification/inference/put/PutRequest.ts +++ b/specification/inference/put/PutRequest.ts @@ -37,6 +37,7 @@ import { Id } from '@_types/common' * @availability stack since=8.11.0 stability=stable visibility=public * @availability serverless stability=stable visibility=public * @cluster_privileges manage_inference + * @doc_id inference-api-put */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts index 659d21598f..7e50d68e88 100644 --- a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts +++ b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts @@ -23,10 +23,12 @@ import { Duration } from '@_types/Time' /** * Delete GeoIP database configurations. + * * Delete one or more IP geolocation database configurations. * @rest_spec_name ingest.delete_geoip_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @doc_id geoip-delete-database */ export interface Request extends RequestBase { urls: [ @@ -43,12 +45,12 @@ export interface Request extends RequestBase { } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ timeout?: Duration } diff --git a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts index 68ab053536..83381e0163 100644 --- a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts +++ b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private * @cluster_privileges manage + * @doc_id ip-location-delete-database */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts index a38e30a70e..d6e7478218 100644 --- a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts +++ b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name ingest.delete_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id delete-pipeline-api * @ext_doc_id ingest */ export interface Request extends RequestBase { diff --git a/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts index 1982cda979..f094254512 100644 --- a/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts +++ b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts @@ -22,10 +22,12 @@ import { Ids } from '@_types/common' /** * Get GeoIP database configurations. + * * Get information about one or more IP geolocation database configurations. * @rest_spec_name ingest.get_geoip_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @doc_id geoip-get-database */ export interface Request extends RequestBase { urls: [ @@ -40,7 +42,7 @@ export interface Request extends RequestBase { ] path_parts: { /** - * Comma-separated list of database configuration IDs to retrieve. + * A comma-separated list of database configuration IDs to retrieve. * Wildcard (`*`) expressions are supported. * To get all database configurations, omit this parameter or use `*`. */ diff --git a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts index e5d6662811..e3e8e4b28e 100644 --- a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts +++ b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private * @cluster_privileges manage + * @doc_id ip-location-get-database */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ingest/get_pipeline/GetPipelineRequest.ts b/specification/ingest/get_pipeline/GetPipelineRequest.ts index f5805300d0..9b4a680784 100644 --- a/specification/ingest/get_pipeline/GetPipelineRequest.ts +++ b/specification/ingest/get_pipeline/GetPipelineRequest.ts @@ -23,11 +23,13 @@ import { Duration } from '@_types/Time' /** * Get pipelines. + * * Get information about one or more ingest pipelines. * This API returns a local reference of the pipeline. * @rest_spec_name ingest.get_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id get-pipeline-api * @ext_doc_id ingest */ export interface Request extends RequestBase { diff --git a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts index de145d0b11..bd5e3d6398 100644 --- a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts +++ b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts @@ -24,10 +24,12 @@ import { Duration } from '@_types/Time' /** * Create or update a GeoIP database configuration. + * * Refer to the create or update IP geolocation database configuration API. * @rest_spec_name ingest.put_geoip_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @doc_id geoip-put-database */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts index b86a8b2372..6b335dcacb 100644 --- a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts +++ b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private * @cluster_privileges manage + * @doc_id ip-location-put-database */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ingest/simulate/SimulatePipelineRequest.ts b/specification/ingest/simulate/SimulatePipelineRequest.ts index fa2c1ca44a..ee176094d8 100644 --- a/specification/ingest/simulate/SimulatePipelineRequest.ts +++ b/specification/ingest/simulate/SimulatePipelineRequest.ts @@ -24,11 +24,14 @@ import { Document } from '../_types/Simulation' /** * Simulate a pipeline. + * * Run an ingest pipeline against a set of provided documents. * You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. * @rest_spec_name ingest.simulate * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @cluster_privileges read_pipeline + * @doc_id simulate-pipeline-api */ export interface Request extends RequestBase { urls: [ @@ -43,8 +46,8 @@ export interface Request extends RequestBase { ] path_parts: { /** - * Pipeline to test. - * If you don’t specify a `pipeline` in the request body, this parameter is required. + * The pipeline to test. + * If you don't specify a `pipeline` in the request body, this parameter is required. */ id?: Id } @@ -60,8 +63,8 @@ export interface Request extends RequestBase { */ docs: Document[] /** - * Pipeline to test. - * If you don’t specify the `pipeline` request path parameter, this parameter is required. + * The pipeline to test. + * If you don't specify the `pipeline` request path parameter, this parameter is required. * If you specify both this and the request path parameter, the API only uses the request path parameter. */ pipeline?: Pipeline diff --git a/specification/license/delete/DeleteLicenseRequest.ts b/specification/license/delete/DeleteLicenseRequest.ts index 63aa82aae9..d9397061bc 100644 --- a/specification/license/delete/DeleteLicenseRequest.ts +++ b/specification/license/delete/DeleteLicenseRequest.ts @@ -22,12 +22,14 @@ import { Duration } from '@_types/Time' /** * Delete the license. + * * When the license expires, your subscription level reverts to Basic. * * If the operator privileges feature is enabled, only operator users can use this API. * @rest_spec_name license.delete * @availability stack stability=stable * @cluster_privileges manage + * @doc_id delete-license * @ext_doc_id license-management */ export interface Request extends RequestBase { @@ -39,12 +41,12 @@ export interface Request extends RequestBase { ] query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ timeout?: Duration diff --git a/specification/license/get/GetLicenseRequest.ts b/specification/license/get/GetLicenseRequest.ts index ae1ab580b6..f332aa685b 100644 --- a/specification/license/get/GetLicenseRequest.ts +++ b/specification/license/get/GetLicenseRequest.ts @@ -21,13 +21,16 @@ import { RequestBase } from '@_types/Base' /** * Get license information. + * * Get information about your Elastic license including its type, its status, when it was issued, and when it expires. * - * NOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. - * If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. + * >info + * > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. + * > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. * @rest_spec_name license.get * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_id get-license */ export interface Request extends RequestBase { urls: [ diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts index 99026f8cfb..7287abce0c 100644 --- a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts +++ b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts @@ -24,6 +24,7 @@ import { RequestBase } from '@_types/Base' * @rest_spec_name license.get_basic_status * @availability stack since=6.3.0 stability=stable * @cluster_privileges monitor + * @doc_id get-basic-status */ export interface Request extends RequestBase { urls: [ diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts index e4f45cdb90..a9f0d6b8d9 100644 --- a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts +++ b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts @@ -24,6 +24,7 @@ import { RequestBase } from '@_types/Base' * @rest_spec_name license.get_trial_status * @availability stack since=6.1.0 stability=stable * @cluster_privileges monitor + * @doc_id get-trial-status */ export interface Request extends RequestBase { urls: [ diff --git a/specification/license/post/PostLicenseRequest.ts b/specification/license/post/PostLicenseRequest.ts index d4723a372c..8a57ebebd6 100644 --- a/specification/license/post/PostLicenseRequest.ts +++ b/specification/license/post/PostLicenseRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Update the license. + * * You can update your license at runtime without shutting down your nodes. * License updates take effect immediately. * If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. @@ -33,6 +34,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name license.post * @availability stack stability=stable * @cluster_privileges manage + * @doc_id update-license */ export interface Request extends RequestBase { urls: [ @@ -48,12 +50,12 @@ export interface Request extends RequestBase { */ acknowledge?: boolean /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * @server_default 30s */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ timeout?: Duration diff --git a/specification/license/post_start_basic/StartBasicLicenseRequest.ts b/specification/license/post_start_basic/StartBasicLicenseRequest.ts index e618083d8f..b9bfadd74d 100644 --- a/specification/license/post_start_basic/StartBasicLicenseRequest.ts +++ b/specification/license/post_start_basic/StartBasicLicenseRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Start a basic license. + * * Start an indefinite basic license, which gives access to all the basic features. * * NOTE: In order to start a basic license, you must not currently have a basic license. @@ -33,6 +34,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name license.post_start_basic * @availability stack since=6.3.0 stability=stable * @cluster_privileges manage + * @doc_id start-basic */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts index 5b002d6617..778e584ee5 100644 --- a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts +++ b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts @@ -30,6 +30,7 @@ import { Id } from '@_types/common' * @availability stack since=8.5.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml + * @doc_id clear-trained-model * @doc_tag ml trained model */ export interface Request extends RequestBase { diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts index 7577c92a27..80b75fab0b 100644 --- a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts +++ b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-delete-expired-data */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_filter/MlDeleteFilterRequest.ts b/specification/ml/delete_filter/MlDeleteFilterRequest.ts index 8b21f84e2f..4487e5a696 100644 --- a/specification/ml/delete_filter/MlDeleteFilterRequest.ts +++ b/specification/ml/delete_filter/MlDeleteFilterRequest.ts @@ -29,6 +29,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-delete-filter */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts index dbcea4daa7..e21b400915 100644 --- a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts +++ b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts @@ -32,6 +32,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-delete-forecast */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts index 61eea9c6ef..5ebbae421f 100644 --- a/specification/ml/delete_job/MlDeleteJobRequest.ts +++ b/specification/ml/delete_job/MlDeleteJobRequest.ts @@ -33,6 +33,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-delete-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts index 19a3d5681d..b002bfc103 100644 --- a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts +++ b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts @@ -30,6 +30,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-delete-snapshot */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts index 9ff20e782e..04d182a816 100644 --- a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts +++ b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id delete-trained-models */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts index e8e404f6f3..7c26bbc86d 100644 --- a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts +++ b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts @@ -30,6 +30,7 @@ import { Id, Name } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id delete-trained-models-aliases */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts index 6253f514d7..7a371c4bcb 100644 --- a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts +++ b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts @@ -33,6 +33,7 @@ import { long } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-estimate-memory */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts index 867b0740ab..491e768f30 100644 --- a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts +++ b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts @@ -33,6 +33,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml data frame + * @doc_id evaluate-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts index 32076cfe58..22555b4dff 100644 --- a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts +++ b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts @@ -40,6 +40,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml data frame + * @doc_id explain-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/flush_job/MlFlushJobRequest.ts b/specification/ml/flush_job/MlFlushJobRequest.ts index b2a2103e0a..225b85321a 100644 --- a/specification/ml/flush_job/MlFlushJobRequest.ts +++ b/specification/ml/flush_job/MlFlushJobRequest.ts @@ -36,6 +36,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-flush-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/forecast/MlForecastJobRequest.ts b/specification/ml/forecast/MlForecastJobRequest.ts index 04c5215719..35a4e1464a 100644 --- a/specification/ml/forecast/MlForecastJobRequest.ts +++ b/specification/ml/forecast/MlForecastJobRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-forecast */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts index 7df841ec81..6347015c48 100644 --- a/specification/ml/get_buckets/MlGetBucketsRequest.ts +++ b/specification/ml/get_buckets/MlGetBucketsRequest.ts @@ -31,6 +31,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-bucket */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts index 1d54c98474..ec0071c32f 100644 --- a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts +++ b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts @@ -29,6 +29,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-calendar-event */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts index 513f95b50e..e19123b332 100644 --- a/specification/ml/get_calendars/MlGetCalendarsRequest.ts +++ b/specification/ml/get_calendars/MlGetCalendarsRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-calendar */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts index 4c2a54b9b5..b7d6c0f683 100644 --- a/specification/ml/get_categories/MlGetCategoriesRequest.ts +++ b/specification/ml/get_categories/MlGetCategoriesRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-category */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts index 7be2c57def..ad7abdc1c7 100644 --- a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts +++ b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts @@ -31,6 +31,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml data frame + * @doc_id get-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index 6595285830..5e64b439c9 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml data frame + * @doc_id get-dfanalytics-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index 0f05e3c480..546a08225c 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -33,6 +33,7 @@ import { Ids } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-datafeed-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts index 37107dbfb6..73fa0b7f3a 100644 --- a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts +++ b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts @@ -32,6 +32,7 @@ import { Ids } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_filters/MlGetFiltersRequest.ts b/specification/ml/get_filters/MlGetFiltersRequest.ts index b49b76e618..35f8fcdd41 100644 --- a/specification/ml/get_filters/MlGetFiltersRequest.ts +++ b/specification/ml/get_filters/MlGetFiltersRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-get-filter */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_influencers/MlGetInfluencersRequest.ts b/specification/ml/get_influencers/MlGetInfluencersRequest.ts index 719fa636bd..369856bc13 100644 --- a/specification/ml/get_influencers/MlGetInfluencersRequest.ts +++ b/specification/ml/get_influencers/MlGetInfluencersRequest.ts @@ -33,6 +33,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-influencer */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index 4038f15f62..572c5ff51f 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-job-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts index 790125c601..b9903ea9ab 100644 --- a/specification/ml/get_jobs/MlGetJobsRequest.ts +++ b/specification/ml/get_jobs/MlGetJobsRequest.ts @@ -31,6 +31,7 @@ import { Ids } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts index a4129fa05d..070b821be5 100644 --- a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts +++ b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml + * @doc_id ml-get-memory */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts index 87919a9e71..b77dfeb678 100644 --- a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-job-model-snapshot-upgrade-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts index 4a1bd8f6b6..6aceecd6ce 100644 --- a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts +++ b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts @@ -30,6 +30,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-snapshot */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts index 7a97cc6cee..5102e8c841 100644 --- a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts +++ b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts @@ -47,6 +47,7 @@ import { DateTime, Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-overall-buckets */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts index 0850e3b60f..e8ea455fcd 100644 --- a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts +++ b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts @@ -40,6 +40,7 @@ import { DateTime } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml * @doc_tag ml anomaly + * @doc_id ml-get-record */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts index e3ea88073a..0c4ec33b30 100644 --- a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts +++ b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml trained model + * @doc_id get-trained-models */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts index b6b92f3a78..cb69027d12 100644 --- a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts +++ b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts @@ -30,6 +30,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml trained model + * @doc_id get-trained-models-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts index cff6c15df0..78ec11b822 100644 --- a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts +++ b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.3.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag ml trained model + * @doc_id infer-trained-model */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/info/MlInfoRequest.ts b/specification/ml/info/MlInfoRequest.ts index 3498034940..4b50f9e469 100644 --- a/specification/ml/info/MlInfoRequest.ts +++ b/specification/ml/info/MlInfoRequest.ts @@ -32,6 +32,7 @@ import { RequestBase } from '@_types/Base' * @availability stack since=6.3.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges monitor_ml + * @doc_id get-ml-info */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/open_job/MlOpenJobRequest.ts b/specification/ml/open_job/MlOpenJobRequest.ts index bc0fdd62c5..46de12aba0 100644 --- a/specification/ml/open_job/MlOpenJobRequest.ts +++ b/specification/ml/open_job/MlOpenJobRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-open-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts index 339184545f..f8eea3311e 100644 --- a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts +++ b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts @@ -28,6 +28,7 @@ import { CalendarEvent } from '../_types/CalendarEvent' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-post-calendar-event */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/post_data/MlPostJobDataRequest.ts b/specification/ml/post_data/MlPostJobDataRequest.ts index 7a55c97031..28333faed3 100644 --- a/specification/ml/post_data/MlPostJobDataRequest.ts +++ b/specification/ml/post_data/MlPostJobDataRequest.ts @@ -31,6 +31,7 @@ import { DateTime } from '@_types/Time' * @deprecated 7.11.0 Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required. * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-post-data */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts index 97e6704f8f..9c39b1d06d 100644 --- a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts +++ b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts @@ -23,12 +23,13 @@ import { DataframePreviewConfig } from './types' /** * Preview features used by data frame analytics. - * Previews the extracted features used by a data frame analytics config. + * Preview the extracted features used by a data frame analytics config. * @rest_spec_name ml.preview_data_frame_analytics * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_ml * @doc_tag ml data frame + * @doc_id preview-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts index c69e06f327..4ebef6e357 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts @@ -39,6 +39,7 @@ import { DateTime } from '@_types/Time' * @index_privileges read * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-preview-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_calendar/MlPutCalendarRequest.ts b/specification/ml/put_calendar/MlPutCalendarRequest.ts index 4339da5fb7..961493f083 100644 --- a/specification/ml/put_calendar/MlPutCalendarRequest.ts +++ b/specification/ml/put_calendar/MlPutCalendarRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-put-calendar */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts index d8d34b47cd..ca9a1acc9b 100644 --- a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts +++ b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts @@ -27,6 +27,7 @@ import { Id, Ids } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-put-calendar-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts index e655ca645b..ec8eeec4a6 100644 --- a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts +++ b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts @@ -53,6 +53,7 @@ import { Duration } from '@_types/Time' * @index_privileges read * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-put-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_filter/MlPutFilterRequest.ts b/specification/ml/put_filter/MlPutFilterRequest.ts index 8c775693f8..eeb3ae8b30 100644 --- a/specification/ml/put_filter/MlPutFilterRequest.ts +++ b/specification/ml/put_filter/MlPutFilterRequest.ts @@ -29,6 +29,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-put-filter */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_job/MlPutJobRequest.ts b/specification/ml/put_job/MlPutJobRequest.ts index 5f0a3691ee..13f2cdf0ce 100644 --- a/specification/ml/put_job/MlPutJobRequest.ts +++ b/specification/ml/put_job/MlPutJobRequest.ts @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @index_privileges read * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-put-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 434e9246af..c4678841fb 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -36,6 +36,7 @@ import { Definition, Input } from './types' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id put-trained-models */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts index f62ebf061b..26529dcc44 100644 --- a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts +++ b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts @@ -43,6 +43,7 @@ import { Id, Name } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id put-trained-models-aliases */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts index 55aa5f9833..d3c3709912 100644 --- a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts +++ b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts @@ -28,6 +28,7 @@ import { integer, long } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id put-trained-model-definition-part */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts index 4fcddb77cf..82d0f705b2 100644 --- a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts +++ b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts @@ -30,6 +30,7 @@ import { double } from '@_types/Numeric' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id put-trained-model-vocabulary */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/reset_job/MlResetJobRequest.ts b/specification/ml/reset_job/MlResetJobRequest.ts index a7c240a1ab..8d557e57ae 100644 --- a/specification/ml/reset_job/MlResetJobRequest.ts +++ b/specification/ml/reset_job/MlResetJobRequest.ts @@ -31,6 +31,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-reset-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts index 309579650e..4456513949 100644 --- a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts +++ b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts @@ -34,6 +34,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-revert-snapshot */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts index e98240ccc0..3911d13932 100644 --- a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts +++ b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts @@ -38,6 +38,7 @@ import { Duration } from '@_types/Time' * @availability stack since=6.7.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml + * @doc_id ml-set-upgrade-mode */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts index 6e258f6a5c..3a6eade3cd 100644 --- a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts +++ b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts @@ -40,6 +40,7 @@ import { Duration } from '@_types/Time' * @cluster_privileges manage_ml * @index_privileges create_index, index, manage, read, view_index_metadata * @doc_tag ml data frame + * @doc_id start-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts index 9ff86eb28b..407431910c 100644 --- a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts +++ b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts @@ -40,6 +40,7 @@ import { DateTime, Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-start-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts index 041dcc2a24..73ee5a16de 100644 --- a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts +++ b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts @@ -34,6 +34,7 @@ import { * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id start-trained-model-deployment */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts index 033be31a1b..69da7b97d3 100644 --- a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts +++ b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml data frame + * @doc_id stop-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts index 9419d93256..078869144c 100644 --- a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts +++ b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-stop-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts index 6d75db1388..6cf4488e80 100644 --- a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts +++ b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id stop-trained-model-deployment */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts index d62ffbf253..e17e37c44b 100644 --- a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts +++ b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' * @cluster_privileges manage_ml * @index_privileges read, create_index, manage, index, view_index_metadata * @doc_tag ml data frame + * @doc_id update-dfanalytics */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts index 9bda2514bd..5060ad888e 100644 --- a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts +++ b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts @@ -39,6 +39,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-update-datafeed */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_filter/MlUpdateFilterRequest.ts b/specification/ml/update_filter/MlUpdateFilterRequest.ts index bb973d6551..3fdbece406 100644 --- a/specification/ml/update_filter/MlUpdateFilterRequest.ts +++ b/specification/ml/update_filter/MlUpdateFilterRequest.ts @@ -28,6 +28,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-update-filter */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index a5e0b09f8b..ed069f8351 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -38,6 +38,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-update-job */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts index c82f7df176..77cc691324 100644 --- a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts +++ b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts @@ -28,6 +28,7 @@ import { Id } from '@_types/common' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-update-snapshot */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts index 1005045a21..e80e4e60b7 100644 --- a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts +++ b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts @@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric' * @availability serverless stability=beta visibility=public * @cluster_privileges manage_ml * @doc_tag ml trained model + * @doc_id update-trained-model-deployment */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts index 00d54b4df0..2729224c8f 100644 --- a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts +++ b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts @@ -23,7 +23,7 @@ import { Duration } from '@_types/Time' /** * Upgrade a snapshot. - * Upgrades an anomaly detection model snapshot to the latest major version. + * Upgrade an anomaly detection model snapshot to the latest major version. * Over time, older snapshot formats are deprecated and removed. Anomaly * detection jobs support only snapshots that are from the current or previous * major version. @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges manage_ml * @doc_tag ml anomaly + * @doc_id ml-upgrade-job-model-snapshot */ export interface Request extends RequestBase { urls: [ diff --git a/specification/ml/validate_detector/MlValidateDetectorRequest.ts b/specification/ml/validate_detector/MlValidateDetectorRequest.ts index 4360a28e49..15866f6b49 100644 --- a/specification/ml/validate_detector/MlValidateDetectorRequest.ts +++ b/specification/ml/validate_detector/MlValidateDetectorRequest.ts @@ -26,6 +26,7 @@ import { RequestBase } from '@_types/Base' * @availability stack since=5.4.0 stability=stable visibility=private * @availability serverless stability=stable visibility=private * @doc_tag ml anomaly + * @doc_id apis */ export interface Request extends RequestBase { urls: [ diff --git a/specification/monitoring/bulk/BulkMonitoringRequest.ts b/specification/monitoring/bulk/BulkMonitoringRequest.ts index a664b24139..aac45b2205 100644 --- a/specification/monitoring/bulk/BulkMonitoringRequest.ts +++ b/specification/monitoring/bulk/BulkMonitoringRequest.ts @@ -26,6 +26,7 @@ import { Duration } from '@_types/Time' * 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 visibility=private + * @doc_id apis */ export interface Request extends RequestBase { urls: [ diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts index 34305b6550..72bc692cba 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name nodes.reload_secure_settings * @availability stack since=6.5.0 stability=stable * @doc_tag cluster + * @doc_id cluster-nodes-reload-secure-settings */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/delete/SearchApplicationsDeleteRequest.ts b/specification/search_application/delete/SearchApplicationsDeleteRequest.ts index ad6865d9cd..f9a73147a2 100644 --- a/specification/search_application/delete/SearchApplicationsDeleteRequest.ts +++ b/specification/search_application/delete/SearchApplicationsDeleteRequest.ts @@ -21,12 +21,14 @@ import { Name } from '@_types/common' /** * Delete a search application. + * * Remove a search application and its associated alias. Indices attached to the search application are not removed. * @rest_spec_name search_application.delete * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public * @cluster_privileges manage_search_application * @index_privileges manage + * @doc_id search-application-delete */ export interface Request extends RequestBase { urls: [ @@ -37,7 +39,7 @@ export interface Request extends RequestBase { ] path_parts: { /** - * The name of the search application to delete + * The name of the search application to delete. */ name: Name } diff --git a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts index fdf592bcff..87767386fb 100644 --- a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts +++ b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts @@ -26,6 +26,7 @@ import { Name } from '@_types/common' * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public * @doc_tag analytics + * @doc_id delete-analytics-collection */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/get/SearchApplicationsGetRequest.ts b/specification/search_application/get/SearchApplicationsGetRequest.ts index 6d7b9ce65c..d321d38675 100644 --- a/specification/search_application/get/SearchApplicationsGetRequest.ts +++ b/specification/search_application/get/SearchApplicationsGetRequest.ts @@ -25,6 +25,7 @@ import { Name } from '@_types/common' * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public * @cluster_privileges manage_search_application + * @doc_id search-application-get */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts index cb3d41d547..ca611b64d1 100644 --- a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts +++ b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts @@ -25,6 +25,7 @@ import { Name } from '@_types/common' * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public * @doc_tag analytics + * @doc_id list-analytics-collection */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/list/SearchApplicationsListRequest.ts b/specification/search_application/list/SearchApplicationsListRequest.ts index f37b05d5b1..5297ffbf3e 100644 --- a/specification/search_application/list/SearchApplicationsListRequest.ts +++ b/specification/search_application/list/SearchApplicationsListRequest.ts @@ -26,6 +26,7 @@ import { integer } from '@_types/Numeric' * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public * @cluster_privileges manage_search_application + * @doc_id list-analytics-collection */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/put/SearchApplicationsPutRequest.ts b/specification/search_application/put/SearchApplicationsPutRequest.ts index b51430a365..f681970c34 100644 --- a/specification/search_application/put/SearchApplicationsPutRequest.ts +++ b/specification/search_application/put/SearchApplicationsPutRequest.ts @@ -27,6 +27,7 @@ import { SearchApplicationParameters } from '../_types/SearchApplicationParamete * @availability serverless stability=beta visibility=public * @cluster_privileges manage_search_application * @index_privileges manage + * @doc_id search-application-put */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts index 13a6034ce0..075e627302 100644 --- a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts +++ b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts @@ -25,6 +25,7 @@ import { Name } from '@_types/common' * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public * @doc_tag analytics + * @doc_id put-analytics-collection */ export interface Request extends RequestBase { urls: [ diff --git a/specification/search_application/search/SearchApplicationsSearchRequest.ts b/specification/search_application/search/SearchApplicationsSearchRequest.ts index c8f3367bcb..bb350e9fd9 100644 --- a/specification/search_application/search/SearchApplicationsSearchRequest.ts +++ b/specification/search_application/search/SearchApplicationsSearchRequest.ts @@ -28,6 +28,7 @@ import { Name } from '@_types/common' * @rest_spec_name search_application.search * @availability stack since=8.8.0 stability=beta * @availability serverless stability=beta visibility=public + * @doc_id search-application-search */ export interface Request extends RequestBase { urls: [ diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index be0801ae67..da7feb5b66 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -29,6 +29,7 @@ import { Refresh } from '@_types/common' * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @doc_id security-api-bulk-delete-role */ export interface Request extends RequestBase { urls: [ diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index fab8dfbbe2..b3cfadced7 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -31,6 +31,7 @@ import { Refresh } from '@_types/common' * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @doc_id security-api-bulk-put-role */ export interface Request extends RequestBase { urls: [ diff --git a/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts index 438b22a4cc..1fd6062aba 100644 --- a/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts +++ b/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts @@ -27,6 +27,7 @@ import { GrokPattern } from '@_types/common' * @rest_spec_name text_structure.test_grok_pattern * @availability stack since=8.13.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_id test-grok-pattern * @ext_doc_id grok */ export interface Request extends RequestBase { diff --git a/specification/transform/delete_transform/DeleteTransformRequest.ts b/specification/transform/delete_transform/DeleteTransformRequest.ts index 3f7c4e4bc7..e509f22b94 100644 --- a/specification/transform/delete_transform/DeleteTransformRequest.ts +++ b/specification/transform/delete_transform/DeleteTransformRequest.ts @@ -23,11 +23,11 @@ import { Duration } from '@_types/Time' /** * Delete a transform. - * Deletes a transform. * @rest_spec_name transform.delete_transform * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform + * @doc_id delete-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/get_transform/GetTransformRequest.ts b/specification/transform/get_transform/GetTransformRequest.ts index 670c3e73fa..1b33f6bb4c 100644 --- a/specification/transform/get_transform/GetTransformRequest.ts +++ b/specification/transform/get_transform/GetTransformRequest.ts @@ -23,11 +23,12 @@ import { integer } from '@_types/Numeric' /** * Get transforms. - * Retrieves configuration information for transforms. + * Get configuration information for transforms. * @rest_spec_name transform.get_transform * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_transform + * @doc_id get-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts index 4a186fe31d..5dbf3f7c13 100644 --- a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts +++ b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts @@ -24,12 +24,13 @@ import { Duration } from '@_types/Time' /** * Get transform stats. - * Retrieves usage information for transforms. + * Get usage information for transforms. * @rest_spec_name transform.get_transform_stats * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges monitor_transform * @index_privileges read, view_index_metadata + * @doc_id get-transform-stats */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/preview_transform/PreviewTransformRequest.ts b/specification/transform/preview_transform/PreviewTransformRequest.ts index aaaa5505c9..51c0384354 100644 --- a/specification/transform/preview_transform/PreviewTransformRequest.ts +++ b/specification/transform/preview_transform/PreviewTransformRequest.ts @@ -42,6 +42,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform * @index_privileges read, view_index_metadata + * @doc_id preview-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/put_transform/PutTransformRequest.ts b/specification/transform/put_transform/PutTransformRequest.ts index 7489dd7a3c..f59db1f039 100644 --- a/specification/transform/put_transform/PutTransformRequest.ts +++ b/specification/transform/put_transform/PutTransformRequest.ts @@ -59,6 +59,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform * @index_privileges create_index, read, index, view_index_metadata + * @doc_id put-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/reset_transform/ResetTransformRequest.ts b/specification/transform/reset_transform/ResetTransformRequest.ts index 2a1201dbef..cb1a21136c 100644 --- a/specification/transform/reset_transform/ResetTransformRequest.ts +++ b/specification/transform/reset_transform/ResetTransformRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.1.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform + * @doc_id reset-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts index 908dda0964..a32f9fc74d 100644 --- a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts +++ b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts @@ -32,6 +32,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.7.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform + * @doc_id schedule-now-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/start_transform/StartTransformRequest.ts b/specification/transform/start_transform/StartTransformRequest.ts index b02a56d01f..b471b44e93 100644 --- a/specification/transform/start_transform/StartTransformRequest.ts +++ b/specification/transform/start_transform/StartTransformRequest.ts @@ -44,6 +44,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform * @index_privileges read, view_index_metadata + * @doc_id start-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/stop_transform/StopTransformRequest.ts b/specification/transform/stop_transform/StopTransformRequest.ts index 3c34afa677..d9af7b62b4 100644 --- a/specification/transform/stop_transform/StopTransformRequest.ts +++ b/specification/transform/stop_transform/StopTransformRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform + * @doc_id stop-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/update_transform/UpdateTransformRequest.ts b/specification/transform/update_transform/UpdateTransformRequest.ts index 1c30edc632..1277fe12a7 100644 --- a/specification/transform/update_transform/UpdateTransformRequest.ts +++ b/specification/transform/update_transform/UpdateTransformRequest.ts @@ -42,6 +42,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_transform * @index_privileges read, index, view_index_metadata + * @doc_id update-transform */ export interface Request extends RequestBase { urls: [ diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts index 811a19024c..19f5d67198 100644 --- a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts +++ b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts @@ -39,6 +39,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_transform + * @doc_id upgrade-transforms */ export interface Request extends RequestBase { urls: [