From bed5a6a493d25c1b10424669a88f0aa6c2d9196a Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 3 Dec 2024 14:05:30 -0800 Subject: [PATCH 1/3] [DOCS] Add ingest pipeline operation summaries --- .../delete_geoip_database/DeleteGeoipDatabaseRequest.ts | 2 +- .../ingest/delete_pipeline/DeletePipelineRequest.ts | 4 +++- .../ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts | 4 +++- .../ingest/get_geoip_database/GetGeoipDatabaseRequest.ts | 3 ++- specification/ingest/get_pipeline/GetPipelineRequest.ts | 4 +++- .../ingest/processor_grok/GrokProcessorPatternsRequest.ts | 6 ++++-- .../ingest/put_geoip_database/PutGeoipDatabaseRequest.ts | 2 +- specification/ingest/put_pipeline/PutPipelineRequest.ts | 3 ++- specification/ingest/simulate/SimulatePipelineRequest.ts | 4 +++- 9 files changed, 22 insertions(+), 10 deletions(-) diff --git a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts index 3ca4b49c63..08aff3b2e9 100644 --- a/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts +++ b/specification/ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts @@ -22,7 +22,7 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes a geoip database configuration. + * Delete an IP geolocation database configuration. * @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..aeeaa24d25 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 IP geolocation data configuration. + * Get information about one or more IP geoip 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..1a4a3b09b9 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..7e17425dfa 100644 --- a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts +++ b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts @@ -23,7 +23,7 @@ import { Id, Name } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more 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 From 1a050358c862bb97a678a9b6c31b40caac4b0714 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 3 Dec 2024 14:16:15 -0800 Subject: [PATCH 2/3] Generate output --- output/openapi/elasticsearch-openapi.json | 62 +++++++++++++----- .../elasticsearch-serverless-openapi.json | 44 +++++++++---- output/schema/schema.json | 64 +++++++++++-------- .../DeleteGeoipDatabaseRequest.ts | 3 +- .../GetGeoipDatabaseRequest.ts | 4 +- .../PutGeoipDatabaseRequest.ts | 1 + 6 files changed, 119 insertions(+), 59 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 8fcde9063e..c102ccb59b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15060,7 +15060,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": [ { @@ -15081,7 +15082,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": [ { @@ -15156,7 +15158,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": [ { @@ -15211,8 +15214,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": [ { @@ -15236,8 +15242,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": [ { @@ -15340,7 +15349,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": [ { @@ -15395,7 +15408,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": { @@ -15433,7 +15450,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": [ { @@ -15453,8 +15471,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": [ { @@ -15477,8 +15498,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": { @@ -15511,7 +15535,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": [ { @@ -15532,7 +15557,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": [ { @@ -15555,7 +15581,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": [ { @@ -15579,7 +15606,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 2f460e5736..cda7b24199 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -8757,8 +8757,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": [ { @@ -8782,8 +8785,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": [ { @@ -8886,7 +8892,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": [ { @@ -8941,8 +8951,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": [ { @@ -8965,8 +8978,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": { @@ -8999,7 +9015,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": [ { @@ -9020,7 +9037,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": [ { @@ -9043,7 +9061,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": [ { @@ -9067,7 +9086,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 10cc868603..df3687f1a8 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8537,7 +8537,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": { @@ -8597,8 +8597,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", @@ -8632,9 +8634,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", @@ -8667,7 +8671,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": { @@ -8739,8 +8743,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", @@ -8780,9 +8786,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", @@ -8815,7 +8823,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": { @@ -8881,9 +8889,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", @@ -8920,7 +8930,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": { @@ -146292,7 +146302,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", @@ -146345,7 +146355,7 @@ } } ], - "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L48" + "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L49" }, { "kind": "response", @@ -146373,7 +146383,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", @@ -146426,7 +146436,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L52" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L54" }, { "kind": "response", @@ -146608,7 +146618,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", @@ -146621,7 +146631,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L29" + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L31" }, { "kind": "response", @@ -146742,7 +146752,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", @@ -146782,7 +146792,7 @@ } } ], - "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L24-L46" + "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L24-L47" }, { "kind": "response", @@ -146819,7 +146829,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", @@ -146872,7 +146882,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L50" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L52" }, { "kind": "response", @@ -146911,7 +146921,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", @@ -146924,7 +146934,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L31" + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L33" }, { "kind": "response", @@ -146995,7 +147005,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", @@ -147048,7 +147058,7 @@ } } ], - "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L57" + "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L58" }, { "kind": "response", @@ -147157,7 +147167,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", @@ -147222,7 +147232,7 @@ } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L83" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L84" }, { "kind": "response", @@ -147619,7 +147629,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", @@ -147658,7 +147668,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 08aff3b2e9..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' /** - * Delete an IP geolocation 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/get_geoip_database/GetGeoipDatabaseRequest.ts b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts index aeeaa24d25..a3780949ae 100644 --- a/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts +++ b/specification/ingest/get_geoip_database/GetGeoipDatabaseRequest.ts @@ -22,8 +22,8 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Get IP geolocation data configuration. - * Get information about one or more IP 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/put_geoip_database/PutGeoipDatabaseRequest.ts b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts index 7e17425dfa..9816b2fb7b 100644 --- a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts +++ b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts @@ -23,6 +23,7 @@ import { Id, Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * 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 From 62a2fc60137c583c31ce9cd4f7dfe916c3907810 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 3 Dec 2024 14:38:14 -0800 Subject: [PATCH 3/3] Lint whitespace --- output/schema/schema.json | 4 ++-- .../ingest/processor_grok/GrokProcessorPatternsRequest.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index df3687f1a8..c37835c4c9 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8786,7 +8786,7 @@ "stability": "stable" } }, - "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.", + "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", @@ -146921,7 +146921,7 @@ "body": { "kind": "no_body" }, - "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.", + "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", diff --git a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts index 1a4a3b09b9..0b1fa53570 100644 --- a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts +++ b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' /** - * Run a grok processor. + * 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.