opensearch-project / opensearch-py

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

Updated APIs to match other language clients and opensearch openapi spec #502

Closed saimedhi closed 1 year ago

saimedhi commented 1 year ago

Description

Updated APIs to match other language clients and opensearch openapi spec. APIs added to "_patch" are manually written. Other APIs added are Generated using openapispec.

Deprecated APIs: They are moved into client/_patch.py list_all_point_in_time, create_point_in_time, health_check, update_audit_config, delete_point_in_time

Newly Added APIs: They are moved into corresponding namespaces get_all_pits, create_pit, health, update_audit_configuration, delete_all_pits, delete_pit

Issues Resolved

Closes #499, #500, #501

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.

codecov[bot] commented 1 year ago

Codecov Report

Merging #502 (77cd26a) into main (c8b04a5) will decrease coverage by 0.06%. Report is 2 commits behind head on main. The diff coverage is 70.73%.

@@            Coverage Diff             @@
##             main     #502      +/-   ##
==========================================
- Coverage   70.92%   70.86%   -0.06%     
==========================================
  Files          81       83       +2     
  Lines        7732     7796      +64     
==========================================
+ Hits         5484     5525      +41     
- Misses       2248     2271      +23     
Files Changed Coverage Δ
opensearchpy/_async/client/_patch.py 46.15% <46.15%> (ø)
opensearchpy/_async/client/__init__.py 44.24% <72.72%> (+0.28%) :arrow_up:
opensearchpy/client/_patch.py 76.92% <76.92%> (ø)
opensearchpy/client/__init__.py 60.79% <90.90%> (+0.35%) :arrow_up:
opensearchpy/_async/client/security.py 43.98% <100.00%> (+0.26%) :arrow_up:
opensearchpy/client/security.py 43.98% <100.00%> (+0.26%) :arrow_up:
saimedhi commented 1 year ago

Hi @florianvazelle, I would greatly appreciate it if you could kindly review this PR and share your feedback whenever it's convenient for you. Thank you!

saimedhi commented 1 year ago

This looks great! Can we also start adding the generation details in a markdown file? For example, what the patch file is supposed to be? How the generator works etc? I see there is already https://github.com/opensearch-project/opensearch-py/blob/main/DEVELOPER_GUIDE.md#running-python-client-generator

@VachaShah, I'll include these details in my upcoming PR. I'll create a markdown file explaining the generator's functionality and the client structure, including what's placed in patch files. You can find most of the information here, and I'll ensure it's added to the repository soon.

saimedhi commented 1 year ago

@VachaShah, Shall we merge this