From dd538c9ba2761afd3a0d3590351752269dfe273e Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 16 Dec 2024 18:31:53 -0800 Subject: [PATCH] [OpenAPI] Edits Logstash pipeline APIs (#3073) --- output/openapi/elasticsearch-openapi.json | 57 +++++++++----- .../elasticsearch-serverless-openapi.json | 57 +++++++++----- output/schema/schema.json | 76 ++++++++++--------- output/typescript/types.ts | 4 +- specification/_doc_ids/table.csv | 1 + specification/logstash/_types/Pipeline.ts | 31 ++++---- .../LogstashDeletePipelineRequest.ts | 7 +- .../LogstashGetPipelineRequest.ts | 7 +- .../LogstashPutPipelineRequest.ts | 9 ++- 9 files changed, 152 insertions(+), 97 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index ea68fe1207..c05c51ec01 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -16180,7 +16180,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline-1", "parameters": [ { @@ -16198,13 +16202,17 @@ "tags": [ "logstash" ], - "summary": "Creates or updates a pipeline used for Logstash Central Management", + "summary": "Create or update a Logstash pipeline", + "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-put-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -16237,13 +16245,17 @@ "tags": [ "logstash" ], - "summary": "Deletes a pipeline used for Logstash Central Management", + "summary": "Delete a Logstash pipeline", + "description": "Delete a pipeline that is used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-delete-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -16268,7 +16280,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline", "responses": { "200": { @@ -72388,34 +72404,37 @@ "type": "object", "properties": { "description": { - "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.", "type": "string" }, "last_modified": { "$ref": "#/components/schemas/_types:DateTime" }, - "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types:PipelineMetadata" - }, - "username": { - "description": "User who last updated the pipeline.", - "type": "string" - }, "pipeline": { - "description": "Configuration for the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + }, + "description": "The configuration for the pipeline.", "type": "string" }, + "pipeline_metadata": { + "$ref": "#/components/schemas/logstash._types:PipelineMetadata" + }, "pipeline_settings": { "$ref": "#/components/schemas/logstash._types:PipelineSettings" + }, + "username": { + "description": "The user who last updated the pipeline.", + "type": "string" } }, "required": [ "description", "last_modified", - "pipeline_metadata", - "username", "pipeline", - "pipeline_settings" + "pipeline_metadata", + "pipeline_settings", + "username" ] }, "logstash._types:PipelineMetadata": { @@ -98322,7 +98341,7 @@ "logstash.get_pipeline#id": { "in": "path", "name": "id", - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "required": true, "deprecated": false, "schema": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 7e639ab6c6..d6cc466caa 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9235,7 +9235,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline-1", "parameters": [ { @@ -9253,13 +9257,17 @@ "tags": [ "logstash" ], - "summary": "Creates or updates a pipeline used for Logstash Central Management", + "summary": "Create or update a Logstash pipeline", + "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-put-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -9292,13 +9300,17 @@ "tags": [ "logstash" ], - "summary": "Deletes a pipeline used for Logstash Central Management", + "summary": "Delete a Logstash pipeline", + "description": "Delete a pipeline that is used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-delete-pipeline", "parameters": [ { "in": "path", "name": "id", - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "required": true, "deprecated": false, "schema": { @@ -9323,7 +9335,11 @@ "tags": [ "logstash" ], - "summary": "Retrieves pipelines used for Logstash Central Management", + "summary": "Get Logstash pipelines", + "description": "Get pipelines that are used for Logstash Central Management.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + }, "operationId": "logstash-get-pipeline", "responses": { "200": { @@ -47991,34 +48007,37 @@ "type": "object", "properties": { "description": { - "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.", "type": "string" }, "last_modified": { "$ref": "#/components/schemas/_types:DateTime" }, - "pipeline_metadata": { - "$ref": "#/components/schemas/logstash._types:PipelineMetadata" - }, - "username": { - "description": "User who last updated the pipeline.", - "type": "string" - }, "pipeline": { - "description": "Configuration for the pipeline.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + }, + "description": "The configuration for the pipeline.", "type": "string" }, + "pipeline_metadata": { + "$ref": "#/components/schemas/logstash._types:PipelineMetadata" + }, "pipeline_settings": { "$ref": "#/components/schemas/logstash._types:PipelineSettings" + }, + "username": { + "description": "The user who last updated the pipeline.", + "type": "string" } }, "required": [ "description", "last_modified", - "pipeline_metadata", - "username", "pipeline", - "pipeline_settings" + "pipeline_metadata", + "pipeline_settings", + "username" ] }, "logstash._types:PipelineMetadata": { @@ -60098,7 +60117,7 @@ "logstash.get_pipeline#id": { "in": "path", "name": "id", - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "required": true, "deprecated": false, "schema": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 0a1985d4a6..ab3801981e 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9369,8 +9369,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": [ @@ -9409,8 +9411,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": [ @@ -9455,8 +9459,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": [ @@ -149126,7 +149132,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": { @@ -149138,7 +149144,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": { @@ -149150,59 +149156,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", @@ -149342,7 +149348,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", @@ -149355,7 +149361,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -149368,7 +149374,7 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L37" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L40" }, { "kind": "response", @@ -149389,7 +149395,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", @@ -149402,7 +149408,7 @@ }, "path": [ { - "description": "Comma-separated list of pipeline identifiers.", + "description": "A comma-separated list of pipeline identifiers.", "name": "id", "required": false, "type": { @@ -149415,7 +149421,7 @@ } ], "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L37" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L40" }, { "kind": "response", @@ -149462,7 +149468,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", @@ -149475,7 +149481,7 @@ }, "path": [ { - "description": "Identifier for the pipeline.", + "description": "An identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -149488,7 +149494,7 @@ } ], "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L39" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L44" }, { "kind": "response", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 074d11f89d..2de101888b 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -13530,10 +13530,10 @@ export interface LicensePostStartTrialResponse { export interface LogstashPipeline { description: string last_modified: DateTime - pipeline_metadata: LogstashPipelineMetadata - username: string pipeline: string + pipeline_metadata: LogstashPipelineMetadata pipeline_settings: LogstashPipelineSettings + username: string } export interface LogstashPipelineMetadata { diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 16601f3352..afbdb888e1 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -266,6 +266,7 @@ license-management,https://www.elastic.co/guide/en/kibana/{branch}/managing-lice logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html +logstash-centralized-pipeline-management,https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html logstash-configuration-file-structure,https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html logstash-logstash-settings-file,https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html diff --git a/specification/logstash/_types/Pipeline.ts b/specification/logstash/_types/Pipeline.ts index 0e82c10bf2..76ff608407 100644 --- a/specification/logstash/_types/Pipeline.ts +++ b/specification/logstash/_types/Pipeline.ts @@ -59,34 +59,33 @@ export class PipelineSettings { } export class Pipeline { /** - * Description of the pipeline. + * A description of the pipeline. * This description is not used by Elasticsearch or Logstash. */ description: string /** - * Date the pipeline was last updated. - * Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. + * The date the pipeline was last updated. + * It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. */ last_modified: DateTime /** - * Optional metadata about the pipeline. - * May have any contents. - * This metadata is not generated or used by Elasticsearch or Logstash. - */ - pipeline_metadata: PipelineMetadata - /** - * User who last updated the pipeline. + * The configuration for the pipeline. + * @ext_doc_id logstash-configuration-file-structure */ - username: string + pipeline: string /** - * Configuration for the pipeline. - * @doc_id logstash-configuration-file-structure + * Optional metadata about the pipeline, which can have any contents. + * This metadata is not generated or used by Elasticsearch or Logstash. */ - pipeline: string + pipeline_metadata: PipelineMetadata /** * Settings for the pipeline. - * Supports only flat keys in dot notation. - * @doc_id logstash-logstash-settings-file + * It supports only flat keys in dot notation. + * @ext_doc_id logstash-logstash-settings-file */ pipeline_settings: PipelineSettings + /** + * The user who last updated the pipeline. + */ + username: string } diff --git a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts index bc35272839..a94dc2b20e 100644 --- a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts +++ b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts @@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a pipeline used for Logstash Central Management. + * Delete a Logstash pipeline. + * + * Delete a pipeline that is used for Logstash Central Management. * @rest_spec_name logstash.delete_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Identifier for the pipeline. + * An identifier for the pipeline. */ id: Id } diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts index e5865df54b..52b59d2706 100644 --- a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts @@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Retrieves pipelines used for Logstash Central Management. + * Get Logstash pipelines. + * + * Get pipelines that are used for Logstash Central Management. * @rest_spec_name logstash.get_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Comma-separated list of pipeline identifiers. + * A comma-separated list of pipeline identifiers. */ id?: Ids } diff --git a/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts index 4a41853425..aac5048de2 100644 --- a/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts +++ b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts @@ -21,16 +21,21 @@ import { Pipeline } from '@logstash/_types/Pipeline' import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' -/** Creates or updates a pipeline used for Logstash Central Management. +/** + * Create or update a Logstash pipeline. + * + * Create a pipeline that is used for Logstash Central Management. + * If the specified pipeline exists, it is replaced. * @rest_spec_name logstash.put_pipeline * @availability stack since=7.12.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_logstash_pipelines + * @ext_doc_id logstash-centralized-pipeline-management */ export interface Request extends RequestBase { path_parts: { /** - * Identifier for the pipeline. + * An identifier for the pipeline. */ id: Id }