Add Logstash API examples (#3436) (#3447)

(cherry picked from commit 254c12f) Co-authored-by: Lisa Cawley <[email protected]>
elastic · Jan 7, 2025 · fe4ec7e · fe4ec7e
1 parent 622b81b
commit fe4ec7e
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 13 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts b/specification/logstash/delete_pipeline/LogstashDeletePipelineRequest.ts
@@ -22,12 +22,13 @@ import { Id } from '@_types/common'
 
 /**
  * Delete a Logstash pipeline.
- *
  * Delete a pipeline that is used for Logstash Central Management.
+ * If the request succeeds, you receive an empty response with an appropriate status code.
  * @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
+ * @doc_id logstash-api-delete-pipeline
  * @ext_doc_id logstash-centralized-pipeline-management
  */
 export interface Request extends RequestBase {

diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts b/specification/logstash/get_pipeline/LogstashGetPipelineRequest.ts
@@ -22,12 +22,12 @@ import { Ids } from '@_types/common'
 
 /**
  * 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
+ * @doc_id logstash-api-get-pipeline
  * @ext_doc_id logstash-centralized-pipeline-management
  */
 export interface Request extends RequestBase {

diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineResponseExample1.yaml b/specification/logstash/get_pipeline/LogstashGetPipelineResponseExample1.yaml
@@ -0,0 +1,21 @@
+# summary:
+description: >
+  A successful response from `GET _logstash/pipeline/my_pipeline`.
+# type: "response"
+# response_code: 200
+value:
+  my_pipeline:
+    description: Sample pipeline for illustration purposes
+    last_modified: '2021-01-02T02:50:51.250Z'
+    pipeline_metadata:
+      type: logstash_pipeline
+      version: '1'
+    username: elastic
+    pipeline: 'input {}\n filter { grok {} }\n output {}'
+    pipeline_settings:
+      pipeline.workers: 1
+      pipeline.batch.size: 125
+      pipeline.batch.delay: 50
+      queue.type: memory
+      queue.max_bytes: 1gb
+      queue.checkpoint.writes: 1024
diff --git a/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts b/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts
@@ -30,6 +30,7 @@ import { Id } from '@_types/common'
  * @availability stack since=7.12.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_logstash_pipelines
+ * @doc_id logstash-api-put-pipeline
  * @ext_doc_id logstash-centralized-pipeline-management
  */
 export interface Request extends RequestBase {

diff --git a/specification/logstash/put_pipeline/LogstashPutPipelineRequestExample1.yaml b/specification/logstash/put_pipeline/LogstashPutPipelineRequestExample1.yaml
@@ -0,0 +1,19 @@
+summary: Create a pipeline
+# method_request: PUT _logstash/pipeline/my_pipeline
+description: Run `PUT _logstash/pipeline/my_pipeline` to create a pipeline.
+# type: request
+value:
+  description: Sample pipeline for illustration purposes
+  last_modified: '2021-01-02T02:50:51.250Z'
+  pipeline_metadata:
+    type: logstash_pipeline
+    version: 1
+  username: elastic
+  pipeline: 'input {}\n filter { grok {} }\n output {}'
+  pipeline_settings:
+    pipeline.workers: 1
+    pipeline.batch.size: 125
+    pipeline.batch.delay: 50
+    queue.type: memory
+    queue.max_bytes: 1gb
+    queue.checkpoint.writes: 1024