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

Adds documentation for providing search pipeline id in the search/msearch request #8372

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

owaiskazi19
Copy link
Member

@owaiskazi19 owaiskazi19 commented Sep 24, 2024

Description

Added support for msearch API to pass search pipeline name.
With this change a search pipeline name can be provided while making a msearch call

{ "index": "test"}
{ "query": { "match_all": {} }, "from": 0, "size": 10, "search_pipeline": "my_pipeline"}
{ "index": "test-1", "search_type": "dfs_query_then_fetch"}
{ "query": { "match_all": {} }, "search_pipeline": "my_pipeline1" }

Issues Resolved

opensearch-project/OpenSearch#15923

Version

2.18

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.

Copy link

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.

Signed-off-by: Owais <owaiskazi19@gmail.com>
@kolchfa-aws
Copy link
Collaborator

@owaiskazi19 Is this for 2.18?

@owaiskazi19
Copy link
Member Author

@owaiskazi19 Is this for 2.18?

Yes @kolchfa-aws. Here is the backport PR opensearch-project/OpenSearch#16085. Once this gets merged it will be ready for 2.18

}
```

or for msearch
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't know that this is a true "pattern", (and if it is we should have Vale enforce it), but in other places in the docs I see it referred to as "multi-search". For example I see "All multi-search URL parameters are optional.".

Suggested change
or for msearch
or for multi-search:

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

Thank you, @owaiskazi19!

@kolchfa-aws kolchfa-aws added v2.18.0 release-notes PR: Include this PR in the automated release notes labels Sep 26, 2024
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 kolchfa-aws merged commit a6a3396 into opensearch-project:main Sep 26, 2024
9 checks passed
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
…arch request (opensearch-project#8372)

* Adds documentation for providing search pipeline id in the request

Signed-off-by: Owais <owaiskazi19@gmail.com>

* Doc review

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

---------

Signed-off-by: Owais <owaiskazi19@gmail.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants