Updated APIs to match other language clients and opensearch openapi spec #502
Conversation
saimedhi
requested review from
VachaShah,
dblock,
harshavamsi,
axeoman,
deztructor,
Shephalimittal and
florianvazelle
as code owners
Codecov Report
@@ 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
|
saimedhi
force-pushed
the
merge-gen-client-final
branch
2 times, most recently
from
a99619c to
3fc5b16
Compare
|
|
||
|
|
||
| @query_params() | ||
| async def list_all_point_in_time(self, params=None, headers=None): |
There was a problem hiding this comment.
What is the purpose of moving these APIs to patch file? Is the patch file going to be a place for all manual APIs?
| @@ -1955,64 +1961,66 @@ async def get_script_languages(self, params=None, headers=None): | |||
| "GET", "/_script_language", params=params, headers=headers | |||
| ) | |||
|
|
|||
| @query_params() | |||
| async def list_all_point_in_time(self, params=None, headers=None): | |||
| async def create_pit(self, index, params=None, headers=None): | |||
There was a problem hiding this comment.
Are these APIs generated or manually written?
saimedhi
force-pushed
the
merge-gen-client-final
branch
from
3fc5b16 to
20fb3f2
Compare
Signed-off-by: saimedhi <[email protected]>
saimedhi
force-pushed
the
merge-gen-client-final
branch
from
20fb3f2 to
77cd26a
Compare
|
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! |
There was a problem hiding this comment.
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. |
|
@VachaShah, Shall we merge this |
…search-project#502) Signed-off-by: saimedhi <[email protected]> Signed-off-by: roma2023 <[email protected]>
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.