Skip to content

Update source field descriptions in update by query API#10278

Merged
natebower merged 2 commits intomainfrom
issue-9613
Jul 30, 2025
Merged

Update source field descriptions in update by query API#10278
natebower merged 2 commits intomainfrom
issue-9613

Conversation

@kolchfa-aws
Copy link
Copy Markdown
Collaborator

Closes #9613

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.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.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.

@kolchfa-aws
Copy link
Copy Markdown
Collaborator Author

@mgodwan Could you review this PR?

@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress backport 3.1 labels Jul 15, 2025
@kolchfa-aws
Copy link
Copy Markdown
Collaborator Author

@bharath-techie @dhwanilpatel Could either of you review this PR?

_source | String | Whether to include the `_source` field in the response.
_source_excludes | String | A comma-separated list of source fields to exclude from the response.
_source_includes | String | A comma-separated list of source fields to include in the response.
_source | String | Controls the parts of the document source available to the script and returned in the response. Excluded fields may be removed from the document if not reassigned in the script.
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.

parts of the document: possible to make this more clear? I find the word parts ambiguous. Like fields of the document source available?

Excluded fields may be removed from the document _source if not reassigned in the script?

_source_excludes | String | A comma-separated list of source fields to exclude from the response.
_source_includes | String | A comma-separated list of source fields to include in the response.
_source | String | Controls the parts of the document source available to the script and returned in the response. Excluded fields may be removed from the document if not reassigned in the script.
_source_excludes | String | A comma-separated list of source fields to exclude from the script context and the response. Excluded fields may be removed from the document unless explicitly preserved by the script.
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.

document _source? Is this more meaningful?

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws
Copy link
Copy Markdown
Collaborator Author

@sandeshkr419 Suggestions added. Could you take a look again?

@sandeshkr419 sandeshkr419 self-assigned this Jul 30, 2025
Copy link
Copy Markdown
Member

@sandeshkr419 sandeshkr419 left a comment

Choose a reason for hiding this comment

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

Thanks @kolchfa-aws for the making the changes, LGTM!

@kolchfa-aws kolchfa-aws added Editorial review and removed Tech review PR: Tech review in progress labels Jul 30, 2025
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

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 3555cda into main Jul 30, 2025
9 checks passed
@natebower natebower deleted the issue-9613 branch July 30, 2025 20:27
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 30, 2025
* Update source field descriptions in update by query API

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
(cherry picked from commit 3555cda)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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.

[DOC] Mistake in update by query API documentation

3 participants