diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 9d09debe8f..c83b5cad1d 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -689,6 +689,9 @@ "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "operationId": "bulk-1", "parameters": [ + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -715,6 +718,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -734,6 +740,9 @@ "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "operationId": "bulk", "parameters": [ + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -760,6 +769,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -784,6 +796,9 @@ { "$ref": "#/components/parameters/bulk#index" }, + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -810,6 +825,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -832,6 +850,9 @@ { "$ref": "#/components/parameters/bulk#index" }, + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -858,6 +879,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -25155,7 +25179,7 @@ "rollup" ], "summary": "Create a rollup job", - "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", + "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "operationId": "rollup-put-job", "parameters": [ { @@ -25239,7 +25263,7 @@ "rollup" ], "summary": "Delete a rollup job", - "description": "A job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", + "description": "A job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "operationId": "rollup-delete-job", "parameters": [ { @@ -93631,6 +93655,16 @@ }, "style": "simple" }, + "bulk#list_executed_pipelines": { + "in": "query", + "name": "list_executed_pipelines", + "description": "If `true`, the response will include the ingest pipelines that were executed for each index or create.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, "bulk#pipeline": { "in": "query", "name": "pipeline", @@ -93721,6 +93755,16 @@ }, "style": "form" }, + "bulk#require_data_stream": { + "in": "query", + "name": "require_data_stream", + "description": "If `true`, the request's actions must target a data stream (existing or to-be-created).", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, "cat.aliases#name": { "in": "path", "name": "name", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index ce9b4f2d51..01c70783fe 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -467,6 +467,9 @@ "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "operationId": "bulk-1", "parameters": [ + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -493,6 +496,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -512,6 +518,9 @@ "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "operationId": "bulk", "parameters": [ + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -538,6 +547,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -562,6 +574,9 @@ { "$ref": "#/components/parameters/bulk#index" }, + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -588,6 +603,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -610,6 +628,9 @@ { "$ref": "#/components/parameters/bulk#index" }, + { + "$ref": "#/components/parameters/bulk#list_executed_pipelines" + }, { "$ref": "#/components/parameters/bulk#pipeline" }, @@ -636,6 +657,9 @@ }, { "$ref": "#/components/parameters/bulk#require_alias" + }, + { + "$ref": "#/components/parameters/bulk#require_data_stream" } ], "requestBody": { @@ -57676,6 +57700,16 @@ }, "style": "simple" }, + "bulk#list_executed_pipelines": { + "in": "query", + "name": "list_executed_pipelines", + "description": "If `true`, the response will include the ingest pipelines that were executed for each index or create.", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, "bulk#pipeline": { "in": "query", "name": "pipeline", @@ -57766,6 +57800,16 @@ }, "style": "form" }, + "bulk#require_data_stream": { + "in": "query", + "name": "require_data_stream", + "description": "If `true`, the request's actions must target a data stream (existing or to-be-created).", + "deprecated": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, "cat.aliases#name": { "in": "path", "name": "name", diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index dcee298009..4dd3c08eb1 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -3337,7 +3337,7 @@ "stability": "stable" } }, - "description": "Get the status for a data stream lifecycle.\nRetrieves 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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { @@ -3980,9 +3980,17 @@ "stability": "stable" } }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", + "extDocId": "index-templates", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html", "name": "indices.put_template", + "privileges": { + "cluster": [ + "manage_index_templates", + "manage" + ] + }, "request": { "name": "Request", "namespace": "indices.put_template" @@ -4448,9 +4456,14 @@ "visibility": "public" } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", "name": "inference.put", + "privileges": { + "cluster": [ + "manage_inference" + ] + }, "request": { "name": "Request", "namespace": "inference.put" @@ -4730,7 +4743,7 @@ "stability": "stable" } }, - "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "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", "name": "license.get", "request": { @@ -4765,8 +4778,10 @@ "stability": "stable" } }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -4805,8 +4820,10 @@ "stability": "stable" } }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -4851,8 +4868,10 @@ "stability": "stable" } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", + "extDocId": "logstash-centralized-pipeline-management", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -11343,6 +11362,19 @@ } ], "query": [ + { + "description": "If `true`, the response will include the ingest pipelines that were executed for each index or create.", + "name": "list_executed_pipelines", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", @@ -11454,9 +11486,22 @@ "namespace": "_builtins" } } + }, + { + "description": "If `true`, the request's actions must target a data stream (existing or to-be-created).", + "name": "require_data_stream", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_global/bulk/BulkRequest.ts#L32-L105" + "specLocation": "_global/bulk/BulkRequest.ts#L32-L115" }, { "body": { @@ -21229,7 +21274,7 @@ "body": { "kind": "no_body" }, - "description": "Get the status for a data stream lifecycle.\nRetrieves 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.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -23529,7 +23574,7 @@ } ] }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.", "inherits": { "type": { "name": "RequestBase", @@ -23606,7 +23651,7 @@ } } ], - "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L95" + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L107" }, { "body": { @@ -25151,7 +25196,7 @@ } } }, - "description": "Create an inference endpoint", + "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "inherits": { "type": { "name": "RequestBase", @@ -25190,7 +25235,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L44" + "specLocation": "inference/put/PutRequest.ts#L25-L54" }, { "body": { @@ -25818,7 +25863,7 @@ "body": { "kind": "no_body" }, - "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -25863,7 +25908,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L45" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L47" }, { "body": { @@ -25896,7 +25941,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a pipeline used for Logstash Central Management.", + "description": "Delete a Logstash pipeline.\n\nDelete a pipeline that is used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -25910,7 +25955,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -25923,7 +25968,7 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L37" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L40" }, { "body": { @@ -25943,7 +25988,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves pipelines used for Logstash Central Management.", + "description": "Get Logstash pipelines.\n\nGet pipelines that are used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -25957,7 +26002,7 @@ }, "path": [ { - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "name": "id", "required": false, "type": { @@ -25970,7 +26015,7 @@ } ], "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L37" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L40" }, { "body": { @@ -26016,7 +26061,7 @@ } } }, - "description": "Creates or updates a pipeline used for Logstash Central Management.", + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "inherits": { "type": { "name": "RequestBase", @@ -26030,7 +26075,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -26043,7 +26088,7 @@ } ], "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L39" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L44" }, { "body": { @@ -126550,7 +126595,7 @@ }, "properties": [ { - "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "name": "description", "required": true, "type": { @@ -126562,7 +126607,7 @@ } }, { - "description": "Date the pipeline was last updated.\nMust be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", "name": "last_modified", "required": true, "type": { @@ -126574,59 +126619,59 @@ } }, { - "description": "Optional metadata about the pipeline.\nMay have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", - "name": "pipeline_metadata", + "description": "The configuration for the pipeline.", + "extDocId": "logstash-configuration-file-structure", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", + "name": "pipeline", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineMetadata", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "User who last updated the pipeline.", - "name": "username", + "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "name": "pipeline_metadata", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineMetadata", + "namespace": "logstash._types" } } }, { - "description": "Configuration for the pipeline.", - "docId": "logstash-configuration-file-structure", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", - "name": "pipeline", + "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", + "extDocId": "logstash-logstash-settings-file", + "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", + "name": "pipeline_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineSettings", + "namespace": "logstash._types" } } }, { - "description": "Settings for the pipeline.\nSupports only flat keys in dot notation.", - "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", - "name": "pipeline_settings", + "description": "The user who last updated the pipeline.", + "name": "username", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineSettings", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "logstash/_types/Pipeline.ts#L60-L92" + "specLocation": "logstash/_types/Pipeline.ts#L60-L91" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index fbd38aae25..6a81cc36c3 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9554,6 +9554,90 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.cancel_reindex", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_migration/reindex/{index}/_cancel" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API returns the status of a migration reindex attempt for a data stream or index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.get_reindex_status", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_migration/reindex/{index}/_status" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "private" + } + }, + "description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "name": "migrate.reindex", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_migration/reindex" + } + ] + }, { "availability": { "stack": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 7ccd47a27c..0dd2a56f16 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -43,6 +43,12 @@ ], "response": [] }, + "bulk": { + "request": [ + "Request: missing json spec query parameter 'type'" + ], + "response": [] + }, "capabilities": { "request": [ "Missing request & response" @@ -694,6 +700,24 @@ ], "response": [] }, + "migrate.cancel_reindex": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "migrate.get_reindex_status": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "migrate.reindex": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "ml.delete_trained_model": { "request": [ "Request: missing json spec query parameter 'timeout'" diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index 3444e1c017..59e79d0684 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -46,6 +46,10 @@ "type": "time", "description": "Explicit operation timeout" }, + "type": { + "type": "string", + "description": "Default document type for items which don't provide one" + }, "_source": { "type": "list", "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request" @@ -64,11 +68,11 @@ }, "require_alias": { "type": "boolean", - "description": "If true, the request’s actions must target an index alias. Defaults to false." + "description": "Sets require_alias for all incoming documents. Defaults to unset (false)" }, "require_data_stream": { "type": "boolean", - "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false" + "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false" }, "list_executed_pipelines": { "type": "boolean", diff --git a/specification/_json_spec/migrate.cancel_reindex.json b/specification/_json_spec/migrate.cancel_reindex.json new file mode 100644 index 0000000000..660bd47272 --- /dev/null +++ b/specification/_json_spec/migrate.cancel_reindex.json @@ -0,0 +1,28 @@ +{ + "migrate.cancel_reindex": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API returns the status of a migration reindex attempt for a data stream or index" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex/{index}/_cancel", + "methods": ["POST"], + "parts": { + "index": { + "type": "string", + "description": "The index or data stream name" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/migrate.get_reindex_status.json b/specification/_json_spec/migrate.get_reindex_status.json new file mode 100644 index 0000000000..d5361ff1bb --- /dev/null +++ b/specification/_json_spec/migrate.get_reindex_status.json @@ -0,0 +1,28 @@ +{ + "migrate.get_reindex_status": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API returns the status of a migration reindex attempt for a data stream or index" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex/{index}/_status", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The index or data stream name" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/migrate.reindex.json b/specification/_json_spec/migrate.reindex.json new file mode 100644 index 0000000000..ae2e6a8f8a --- /dev/null +++ b/specification/_json_spec/migrate.reindex.json @@ -0,0 +1,26 @@ +{ + "migrate.reindex": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html", + "description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task" + }, + "stability": "experimental", + "visibility": "private", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_migration/reindex", + "methods": ["POST"] + } + ] + }, + "body": { + "description": "The body contains the fields `mode` and `source.index, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name", + "required": true + } + } +}