Skip to content

Commit 5d8d29d

Browse files
authored
[DOCS] Add request body parameters to put Logstash pipeline API docs (#69151) (#69699)
1 parent ebc06c8 commit 5d8d29d

File tree

4 files changed

+69
-20
lines changed

4 files changed

+69
-20
lines changed

x-pack/docs/en/rest-api/logstash/delete-pipeline.asciidoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[logstash-api-delete-pipeline]]
4-
=== Delete Pipeline API
4+
=== Delete {ls} pipeline API
5+
++++
6+
<titleabbrev>Delete {ls} pipeline</titleabbrev>
7+
++++
58

6-
This API deletes Pipelines used for Logstash Central Management.
9+
This API deletes a pipeline used for
10+
{logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
11+
Management].
712

813
[[logstash-api-delete-pipeline-request]]
914
==== {api-request-title}
@@ -19,7 +24,7 @@ This API deletes Pipelines used for Logstash Central Management.
1924
[[logstash-api-delete-pipeline-desc]]
2025
==== {api-description-title}
2126

22-
Delete a Logstash Pipelines.
27+
Deletes a {ls} pipeline.
2328

2429
[[logstash-api-delete-pipeline-params]]
2530
==== {api-path-parms-title}

x-pack/docs/en/rest-api/logstash/get-pipeline.asciidoc

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[logstash-api-get-pipeline]]
4-
=== Get Pipeline API
4+
=== Get pipeline API
5+
++++
6+
<titleabbrev>Get {ls} pipeline</titleabbrev>
7+
++++
58

6-
This API retrieves Pipelines used for Logstash Central Management.
9+
This API retrieves pipelines used for
10+
{logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
11+
Management].
712

813
[[logstash-api-get-pipeline-request]]
914
==== {api-request-title}
@@ -21,26 +26,26 @@ This API retrieves Pipelines used for Logstash Central Management.
2126
[[logstash-api-get-pipeline-desc]]
2227
==== {api-description-title}
2328

24-
Retrieve one or more Logstash Pipelines.
29+
Retrieve one or more {ls} pipelines.
2530

2631
[[logstash-api-get-pipeline-params]]
2732
==== {api-path-parms-title}
2833

2934
`<pipeline_id>`::
30-
(Optional, string) Comma-separated list of Pipeline identifiers.
35+
(Optional, string) Comma-separated list of pipeline identifiers.
3136

3237
[[logstash-api-get-pipeline-example]]
3338
==== {api-examples-title}
3439

35-
The following example retrieves the Pipeline named `my_pipeline`:
40+
The following example retrieves the pipeline named `my_pipeline`:
3641

3742
//////////////////////////
3843
3944
[source,console]
4045
--------------------------------------------------
4146
PUT _logstash/pipeline/my_pipeline
4247
{
43-
"description": "Sample Pipeline for illustration purposes",
48+
"description": "Sample pipeline for illustration purposes",
4449
"last_modified": "2021-01-02T02:50:51.250Z",
4550
"pipeline_metadata": {
4651
"type": "logstash_pipeline",
@@ -69,13 +74,13 @@ GET _logstash/pipeline/my_pipeline
6974
// TEST[continued]
7075

7176

72-
If the request succeeds, the body of the response contains the Pipeline definition:
77+
If the request succeeds, the body of the response contains the pipeline definition:
7378

7479
[source,console-result]
7580
--------------------------------------------------
7681
{
7782
"my_pipeline": {
78-
"description": "Sample Pipeline for illustration purposes",
83+
"description": "Sample pipeline for illustration purposes",
7984
"last_modified": "2021-01-02T02:50:51.250Z",
8085
"pipeline_metadata": {
8186
"type": "logstash_pipeline",

x-pack/docs/en/rest-api/logstash/index.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
[role="xpack"]
22
[[logstash-apis]]
3-
== Logstash APIs
3+
== {ls} APIs
44

5-
The following APIs are used to manage Pipelines used by Logstash Central
6-
Management:
5+
The following APIs are used to manage pipelines used by
6+
{logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
7+
Management]:
78

89
* <<logstash-api-put-pipeline>>
910
* <<logstash-api-get-pipeline>>

x-pack/docs/en/rest-api/logstash/put-pipeline.asciidoc

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[logstash-api-put-pipeline]]
4-
=== Put Pipeline API
4+
=== Put {ls} pipeline API
5+
++++
6+
<titleabbrev>Put {ls} pipeline</titleabbrev>
7+
++++
58

6-
This API creates or updates Pipelines used for Logstash Central Management.
9+
This API creates or updates a {ls} pipeline used for
10+
{logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
11+
Management].
712

813
[[logstash-api-put-pipeline-request]]
914
==== {api-request-title}
@@ -19,25 +24,58 @@ This API creates or updates Pipelines used for Logstash Central Management.
1924
[[logstash-api-put-pipeline-desc]]
2025
==== {api-description-title}
2126

22-
Creates a Logstash Pipeline. If the specified Pipeline exists, the pipeline is
27+
Creates a {ls} pipeline. If the specified pipeline exists, the pipeline is
2328
replaced.
2429

2530
[[logstash-api-put-pipeline-params]]
2631
==== {api-path-parms-title}
2732

2833
`<pipeline_id>`::
29-
(Required, string) Identifier for the Pipeline.
34+
(Required, string) Identifier for the pipeline.
35+
36+
[[logstash-api-put-pipeline-request-body]]
37+
==== {api-request-body-title}
38+
39+
`description`::
40+
(Optional, string)
41+
Description of the pipeline. This description is not used by {es} or {ls}.
42+
43+
`last_modified`::
44+
(Required, string)
45+
Date the pipeline was last updated. Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ`
46+
<<mapping-date-format,`strict_date_time`>> format.
47+
48+
`pipeline`::
49+
(Required, string)
50+
Configuration for the pipeline. For supported syntax, see the
51+
{logstash-ref}/configuration-file-structure.html[{ls} configuration
52+
documentation].
53+
54+
`pipeline_metadata`::
55+
(Required, object)
56+
Optional metadata about the pipeline. May have any contents. This metadata is
57+
not generated or used by {es} or {ls}.
58+
59+
`pipeline_settings`::
60+
(Required, object)
61+
Settings for the pipeline. Supports only flat keys in dot notation. For
62+
supported settings, see the {logstash-ref}/logstash-settings-file.html[{ls}
63+
settings documentation].
64+
65+
`username`::
66+
(Required, string)
67+
User who last updated the pipeline.
3068

3169
[[logstash-api-put-pipeline-example]]
3270
==== {api-examples-title}
3371

34-
The following example creates a new Pipeline named `my_pipeline`:
72+
The following example creates a new pipeline named `my_pipeline`:
3573

3674
[source,console]
3775
--------------------------------------------------
3876
PUT _logstash/pipeline/my_pipeline
3977
{
40-
"description": "Sample Pipeline for illustration purposes",
78+
"description": "Sample pipeline for illustration purposes",
4179
"last_modified": "2021-01-02T02:50:51.250Z",
4280
"pipeline_metadata": {
4381
"type": "logstash_pipeline",

0 commit comments

Comments
 (0)