Add Data Stream API reference - #12912
Conversation
…own directory, similar to the alias API. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc 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). |
Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
|
|
||
| | Parameter | Required | Data type | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `name` | **Required** | String | Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `\|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. | |
There was a problem hiding this comment.
@dwelsch-esi Please include articles in the description ("the name of the data stream"). Also, please punctuate and capitalize correctly and rewrite for clarity. Whenever possible, use existing established phrasing for parameter descriptions.
| | Field | Data type | Description | | ||
| | :--- | :--- | :--- | | ||
| | `data_streams` | Array | A list of objects, one for each data stream. | | ||
| | `data_streams[n].name` | String | The name of the data stream. | |
There was a problem hiding this comment.
Don't use array notation in the response body fields table. Create a separate table for array elements and add an intro sentence for that, then use the parameter names directly in that new table (timestamp_field, etc.)
| | :--- | :--- | :--- | :--- | | ||
| | `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 | | ||
| | `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.
Don't use curly apostrophes. Use only plain apostrophe characters (Markdown ones). Replace all these.
| | `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` | | ||
| | `source` | String | The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. | N/A | |
There was a problem hiding this comment.
This parameter comes up as not supported for me. Could you provide an example request and example response that show that it works?
| | :--- | :--- | :--- | :--- | | ||
| | `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.
We don't include 'error_trace', 'filter_path', 'human', or 'pretty' in the query parameter tables. They are listed in the "common parameters" topic. error_trace is used for debugging and is not a meaningful parameter here, human doesn't change the output for this API (the response is just an ack) so it shouldn't be listed as it's no-op, and filter_path is not needed because the response is trivial.
kolchfa-aws
left a comment
kolchfa-aws
left a comment
There was a problem hiding this comment.
@dwelsch-esi Please see my comments and apply to all files.
kolchfa-aws
added
Doc review
2 participants
Add missing Data Stream API. Include as part of the Index API in its own directory, similar to the alias API.
Description
Adds missing API to the OpenSearch API reference documentation.
Version
Checklist