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

{
  "percolate": {
    "documentation": "http://elasticsearch.org/guide/reference/api/percolate/",
    "methods": ["GET", "POST"],
    "url": {
      "path": "/{index}/{type}/_percolate",
      "paths": ["/{index}/{type}/_percolate"],
      "parts": {
        "index": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the index with a registered percolator query"
        },
        "type": {
          "type" : "string",
          "required" : true,
          "description" : "The document type"
        }
      },
      "params": {
        "prefer_local": {
          "type" : "boolean",
          "description" : "With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)"
        }
      }
    },
    "body": {
      "description" : "The document (`doc`) to percolate against registered queries; optionally also a `query` to limit the percolation to specific registered queries",
      "required" : true
    }
  }
}