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 new guide for using index templates with the low-level client #393

Merged

Conversation

Djcarrillo6
Copy link
Contributor

Description

This file is a comprehensive guide on how to use index templates with the OpenSearch .NET client. It targets the OpenSearch.Net low-level client and provides a variety of examples that demonstrate how to create, retrieve, delete, and use index templates in different scenarios. The file also includes important notes on the state of both low & high level clients at the time it was written.

The key sections of the guide include:
• Setup: Instructions for setting up a connection to an OpenSearch server running on the local machine.
• Index Template API Actions: Details on how to interact with the Index Template API to create and use index templates that match certain patterns. It demonstrates scenarios of using single and multiple templates, and how template priority affects the settings applied.
• Composable Index Templates: Information about the newer type of template, composable index templates, which allow for composing multiple component templates into a final one.
• Get an Index Template: Guidance on how to retrieve specifications of a particular index template.
• Delete an Index Template: Steps to delete a specified index template.
• Cleanup: Demonstrates how to delete created indices and templates for clean-up.

The actual coding examples are in C#, involving the OpenSearch.Net client. Code blocks provided illustrate how various API actions like PutTemplateForAll, PutTemplateV2ForAll, PutComponentTemplate, GetTemplateForAll, and DeleteTemplateForAll are used. The guide should be updated in future when new features or methods become available in the high level OpenSearch client.

Issues Resolved

Part of #187

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.

Hi @Djcarrillo6, thanks for working on this!

I've just got some points for how to cleanup the code samples a bit, and make sure they're correct.

guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
@Djcarrillo6 Djcarrillo6 force-pushed the feat/guides-index-template branch from ac14a16 to f90cdf6 Compare October 12, 2023 01:21
@Djcarrillo6
Copy link
Contributor Author

Hi @Xtansia, thanks so much for the detailed suggestions! I believe I accepted each of your suggested changes but let me know if any are missing or if there is anything else you'd like me to change.

@Djcarrillo6 Djcarrillo6 requested a review from Xtansia October 13, 2023 03:00
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
guides/index-template.md Outdated Show resolved Hide resolved
Signed-off-by: Djcarrillo6 <[email protected]>

Added suggestiong from PR review

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

Accepted PR request changes.

Signed-off-by: Djcarrillo6 <[email protected]>
@Djcarrillo6 Djcarrillo6 force-pushed the feat/guides-index-template branch from f90cdf6 to b23be5d Compare October 16, 2023 04:12
@Djcarrillo6 Djcarrillo6 requested a review from Xtansia October 16, 2023 06:20
@Xtansia Xtansia merged commit ee61ac4 into opensearch-project:main Oct 16, 2023
2 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