summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/mpercolate.json
blob: 4bf559acf5ae30797790d7e8abfbad59af021e4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "mpercolate": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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": {
        "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"],
          "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"
    }
  }
}