honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix inconsistencies in the rest api specs for `tasks` (#27163) 

modify parameters names to reflect the changes done in the code base
This commit is contained in:
olcbean 2017-11-06 10:11:25 +01:00 committed by Luca Cavanna
parent 5d7d01ba75
commit e440e23ad1
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
rest-api-spec/src/main/resources/rest-api-spec/api/tasks.cancel.json
View File

@ -12,7 +12,7 @@
} }
}, },
"params": { "params": {
"node_id": { "nodes": {
"type": "list", "type": "list",
"description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes" "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"
}, },
@ -24,7 +24,7 @@
"type": "string", "type": "string",
"description": "Cancel tasks with specified parent node." "description": "Cancel tasks with specified parent node."
}, },
"parent_task": { "parent_task_id": {
"type" : "string", "type" : "string",
"description" : "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." "description" : "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all."
} }

4
rest-api-spec/src/main/resources/rest-api-spec/api/tasks.list.json
View File

@ -7,7 +7,7 @@
"paths": ["/_tasks"], "paths": ["/_tasks"],
"parts": {}, "parts": {},
"params": { "params": {
"node_id": { "nodes": {
"type": "list", "type": "list",
"description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes" "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"
}, },
@ -23,7 +23,7 @@
"type": "string", "type": "string",
"description": "Return tasks with specified parent node." "description": "Return tasks with specified parent node."
}, },
"parent_task": { "parent_task_id": {
"type" : "string", "type" : "string",
"description" : "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all." "description" : "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all."
}, },