From e0f8d88d5cb5548ed7a2d247d3cbb9bb6c9ca5bc Mon Sep 17 00:00:00 2001 From: Greg Marzouka Date: Wed, 11 Jan 2017 14:41:06 -0500 Subject: [PATCH] Include global query string parameters in the REST spec Closes #11638 --- .../resources/rest-api-spec/api/_common.json | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 rest-api-spec/src/main/resources/rest-api-spec/api/_common.json diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/_common.json b/rest-api-spec/src/main/resources/rest-api-spec/api/_common.json new file mode 100644 index 00000000000..fec522be4a1 --- /dev/null +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/_common.json @@ -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." + } + } +}