From eacd18c43b0664a46159bf8f8d6d826a5461a94d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 12:06:20 -0800 Subject: [PATCH] [DOCS] Add ingest operation summaries (#3218) (#3235) (cherry picked from commit dfbb09d6778bab7facfeb7277a9c71dd2356c672) Co-authored-by: Lisa Cawley --- output/openapi/elasticsearch-openapi.json | 62 +++++++++++++----- .../elasticsearch-serverless-openapi.json | 44 +++++++++---- output/schema/schema.json | 64 +++++++++++-------- .../DeleteGeoipDatabaseRequest.ts | 3 +- .../delete_pipeline/DeletePipelineRequest.ts | 4 +- .../geo_ip_stats/IngestGeoIpStatsRequest.ts | 4 +- .../GetGeoipDatabaseRequest.ts | 3 +- .../ingest/get_pipeline/GetPipelineRequest.ts | 4 +- .../GrokProcessorPatternsRequest.ts | 6 +- .../PutGeoipDatabaseRequest.ts | 3 +- .../ingest/put_pipeline/PutPipelineRequest.ts | 3 +- .../simulate/SimulatePipelineRequest.ts | 4 +- 12 files changed, 138 insertions(+), 66 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 8140e4ce7f..2aa0f0f4c8 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15026,7 +15026,8 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more geoip database configurations", + "summary": "Get GeoIP database configurations", + "description": "Get information about one or more IP geolocation database configurations.", "operationId": "ingest-get-geoip-database-1", "parameters": [ { @@ -15047,7 +15048,8 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more geoip database configurations", + "summary": "Create or update GeoIP database configurations", + "description": "Create or update IP geolocation database configurations.", "operationId": "ingest-put-geoip-database", "parameters": [ { @@ -15122,7 +15124,8 @@ "tags": [ "ingest" ], - "summary": "Deletes a geoip database configuration", + "summary": "Delete GeoIP database configurations", + "description": "Delete one or more IP geolocation database configurations.", "operationId": "ingest-delete-geoip-database", "parameters": [ { @@ -15177,8 +15180,11 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more ingest pipelines", - "description": "This API returns a local reference of the pipeline.", + "summary": "Get pipelines", + "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-get-pipeline-1", "parameters": [ { @@ -15202,8 +15208,11 @@ "tags": [ "ingest" ], - "summary": "Creates or updates an ingest pipeline", + "summary": "Create or update a pipeline", "description": "Changes made using this API take effect immediately.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-put-pipeline", "parameters": [ { @@ -15306,7 +15315,11 @@ "tags": [ "ingest" ], - "summary": "Deletes one or more existing ingest pipeline", + "summary": "Delete pipelines", + "description": "Delete one or more ingest pipelines.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-delete-pipeline", "parameters": [ { @@ -15361,7 +15374,11 @@ "tags": [ "ingest" ], - "summary": "Gets download statistics for GeoIP2 databases used with the geoip processor", + "summary": "Get GeoIP statistics", + "description": "Get download statistics for GeoIP2 databases that are used with the GeoIP processor.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html" + }, "operationId": "ingest-geo-ip-stats", "responses": { "200": { @@ -15399,7 +15416,8 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more geoip database configurations", + "summary": "Get GeoIP database configurations", + "description": "Get information about one or more IP geolocation database configurations.", "operationId": "ingest-get-geoip-database", "parameters": [ { @@ -15419,8 +15437,11 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more ingest pipelines", - "description": "This API returns a local reference of the pipeline.", + "summary": "Get pipelines", + "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-get-pipeline", "parameters": [ { @@ -15443,8 +15464,11 @@ "tags": [ "ingest" ], - "summary": "Extracts structured fields out of a single text field within a document", - "description": "You choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "summary": "Run a grok processor", + "description": "Extract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + }, "operationId": "ingest-processor-grok", "responses": { "200": { @@ -15477,7 +15501,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate", "parameters": [ { @@ -15498,7 +15523,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-1", "parameters": [ { @@ -15521,7 +15547,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-2", "parameters": [ { @@ -15545,7 +15572,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-3", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 8bb3a3f81a..4bc531c503 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9029,8 +9029,11 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more ingest pipelines", - "description": "This API returns a local reference of the pipeline.", + "summary": "Get pipelines", + "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-get-pipeline-1", "parameters": [ { @@ -9054,8 +9057,11 @@ "tags": [ "ingest" ], - "summary": "Creates or updates an ingest pipeline", + "summary": "Create or update a pipeline", "description": "Changes made using this API take effect immediately.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-put-pipeline", "parameters": [ { @@ -9158,7 +9164,11 @@ "tags": [ "ingest" ], - "summary": "Deletes one or more existing ingest pipeline", + "summary": "Delete pipelines", + "description": "Delete one or more ingest pipelines.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-delete-pipeline", "parameters": [ { @@ -9213,8 +9223,11 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more ingest pipelines", - "description": "This API returns a local reference of the pipeline.", + "summary": "Get pipelines", + "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + }, "operationId": "ingest-get-pipeline", "parameters": [ { @@ -9237,8 +9250,11 @@ "tags": [ "ingest" ], - "summary": "Extracts structured fields out of a single text field within a document", - "description": "You choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "summary": "Run a grok processor", + "description": "Extract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + }, "operationId": "ingest-processor-grok", "responses": { "200": { @@ -9271,7 +9287,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate", "parameters": [ { @@ -9292,7 +9309,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-1", "parameters": [ { @@ -9315,7 +9333,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-2", "parameters": [ { @@ -9339,7 +9358,8 @@ "tags": [ "ingest" ], - "summary": "Executes an ingest pipeline against a set of provided documents", + "summary": "Simulate a pipeline", + "description": "Run 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.", "operationId": "ingest-simulate-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 124c57f4f7..1e0b238d22 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8543,7 +8543,7 @@ "stability": "stable" } }, - "description": "Deletes a geoip database configuration.", + "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", "name": "ingest.delete_geoip_database", "request": { @@ -8603,8 +8603,10 @@ "stability": "stable" } }, - "description": "Deletes one or more existing ingest pipeline.", + "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", "request": { "name": "Request", @@ -8638,9 +8640,11 @@ "stability": "stable" } }, - "description": "Gets download statistics for GeoIP2 databases used with the geoip processor.", + "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "docId": "geoip-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", + "extDocId": "geoip-processor", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "ingest.geo_ip_stats", "request": { "name": "Request", @@ -8673,7 +8677,7 @@ "stability": "stable" } }, - "description": "Returns information about one or more geoip database configurations.", + "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", "name": "ingest.get_geoip_database", "request": { @@ -8745,8 +8749,10 @@ "stability": "stable" } }, - "description": "Returns information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "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", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", "request": { "name": "Request", @@ -8786,9 +8792,11 @@ "stability": "stable" } }, - "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", + "extDocId": "grok-processor", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -8821,7 +8829,7 @@ "stability": "stable" } }, - "description": "Returns information about one or more geoip database configurations.", + "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", "name": "ingest.put_geoip_database", "request": { @@ -8887,9 +8895,11 @@ "stability": "stable" } }, - "description": "Creates or updates an ingest pipeline.\nChanges made using this API take effect immediately.", + "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -8926,7 +8936,7 @@ "stability": "stable" } }, - "description": "Executes an ingest pipeline against a set of provided documents.", + "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", "name": "ingest.simulate", "request": { @@ -146002,7 +146012,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a geoip database configuration.", + "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -146055,7 +146065,7 @@ } } ], - "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L48" + "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L49" }, { "kind": "response", @@ -146083,7 +146093,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more existing ingest pipeline.", + "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "inherits": { "type": { "name": "RequestBase", @@ -146136,7 +146146,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L52" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L54" }, { "kind": "response", @@ -146318,7 +146328,7 @@ "body": { "kind": "no_body" }, - "description": "Gets download statistics for GeoIP2 databases used with the geoip processor.", + "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "inherits": { "type": { "name": "RequestBase", @@ -146331,7 +146341,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L29" + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L31" }, { "kind": "response", @@ -146452,7 +146462,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more geoip database configurations.", + "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -146492,7 +146502,7 @@ } } ], - "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L24-L46" + "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L24-L47" }, { "kind": "response", @@ -146529,7 +146539,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -146582,7 +146592,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L50" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L52" }, { "kind": "response", @@ -146621,7 +146631,7 @@ "body": { "kind": "no_body" }, - "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "inherits": { "type": { "name": "RequestBase", @@ -146634,7 +146644,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L31" + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L33" }, { "kind": "response", @@ -146705,7 +146715,7 @@ } ] }, - "description": "Returns information about one or more geoip database configurations.", + "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -146758,7 +146768,7 @@ } } ], - "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L57" + "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L58" }, { "kind": "response", @@ -146867,7 +146877,7 @@ } ] }, - "description": "Creates or updates an ingest pipeline.\nChanges made using this API take effect immediately.", + "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "inherits": { "type": { "name": "RequestBase", @@ -146932,7 +146942,7 @@ } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L83" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L84" }, { "kind": "response", @@ -147329,7 +147339,7 @@ } ] }, - "description": "Executes an ingest pipeline against a set of provided documents.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -147368,7 +147378,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L57" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L59" }, { "kind": "response", diff --git a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts index 3ca4b49c63..0c9c193bec 100644 --- a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts +++ b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts @@ -22,7 +22,8 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes a geoip database configuration. + * 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 diff --git a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts index c5b59f07ec..f2110d39ac 100644 --- a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts +++ b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts @@ -22,10 +22,12 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes one or more existing ingest pipeline. + * Delete pipelines. + * Delete one or more ingest pipelines. * @rest_spec_name ingest.delete_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id ingest */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts index bda5f2b039..a7f47d2e14 100644 --- a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts +++ b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts @@ -20,10 +20,12 @@ import { RequestBase } from '@_types/Base' /** - * Gets download statistics for GeoIP2 databases used with the geoip processor. + * Get GeoIP statistics. + * Get download statistics for GeoIP2 databases that are used with the GeoIP processor. * @doc_id geoip-processor * @rest_spec_name ingest.geo_ip_stats * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id geoip-processor */ export interface Request extends RequestBase {} diff --git a/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts index 341705ad9f..a3780949ae 100644 --- a/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts +++ b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts @@ -22,7 +22,8 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more geoip database configurations. + * 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 diff --git a/specification/ingest/get_pipeline/GetPipelineRequest.ts b/specification/ingest/get_pipeline/GetPipelineRequest.ts index 2561c9d72f..c81a99699c 100644 --- a/specification/ingest/get_pipeline/GetPipelineRequest.ts +++ b/specification/ingest/get_pipeline/GetPipelineRequest.ts @@ -22,11 +22,13 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more ingest pipelines. + * 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 + * @ext_doc_id ingest */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts index 7a44513679..0b1fa53570 100644 --- a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts +++ b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts @@ -20,12 +20,14 @@ import { RequestBase } from '@_types/Base' /** - * Extracts structured fields out of a single text field within a document. - * You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + * Run a grok processor. + * Extract structured fields out of a single text field within a document. + * You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. * A grok pattern is like a regular expression that supports aliased expressions that can be reused. * @doc_id grok-processor * @rest_spec_name ingest.processor_grok * @availability stack since=6.1.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id grok-processor */ export interface Request extends RequestBase {} diff --git a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts index 7cc987f98d..9816b2fb7b 100644 --- a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts +++ b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts @@ -23,7 +23,8 @@ import { Id, Name } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more geoip database configurations. + * Create or update GeoIP database configurations. + * Create or update IP geolocation database configurations. * @rest_spec_name ingest.put_geoip_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private diff --git a/specification/ingest/put_pipeline/PutPipelineRequest.ts b/specification/ingest/put_pipeline/PutPipelineRequest.ts index 5f066cd2c8..71738084d6 100644 --- a/specification/ingest/put_pipeline/PutPipelineRequest.ts +++ b/specification/ingest/put_pipeline/PutPipelineRequest.ts @@ -23,12 +23,13 @@ import { Id, Metadata, VersionNumber } from '@_types/common' import { Duration } from '@_types/Time' /** - * Creates or updates an ingest pipeline. + * Create or update a pipeline. * Changes made using this API take effect immediately. * @doc_id ingest * @rest_spec_name ingest.put_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id ingest */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ingest/simulate/SimulatePipelineRequest.ts b/specification/ingest/simulate/SimulatePipelineRequest.ts index 00709586ae..ba29c492d5 100644 --- a/specification/ingest/simulate/SimulatePipelineRequest.ts +++ b/specification/ingest/simulate/SimulatePipelineRequest.ts @@ -23,7 +23,9 @@ import { Id } from '@_types/common' import { Document } from './types' /** - * Executes an ingest pipeline against a set of provided documents. + * 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