-
Notifications
You must be signed in to change notification settings - Fork 25.1k
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
Conversation
Pinging @elastic/es-docs (>docs) |
Pinging @elastic/es-core-features (:Core/Features/Ingest) |
@elasticmachine update branch |
There was a problem hiding this 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!
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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
The above request will return a response body containing a key-value | ||
representation of the built-in patterns dictionary sorted by key name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Documents the new sort option for the grok patterns endpoint added in #61671.