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

Added .NET client API guide for the Search API. #394

Merged
merged 1 commit into from
Oct 18, 2023

Conversation

Djcarrillo6
Copy link
Contributor

Description

This PR provides add the API guide on using OpenSearch.NET client to implement the OpenSearch "Search API".

  • Setup: Demonstrates how to configure the connection to the OpenSearch instance running locally on port 9200.
  • Scaffold an index & Add Documents: Shows how to create a "movies" index, define a data model, index multiple documents, and refresh the index.
  • Basic Search: Illustrates how to execute a match-all query on the "movies" index and a match query to find documents related to the query "Avengers".
  • Pagination: Showcases how to paginate search results using from and size parameters within a search query.
  • Sorting: Provides a guide on using the "search_after" parameter to sort and paginate search results and display multiple pages of results.
  • Scroll API: Demonstrates how to use the scroll API for retrieving large number of documents that match a specified query.
  • Cleanup: Describes how to delete the "movies" index once operations are complete.

Issues Resolved

Resolves issue #189

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

Copy link
Collaborator

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

Generally looks good @Djcarrillo6! Just some suggestions mainly around conciseness of the code, and changing the example data to match the ruby guide

guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

Just a last couple nit picks

guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
guides/search.md Outdated Show resolved Hide resolved
Signed-off-by: Djcarrillo6 <[email protected]>

Fix setup section in guide.

Signed-off-by: Djcarrillo6 <[email protected]>

Minor updates to search.md

Signed-off-by: Djcarrillo6 <[email protected]>

Added requested changes to search.md

Signed-off-by: Djcarrillo6 <[email protected]>

Added requested changes to search.md opensearch-project#2

Signed-off-by: Djcarrillo6 <[email protected]>

Added requested changes to search.md opensearch-project#3

Signed-off-by: Djcarrillo6 <[email protected]>
@Xtansia Xtansia merged commit b014ff4 into opensearch-project:main Oct 18, 2023
33 of 36 checks passed
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.

2 participants