Skip to content

[FEATURE] Add Support for ISM Simulate Policy API #1151

Description

@Tarun-kishore

Is your feature request related to a problem?

The ISM API lacks a machine-readable specification for the new Simulate Policy endpoint (POST /_plugins/_ism/simulate) introduced in OpenSearch 3.7. Without this, client generators, API explorers, and validation tooling have no knowledge of the endpoint's request/response contract.

What solution would you like?

Add the ism.simulate_policy operation to the OpenSearch API specification:

  • spec/namespaces/ism.yaml — new POST /_plugins/_ism/simulate path with request body and response components following the existing ISM namespace conventions
  • spec/schemas/ism._common.yaml — four new schemas: SimulatePolicyRequest, SimulatePolicyResponse, IndexSimulateResult, and TransitionSimulateResult
  • tests/default/ism/simulate.yaml — test story covering three scenarios: simulate with a stored policy, simulate with an inline policy, and simulate against a non-existent index

Do you have any additional context?

Simulate API was added in index-management plugin as part of this issue: opensearch-project/index-management#1620

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions