Skip to content

SubList function documentation#9718

Merged
natebower merged 6 commits into
opensearch-project:mainfrom
charan2628:sublist-function-5529
Feb 3, 2026
Merged

SubList function documentation#9718
natebower merged 6 commits into
opensearch-project:mainfrom
charan2628:sublist-function-5529

Conversation

@charan2628

Copy link
Copy Markdown
  • Sublist function documentation

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

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

*  Sublist function documentation

Signed-off-by: Sai charan raj Gudala <s.charancherry22@gmail.com>
@github-actions

Copy link
Copy Markdown

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.

@charan2628

Copy link
Copy Markdown
Author

@graytaylor0 please review my documentation for sublist PR opensearch-project/data-prepper#5535

@Naarcha-AWS Naarcha-AWS added data-prepper Doc review PR: Doc review in progress Tech review PR: Tech review in progress and removed Doc review PR: Doc review in progress labels May 1, 2025
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS

Copy link
Copy Markdown
Contributor

@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.

@Naarcha-AWS Naarcha-AWS added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Jun 3, 2025
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS requested a review from sumobrian as a code owner July 8, 2025 13:16
@Naarcha-AWS Naarcha-AWS assigned dlvenable and unassigned Naarcha-AWS Jul 10, 2025
@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress and removed Doc review PR: Doc review in progress labels Oct 16, 2025

@graytaylor0 graytaylor0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Comment thread _data-prepper/pipelines/sublist.md Outdated
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do you think this is more clear? A JSON pointer to a field in the event that contains a list value

@kolchfa-aws kolchfa-aws left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, @charan2628! Please see my comments and let me know if you have any questions.

Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
Comment thread _data-prepper/pipelines/sublist.md Outdated
@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Oct 30, 2025
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned dlvenable Oct 30, 2025
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws kolchfa-aws added Editorial review and removed Doc review PR: Doc review in progress Awaiting response labels Feb 3, 2026
@kolchfa-aws kolchfa-aws assigned natebower and unassigned kolchfa-aws Feb 3, 2026
Comment thread _data-prepper/pipelines/sublist.md Outdated
Signed-off-by: Nathan Bower <nbower@amazon.com>

@natebower natebower left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@natebower natebower merged commit a2dd9ba into opensearch-project:main Feb 3, 2026
7 checks passed
opensearch-trigger-bot Bot pushed a commit that referenced this pull request Feb 3, 2026
* 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>
github-actions Bot pushed a commit that referenced this pull request Feb 3, 2026
aryasoni98 pushed a commit to aryasoni98/documentation-website that referenced this pull request Jun 29, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants