Include global query string parameters in the REST spec

Closes #11638
This commit is contained in:
Greg Marzouka 2017-01-11 14:41:06 -05:00
parent 401438819e
commit e0f8d88d5c
1 changed files with 29 additions and 0 deletions

View File

@ -0,0 +1,29 @@
{
"description": "Parameters that are accepted by all API endpoints.",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html",
"params": {
"pretty": {
"type": "boolean",
"description": "Pretty format the returned JSON response.",
"default": false
},
"human": {
"type": "boolean",
"description": "Return human readable values for statistics.",
"default": true
},
"error_trace": {
"type": "boolean",
"description": "Include the stack trace of returned errors.",
"default": false
},
"source": {
"type": "string",
"description": "The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests."
},
"filter_path": {
"type": "string",
"description": "A comma-separated list of filters used to reduce the respone."
}
}
}