[SPEC] Various API fixes

Including:
* change some string params to list
* make some params or bodies required
* removed incorrect URLs
* removed incorrect params
* Fixed name of pending_tasks
This commit is contained in:
Clinton Gormley 2014-01-20 11:03:03 +01:00
parent 20b37416e3
commit 67ec840d00
15 changed files with 21 additions and 16 deletions

View File

@ -50,7 +50,8 @@
} }
}, },
"body": { "body": {
"description" : "The operation definition and data (action-data pairs), separated by newlines" "description" : "The operation definition and data (action-data pairs), separated by newlines",
"required" : true
} }
} }
} }

View File

@ -8,6 +8,7 @@
"parts": { "parts": {
"scroll_id": { "scroll_id": {
"type" : "list", "type" : "list",
"required" : "true",
"description" : "A comma-separated list of scroll IDs to clear" "description" : "A comma-separated list of scroll IDs to clear"
} }
}, },

View File

@ -1,5 +1,5 @@
{ {
"cluster.tasks": { "cluster.pending_tasks": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html", "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html",
"methods": ["GET"], "methods": ["GET"],
"url": { "url": {

View File

@ -4,7 +4,7 @@
"methods": ["GET"], "methods": ["GET"],
"url": { "url": {
"path": "/_cluster/stats", "path": "/_cluster/stats",
"paths": ["/_cluster/stats", "/_cluster/stats/nodes/{nodeId}"], "paths": ["/_cluster/stats", "/_cluster/stats/nodes/{node_id}"],
"parts": { "parts": {
"node_id": { "node_id": {
"type" : "list", "type" : "list",

View File

@ -4,7 +4,7 @@
"methods": ["DELETE"], "methods": ["DELETE"],
"url": { "url": {
"path": "/{index}/_warmer/{name}", "path": "/{index}/_warmer/{name}",
"paths": ["/{index}/_warmer", "/{index}/_warmer/{name}", "/{index}/_warmers", "/{index}/_warmers/{name}"], "paths": ["/{index}/_warmer/{name}", "/{index}/_warmers/{name}"],
"parts": { "parts": {
"index": { "index": {
"type" : "list", "type" : "list",
@ -13,6 +13,7 @@
}, },
"name" : { "name" : {
"type" : "list", "type" : "list",
"required" : true,
"description" : "A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters." "description" : "A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters."
} }
}, },

View File

@ -11,7 +11,7 @@
"description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices" "description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
}, },
"name": { "name": {
"type" : "string", "type" : "list",
"description" : "The name of the settings that should be included" "description" : "The name of the settings that should be included"
} }
}, },
@ -30,10 +30,6 @@
"default" : ["open","closed"], "default" : ["open","closed"],
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both." "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
}, },
"prefix" : {
"type" : "string",
"description" : "The prefix all settings must have in order to be included"
},
"flat_settings": { "flat_settings": {
"type": "boolean", "type": "boolean",
"description": "Return settings in flat format (default: false)" "description": "Return settings in flat format (default: false)"

View File

@ -8,11 +8,10 @@
"parts": { "parts": {
"index": { "index": {
"type" : "list", "type" : "list",
"required" : true,
"description" : "A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices" "description" : "A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices"
}, },
"name": { "name": {
"type" : "string", "type" : "list",
"description" : "The name of the warmer (supports wildcards); leave empty to get all warmers" "description" : "The name of the warmer (supports wildcards); leave empty to get all warmers"
}, },
"type": { "type": {

View File

@ -6,10 +6,6 @@
"path": "/_aliases", "path": "/_aliases",
"paths": ["/_aliases"], "paths": ["/_aliases"],
"parts": { "parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names to filter aliases"
}
}, },
"params": { "params": {
"timeout": { "timeout": {

View File

@ -8,10 +8,12 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "string", "type": "string",
"required" : true,
"description": "A repository name" "description": "A repository name"
}, },
"snapshot": { "snapshot": {
"type": "string", "type": "string",
"required" : true,
"description": "A snapshot name" "description": "A snapshot name"
} }
}, },

View File

@ -8,6 +8,7 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "string", "type": "string",
"required" : true,
"description": "A repository name" "description": "A repository name"
} }
}, },

View File

@ -8,10 +8,12 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "string", "type": "string",
"required" : true,
"description": "A repository name" "description": "A repository name"
}, },
"snapshot": { "snapshot": {
"type": "string", "type": "string",
"required" : true,
"description": "A snapshot name" "description": "A snapshot name"
} }
}, },

View File

@ -8,6 +8,7 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "list", "type": "list",
"required" : true,
"description": "A comma-separated list of repository names" "description": "A comma-separated list of repository names"
} }
}, },

View File

@ -8,10 +8,12 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "list", "type": "list",
"required" : true,
"description": "A comma-separated list of repository names" "description": "A comma-separated list of repository names"
}, },
"snapshot": { "snapshot": {
"type": "list", "type": "list",
"required" : true,
"description": "A comma-separated list of snapshot names" "description": "A comma-separated list of snapshot names"
} }
}, },

View File

@ -8,10 +8,12 @@
"parts": { "parts": {
"repository": { "repository": {
"type": "string", "type": "string",
"required" : true,
"description": "A repository name" "description": "A repository name"
}, },
"snapshot": { "snapshot": {
"type": "string", "type": "string",
"required" : true,
"description": "A snapshot name" "description": "A snapshot name"
} }
}, },

View File

@ -41,7 +41,8 @@
} }
}, },
"body": { "body": {
"description" : "The request definition" "description" : "The request definition",
"required" : true
} }
} }
} }