rest-api-spec.api.indices.simulate_template.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

OpenSearch subproject :rest-api-spec

The newest version!

{
  "indices.simulate_template":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/im-plugin/index-templates",
      "description": "Simulate resolving the given template name or body"
    },
    "stability":"experimental",
    "url":{
      "paths":[
        {
          "path":"/_index_template/_simulate",
          "methods":[
            "POST"
          ]
        },
        {
          "path":"/_index_template/_simulate/{name}",
          "methods":[
            "POST"
          ],
          "parts":{
            "name":{
              "type":"string",
              "description":"The name of the index template"
            }
          }
        }
      ]
    },
    "params":{
      "create":{
        "type":"boolean",
        "description":"Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one",
        "default":false
      },
      "cause":{
        "type":"string",
        "description":"User defined reason for dry-run creating the new template for simulation purposes",
        "default":false
      },
      "master_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to master node",
        "deprecated":{
          "version":"2.0.0",
          "description":"To support inclusive language, use 'cluster_manager_timeout' instead."
        }
      },
      "cluster_manager_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to cluster-manager node"
      }
    },
    "body":{
      "description":"New index template definition to be simulated, if no index template name is specified",
      "required":false
    }
  }
}