opensearch-project / opensearch-py

Python Client for OpenSearch
https://opensearch.org/docs/latest/clients/python/
Apache License 2.0
359 stars 178 forks source link

Added new guide & sample module for using index templates. #531

Closed Djcarrillo6 closed 1 year ago

Djcarrillo6 commented 1 year ago

Description:

Added a new guide for using index templates with the Python client.

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

Issues Resolved

Part of #351

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

Djcarrillo6 commented 1 year ago

@saimedhi I'm from the OSCI & this is my first time contributing to this repo. I was originally assigned to the .NET client, however after seeing you comment in the #osci-client channel regarding there being many good first issues open on the Python client repo, I requested & received assignment on this issue.

I believe my commit only has the four added/modified files associated with the new guide, however this test is referencing a package vulnerability even though I didn't modify anything directly outside of the files in my commit. Can you advise me on how to resolve the issue that caused the WhiteSource Security Check to fail?

codecov[bot] commented 1 year ago

Codecov Report

Merging #531 (b450075) into main (ce835fb) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #531   +/-   ##
=======================================
  Coverage   70.72%   70.72%           
=======================================
  Files          83       83           
  Lines        7852     7852           
=======================================
  Hits         5553     5553           
  Misses       2299     2299           
Djcarrillo6 commented 1 year ago

@dblock I have made the changes you suggested. Is there anything else you'd like me to address?

saimedhi commented 1 year ago

@saimedhi I'm from the OSCI & this is my first time contributing to this repo. I was originally assigned to the .NET client, however after seeing you comment in the #osci-client channel regarding there being many good first issues open on the Python client repo, I requested & received assignment on this issue.

I believe my commit only has the four added/modified files associated with the new guide, however this test is referencing a package vulnerability even though I didn't modify anything directly outside of the files in my commit. Can you advise me on how to resolve the issue that caused the WhiteSource Security Check to fail?

Hello @Djcarrillo6,

The WhiteSource Security Check failure isn't related to this PR. However, you can work on that issue next if you prefer. We currently face an issue with the urllib3 version used by opensearch-py. To upgrade to the latest urllib3 version, we must remove end-of-life Python versions from this repository.

Relevant issues: #430

saimedhi commented 1 year ago

@Djcarrillo6, sorry 1 final change required as mentioned above please add changelog entry in unreleased added section. Not in 2.0.1

Djcarrillo6 commented 1 year ago

@saimedhi Moved my CHANGELOG entry to unreleased section

saimedhi commented 1 year ago

@Djcarrillo6,

If you're interested in fixing the detected security vulnerability, it's a straightforward process. To bump urllib3 to the latest version, simply remove Python version 3.5 from noxfile.py and .github/workflows/test.yml. Before that just comment on this issue #430 saying removing end of life python version because of security vulnerability. You can follow this PR for guidance on the urllib3 upgrade.

Thank you.