SubList function documentation#9718
Conversation
* Sublist function documentation Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com>
|
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. |
|
@graytaylor0 please review my documentation for sublist PR opensearch-project/data-prepper#5535 |
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@charan2628, @graytaylor0, and @dlvenable: I added my edits to this page, breaking up the examples and offering additional explanations. Let me know if these changes work for you. |
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
graytaylor0
left a comment
There was a problem hiding this comment.
This looks good! I see that this PR is not merged yet (opensearch-project/data-prepper#5535). We need to rebase this and merge it on data prepper side.
| The `subList()` function extracts a sublist from a list field in an event. It takes the following arguments: | ||
|
|
||
| An end index value of -1, could signal to extract from start_index to the end of the list. | ||
| - A JSON pointer to a list field in the event |
There was a problem hiding this comment.
Do you think this is more clear? A JSON pointer to a field in the event that contains a list value
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @charan2628! Please see my comments and let me know if you have any questions.
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
* SubList function documentation * Sublist function documentation Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com> * Add writer edits. Break up examples. Use function in pipeline. Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _data-prepper/pipelines/sublist.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit a2dd9ba) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* SubList function documentation * Sublist function documentation Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com> * Add writer edits. Break up examples. Use function in pipeline. Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _data-prepper/pipelines/sublist.md Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Arya Soni <aryasoni98@gmail.com>
Description
Documentation for new sublist function opensearch-project/data-prepper#5535 .
Issues Resolved
Closes #[delete this text, including the brackets, and replace with the issue number]
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.