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] Sort option for the grok patterns endpoint #62092

Merged
merged 4 commits into from
Sep 14, 2020

Conversation

danhermann
Copy link
Contributor

Documents the new sort option for the grok patterns endpoint added in #61671.

@danhermann danhermann added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP v8.0.0 v7.10.0 labels Sep 8, 2020
@danhermann danhermann requested a review from jrodewig September 8, 2020 12:35
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Ingest)

@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Data Management Meta label for data/management team labels Sep 8, 2020
@danhermann
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. I left some suggestions to reorder the sentences, avoid future tense, etc.
Feel free to disregard if wanted. Thanks!

Comment on lines 308 to 311
The request has an optional boolean parameter for returning the patterns sorted
by name. By default, the patterns are returned in the order they are read from
disk which preserves groupings of related patterns (e.g., all patterns
related to parsing Linux syslog lines).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The request has an optional boolean parameter for returning the patterns sorted
by name. By default, the patterns are returned in the order they are read from
disk which preserves groupings of related patterns (e.g., all patterns
related to parsing Linux syslog lines).
By default, the API returns patterns in the order they are read from disk. This
sort order preserves groupings of related patterns. For example, all patterns
related to parsing Linux syslog lines stay grouped together.
You can use the optional boolean `s` query parameter to sort returned patterns
by key name instead.

Comment on lines 318 to 319
The above request will return a response body containing a key-value
representation of the built-in patterns dictionary sorted by key name.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The above request will return a response body containing a key-value
representation of the built-in patterns dictionary sorted by key name.
The API returns the following response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.10.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants