OpenSearch/rest-api-spec/api/indices.put_mapping.json

{
  "indices.put_mapping": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-put-mapping.html",
    "methods": ["PUT", "POST"],
    "url": {
      "path": "/{index}/{type}/_mapping",
      "paths": ["/{index}/{type}/_mapping", "/{index}/_mapping/{type}", "/_mapping/{type}", "/{index}/{type}/_mappings", "/{index}/_mappings/{type}", "/_mappings/{type}"],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices."
        },
        "type": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the document type"
        }
      },
      "params": {
        "ignore_conflicts": {
          "type" : "boolean",
          "description" : "Specify whether to ignore conflicts while updating the mapping (default: false)"
        },
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        },
        "master_timeout": {
          "type" : "time",
          "description" : "Specify timeout for connection to master"
        },
        "ignore_unavailable": {
          "type" : "boolean",
          "description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
        },
        "allow_no_indices": {
          "type" : "boolean",
          "description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
        },
        "expand_wildcards": {
          "type" : "enum",
          "options" : ["open","closed","none","all"],
          "default" : "open",
          "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
        }
      }
    },
    "body": {
      "description" : "The mapping definition",
      "required" : true
    }
  }
}