diff --git a/output/schema/schema.json b/output/schema/schema.json index 14e6af4f45..7690b1d36e 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -17956,8 +17956,9 @@ } }, "description": "Simulate data ingestion.\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.", + "docId": "simulate-ingest-api", "docTag": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-ingest-api.html", "name": "simulate.ingest", "privileges": { "index": [ @@ -202061,7 +202062,7 @@ } } ], - "specLocation": "simulate/ingest/SimulateIngestRequest.ts#L29-L89" + "specLocation": "simulate/ingest/SimulateIngestRequest.ts#L29-L90" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index f6a72b8fd7..d23e2eb927 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -607,6 +607,7 @@ security-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{bra service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html +simulate-ingest-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-ingest-api.html simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html slm-api-delete-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-delete-policy.html slm-api-execute-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-lifecycle.html diff --git a/specification/simulate/ingest/SimulateIngestRequest.ts b/specification/simulate/ingest/SimulateIngestRequest.ts index b51765590f..69769c0990 100644 --- a/specification/simulate/ingest/SimulateIngestRequest.ts +++ b/specification/simulate/ingest/SimulateIngestRequest.ts @@ -48,6 +48,7 @@ import { TypeMapping } from '@_types/mapping/TypeMapping' * @availability stack since=8.12.0 stability=experimental visibility=public * @index_privileges index * @doc_tag ingest + * @doc_id simulate-ingest-api */ export interface Request extends RequestBase { path_parts: {