search

opensearch-project / opensearch-py

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

[FEATURE] Deprecate hand-coded index_management in favor of auto-generated ism. #831

Open dblock opened 2 days ago

dblock commented 2 days ago

Is your feature request related to a problem?

Coming from https://github.com/opensearch-project/opensearch-py/pull/830, the OpenSearch API spec has added ISM in https://github.com/opensearch-project/opensearch-api-specification/pull/568. However opensearch-py already has index_management (different name) and the auto-generated implementation is not compatible because it re-orders body and index parameters.

What solution would you like?

  1. Add support for reordering parameters in api generator and swap index and body in the case of ISM for backwards-compat.
  2. Deprecate IndexManagementClient and implement it by inheriting auto-generated IsmClient instead.

What alternatives have you considered?

A breaking change where we delete IndexManagementClient and use the generated IsmClient.