Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document '_name' field in 'function_score' query's function definition #7340

Merged
merged 9 commits into from
Jul 9, 2024

Conversation

lrynek
Copy link
Contributor

@lrynek lrynek commented Jun 9, 2024

Description

Document _name field in function_score query's function definition introduced in opensearch-project/OpenSearch#1711 and demanded in the issue #432

Issues Resolved

Closes #432

Version

All versions.

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: Łukasz Rynek <lukasz.rynek@gmail.com>
@hdhalter
Copy link
Contributor

@lrynek - Let us know when the content is ready for review. Perhaps @reta can do a tech review? I've added @kolchfa-aws as the doc lead who can help with the review process. Thanks!

lrynek and others added 4 commits July 3, 2024 17:14
Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
@lrynek
Copy link
Contributor Author

lrynek commented Jul 4, 2024

@hdhalter @kolchfa-aws @reta Thanks for your patience - I've finally found a spare moment to install the latest OpenSearch (2.15.1) on my machine to prepare real blogs index instance and run a function_score query with named functions to provide precise request/response JSONs for the examples part of the section in the documentation. Please take a look. I'm open for any feedback here 👍🏻

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Jul 5, 2024
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thanks so much, @lrynek! Just a couple of comments, and we'll be ready to put the PR through editorial review and then merge.

_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
lrynek and others added 2 commits July 6, 2024 13:14
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>
@lrynek
Copy link
Contributor Author

lrynek commented Jul 7, 2024

Thanks so much, @lrynek! Just a couple of comments, and we'll be ready to put the PR through editorial review and then merge.

@kolchfa-aws ✅ Everything applied, thank you for a thorough review👌🏻

Copy link
Collaborator

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

@kolchfa-aws @lrynek Please see my changes and let me know if you have any questions. Thanks!

_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
_query-dsl/compound/function-score.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>
@lrynek
Copy link
Contributor Author

lrynek commented Jul 9, 2024

@kolchfa-aws @lrynek Please see my changes and let me know if you have any questions. Thanks!

@natebower LGTM - I've just implemented your suggestions 👍🏻

@lrynek lrynek requested a review from natebower July 9, 2024 16:38
Copy link
Collaborator

@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

@kolchfa-aws kolchfa-aws merged commit b0ebb50 into opensearch-project:main Jul 9, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 9, 2024
#7340)

* Document '_name' field in 'function_score' query function definition

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real request JSON payload

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real response JSON payload + finish the paragraph

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing copy-curl tag

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing article

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

---------

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@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 b0ebb50)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
opensearch-project#7340)

* Document '_name' field in 'function_score' query function definition

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real request JSON payload

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real response JSON payload + finish the paragraph

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing copy-curl tag

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing article

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

---------

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@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: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
opensearch-project#7340)

* Document '_name' field in 'function_score' query function definition

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real request JSON payload

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Ensure real response JSON payload + finish the paragraph

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing copy-curl tag

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Add missing article

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@users.noreply.github.com>

---------

Signed-off-by: Łukasz Rynek <lukasz.rynek@gmail.com>
Signed-off-by: Łukasz Rynek <36886649+lrynek@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: Sander van de Geijn <sandervandegeijn@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.15
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Document '_name' field in 'function_score' query function definition and in explanation response
5 participants