Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add request body parameters to put Logstash pipeline API docs #69151

Merged
merged 4 commits into from
Mar 1, 2021
Merged

[DOCS] Add request body parameters to put Logstash pipeline API docs #69151

merged 4 commits into from
Mar 1, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Feb 17, 2021

Fixes #69148

Additional changes:

  • Changes pipeline to lowercase
  • Adds links to the Centralized Pipeline Management docs
  • Adds title abbreviations

Preview

Request body parameters: https://elasticsearch_69151.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/logstash-api-put-pipeline.html#logstash-api-put-pipeline-request-body

@jrodewig jrodewig added >docs General docs changes v8.0.0 v7.12.0 labels Feb 17, 2021
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Feb 17, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig jrodewig changed the title [DOCS] Fix capitalization and formatting of Logstash pipeline API docs [DOCS] Add request body parameters to Put Logstash pipeline API docs Feb 17, 2021
@jrodewig jrodewig changed the title [DOCS] Add request body parameters to Put Logstash pipeline API docs [DOCS] Add request body parameters to put Logstash pipeline API docs Feb 17, 2021
@jrodewig jrodewig requested a review from jaymode February 17, 2021 22:14
@jrodewig jrodewig added the :Core/Infra/Core Core issues without another label label Feb 17, 2021
@elasticmachine elasticmachine added the Team:Core/Infra Meta label for core/infra team label Feb 17, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

Comment on lines 65 to 68
`username`::
(Required, string)
User who last updated the pipeline. This username is not generated or used by
{es} or {ls}.
Copy link
Contributor Author

@jrodewig jrodewig Feb 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This username is not generated or used by {es} or {ls}.

@jaymode Can you confirm this is the case? Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know, this is the case. @kaisecheng do you know of any uses of the username field?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaymode the username display in the pipeline table of central pipeline management, so it is used by Logstash
https://github.com/elastic/kibana/blob/master/x-pack/plugins/logstash/public/application/components/pipeline_list/pipelines_table.js#L59

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for confirming @kaisecheng. I removed the related sentence.

Copy link
Member

@jaymode jaymode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment on lines 65 to 68
`username`::
(Required, string)
User who last updated the pipeline. This username is not generated or used by
{es} or {ls}.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know, this is the case. @kaisecheng do you know of any uses of the username field?

@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/2

@elasticmachine run elasticsearch-ci/bwc

@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Core Core issues without another label >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v7.12.1 v7.13.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Put Logstash pipeline API docs are missing request body parameter definitions
6 participants