adding data_stream stats api docs #10144
Open
+142
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Anton Rubin <[email protected]>
AntonEliatra
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Anton Rubin <[email protected]>
|
@kolchfa-aws thats now ready for review |
kolchfa-aws
reviewed
Jun 27, 2025
There was a problem hiding this comment.
Thank you, @AntonEliatra! Please see my comments and let me know if you have any questions.
| | Parameter | Data type | Description | Default | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `error_trace` | Boolean | Whether to include the stack trace of returned errors. | `false` | | ||
| | `filter_path` | List or String | Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". | N/A | |
There was a problem hiding this comment.
Suggested change
| | `filter_path` | List or String | Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". | N/A | | |
| | `filter_path` | List or String | A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`. | N/A | |
| | :--- | :--- | :--- | :--- | | ||
| | `error_trace` | Boolean | Whether to include the stack trace of returned errors. | `false` | | ||
| | `filter_path` | List or String | Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". | N/A | | ||
| | `human` | Boolean | Whether to return human readable values for statistics. | `false` | |
There was a problem hiding this comment.
Suggested change
| | `human` | Boolean | Whether to return human readable values for statistics. | `false` | | |
| | `human` | Boolean | Whether to return human-readable values for statistics. | `false` | |
| | `error_trace` | Boolean | Whether to include the stack trace of returned errors. | `false` | | ||
| | `filter_path` | List or String | Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". | N/A | | ||
| | `human` | Boolean | Whether to return human readable values for statistics. | `false` | | ||
| | `pretty` | Boolean | Whether to pretty format the returned JSON response. | `false` | |
There was a problem hiding this comment.
Suggested change
| | `pretty` | Boolean | Whether to pretty format the returned JSON response. | `false` | | |
| | `pretty` | Boolean | Whether to pretty-format the returned JSON response. | `false` | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
adding data_stream stats api docs
Issues Resolved
Closes #2095
Version
all
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.