rest-api-spec.api.field_caps.json Maven / Gradle / Ivy

Go to download
{
  "field_caps":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html",
      "description":"Returns the information about the capabilities of fields among multiple indices."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_field_caps",
          "methods":[
            "GET",
            "POST"
          ]
        },
        {
          "path":"/{index}/_field_caps",
          "methods":[
            "GET",
            "POST"
          ],
          "parts":{
            "index":{
              "type":"list",
              "description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
            }
          }
        }
      ]
    },
    "params":{
      "fields":{
        "type":"list",
        "description":"A comma-separated list of field names"
      },
      "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",
          "hidden",
          "none",
          "all"
        ],
        "default":"open",
        "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
      },
      "include_unmapped":{
        "type":"boolean",
        "default":false,
        "description":"Indicates whether unmapped fields should be included in the response."
      },
      "filters": {
        "type":"list",
        "description":"An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent"
      },
      "types": {
        "type": "list",
        "description":"Only return results for fields that have one of the types in the list"
      },
      "include_empty_fields": {
        "type":"boolean",
        "default": true,
        "description":"Include empty fields in result"
      }
    },
    "body":{
      "description":"An index filter specified with the Query DSL"
    }
  }
}