[FEATURE] Support for wait_for_completion flag in force merge API

[navneet1v]

Is your feature request related to a problem?

Currently the force merge api in the client waits for force_merge to get completed. But OpenSearch provides a way where if we pass wait_for_completion = true, it gives a task id and poll the task id to see if the force merge is completed or not.

What solution would you like?

Add the support for wait_for_completion flag in force merge api.

POST /hotels-index/_forcemerge?max_num_segments=1&wait_for_completion=true

What alternatives have you considered?

The only other way is to send Raw HTTP request, but the domain is backed with security creating raw HTTP request is very difficult and not feasible.

Do you have any additional context?

NA

[dblock]

@saimedhi What's the right way to bring this in with the new generated code?

[saimedhi]

@dblock To add 'wait_for_completion' parameter to the 'forcemerge' API in Python, one approach is through the Python Generator. For a more comprehensive solution, it's best to integrate this parameter into the OpenSearch OpenAPI spec, making it accessible across all language client libraries.

[dblock]

@saimedhi yes exactly, is there a walkthrough / dev guide of what to add where?

[nhtruong]

Yes we have a developer_guide on the api repo: https://github.com/opensearch-project/opensearch-api-specification/blob/main/DEVELOPER_GUIDE.md

[saimedhi]

@dblock, @nhtruong please transfer this issue to opensearch-api-specification. I don't have access to do it.

[navneet1v]

@saimedhi once this issue is moved there how long it will take for the attribute to be available in python client?

[saimedhi]

Hello @navneet1v,

• Once a PR is merged into the spec, we can generate and update the Python client whenever needed.
• If we directly add changes to the Python client, they may get overwritten when the generator runs. So, it's best to make the initial change in the spec.

If you're familiar with Smithy, consider contributing. This way, we can ensure our PR gets merged quickly.

[VachaShah]

The parameter has been added in the spec via PR #180. @saimedhi The python client can be regenerated to incorporate the changes.

[VachaShah]

Updated OpenAPI specs in #181