OpenSearch/rest-api-spec/api/mpercolate.json

{
  "mpercolate": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html",
    "methods": ["GET", "POST"],
    "url": {
      "path": "/_mpercolate",
      "paths": ["/_mpercolate", "/{index}/_mpercolate", "/{index}/{type}/_mpercolate"],
      "parts": {
        "index": {
          "type": "string",
          "description": "The index of the document being count percolated to use as default"
        },
        "type": {
          "type" : "string",
          "description" : "The type of the document being percolated to use as default."
        }
      },
      "params": {
        "source": {
          "type" : "string",
          "description" : "The URL-encoded request definition"
        },
        "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 percolate request definitions (header & body pair), separated by newlines",
      "required": true,
      "serialize" : "bulk"
    }
  }
}