From c274a36d342584d1f9580ca961514194d21f18df Mon Sep 17 00:00:00 2001
From: Karel Minarik <karel.minarik@elasticsearch.org>
Date: Mon, 27 May 2013 22:04:06 +0200
Subject: [PATCH] Added the API definition for `_validate/query`
---
rest-api-spec/api/indices.validate.query.json | 20 ++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/rest-api-spec/api/indices.validate.query.json b/rest-api-spec/api/indices.validate.query.json
index a9e674f8860..03cf305e557 100644
--- a/rest-api-spec/api/indices.validate.query.json
+++ b/rest-api-spec/api/indices.validate.query.json
@@ -1,32 +1,42 @@
{
"indices.validate.query": {
- "documentation": "",
+ "documentation": "http://www.elasticsearch.org/guide/reference/api/validate/",
"methods": ["GET", "POST"],
"url": {
"path": "/_validate/query",
"paths": ["/_validate/query", "/{index}/_validate/query", "/{index}/{type}/_validate/query"],
"parts": {
"index": {
+ "type" : "list",
+ "description" : "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"
},
"type": {
+ "type" : "list",
+ "description" : "A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types"
}
},
"params": {
"explain": {
+ "type" : "boolean",
+ "description" : "Return detailed information about the error"
},
"ignore_indices": {
- },
- "index": {
+ "type" : "enum",
+ "options" : ["none","missing"],
+ "default" : "none",
+ "description" : "When performed on multiple indices, allows to ignore `missing` ones"
},
"operation_threading": {
+ "description" : "TODO: ?"
},
"source": {
- },
- "type": {
+ "type" : "string",
+ "description" : "The URL-encoded query definition (instead of using the request body)"
}
}
},
"body": {
+ "description" : "The query definition"
}
}
}