Skip to content

Commit 91f07bd

Browse files
committed
[OpenAPI] Edits Logstash APIs
1 parent 79c2160 commit 91f07bd

File tree

5 files changed

+33
-22
lines changed

5 files changed

+33
-22
lines changed

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ knn-inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/
253253
logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html
254254
logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html
255255
logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html
256+
logstash-centralized-pipeline-management,https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html
256257
logstash-configuration-file-structure,https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html
257258
logstash-logstash-settings-file,https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html
258259
lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html

specification/logstash/_types/Pipeline.ts

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,34 +59,33 @@ export class PipelineSettings {
5959
}
6060
export class Pipeline {
6161
/**
62-
* Description of the pipeline.
62+
* A description of the pipeline.
6363
* This description is not used by Elasticsearch or Logstash.
6464
*/
6565
description: string
6666
/**
67-
* Date the pipeline was last updated.
68-
* Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.
67+
* The date the pipeline was last updated.
68+
* It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.
6969
*/
7070
last_modified: DateTime
7171
/**
72-
* Optional metadata about the pipeline.
73-
* May have any contents.
74-
* This metadata is not generated or used by Elasticsearch or Logstash.
75-
*/
76-
pipeline_metadata: PipelineMetadata
77-
/**
78-
* User who last updated the pipeline.
72+
* The configuration for the pipeline.
73+
* @ext_doc_id logstash-configuration-file-structure
7974
*/
80-
username: string
75+
pipeline: string
8176
/**
82-
* Configuration for the pipeline.
83-
* @doc_id logstash-configuration-file-structure
77+
* Optional metadata about the pipeline, which can have any contents.
78+
* This metadata is not generated or used by Elasticsearch or Logstash.
8479
*/
85-
pipeline: string
80+
pipeline_metadata: PipelineMetadata
8681
/**
8782
* Settings for the pipeline.
88-
* Supports only flat keys in dot notation.
89-
* @doc_id logstash-logstash-settings-file
83+
* It supports only flat keys in dot notation.
84+
* @ext_doc_id logstash-logstash-settings-file
9085
*/
9186
pipeline_settings: PipelineSettings
87+
/**
88+
* The user who last updated the pipeline.
89+
*/
90+
username: string
9291
}

specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Deletes a pipeline used for Logstash Central Management.
24+
* Delete a Logstash pipeline.
25+
*
26+
* Delete a pipeline that is used for Logstash Central Management.
2527
* @rest_spec_name logstash.delete_pipeline
2628
* @availability stack since=7.12.0 stability=stable
2729
* @availability serverless stability=stable visibility=public
2830
* @cluster_privileges manage_logstash_pipelines
31+
* @ext_doc_id logstash-centralized-pipeline-management
2932
*/
3033
export interface Request extends RequestBase {
3134
path_parts: {
3235
/**
33-
* Identifier for the pipeline.
36+
* An identifier for the pipeline.
3437
*/
3538
id: Id
3639
}

specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,19 @@ import { RequestBase } from '@_types/Base'
2121
import { Ids } from '@_types/common'
2222

2323
/**
24-
* Retrieves pipelines used for Logstash Central Management.
24+
* Get Logstash pipelines.
25+
*
26+
* Get pipelines that are used for Logstash Central Management.
2527
* @rest_spec_name logstash.get_pipeline
2628
* @availability stack since=7.12.0 stability=stable
2729
* @availability serverless stability=stable visibility=public
2830
* @cluster_privileges manage_logstash_pipelines
31+
* @ext_doc_id logstash-centralized-pipeline-management
2932
*/
3033
export interface Request extends RequestBase {
3134
path_parts: {
3235
/**
33-
* Comma-separated list of pipeline identifiers.
36+
* A comma-separated list of pipeline identifiers.
3437
*/
3538
id?: Ids
3639
}

specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,21 @@ import { Pipeline } from '@logstash/_types/Pipeline'
2121
import { RequestBase } from '@_types/Base'
2222
import { Id } from '@_types/common'
2323

24-
/** Creates or updates a pipeline used for Logstash Central Management.
24+
/**
25+
* Create or update a Logstash pipeline.
26+
*
27+
* Create a pipeline that is used for Logstash Central Management.
28+
* If the specified pipeline exists, it is replaced.
2529
* @rest_spec_name logstash.put_pipeline
2630
* @availability stack since=7.12.0 stability=stable
2731
* @availability serverless stability=stable visibility=public
2832
* @cluster_privileges manage_logstash_pipelines
33+
* @ext_doc_id logstash-centralized-pipeline-management
2934
*/
3035
export interface Request extends RequestBase {
3136
path_parts: {
3237
/**
33-
* Identifier for the pipeline.
38+
* An identifier for the pipeline.
3439
*/
3540
id: Id
3641
}

0 commit comments

Comments
 (0)