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

Made REST query param types consistent 

duration -> time
integer,float -> number
This commit is contained in:
Clinton Gormley 2016-10-12 14:41:44 +02:00
parent 7b65c97483
commit e1ad00f07a
9 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json
View File

@ -94,7 +94,7 @@
"description" : "A comma-separated list of specific routing values" "description" : "A comma-separated list of specific routing values"
}, },
"scroll": { "scroll": {
"type" : "duration", "type" : "time",
"description" : "Specify how long a consistent view of the index should be maintained for scrolled search" "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
}, },
"search_type": { "search_type": {
@ -182,7 +182,7 @@
"description" : "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" "description" : "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
}, },
"scroll_size": { "scroll_size": {
"type": "integer", "type": "number",
"defaut_value": 100, "defaut_value": 100,
"description": "Size on the scroll request powering the update_by_query" "description": "Size on the scroll request powering the update_by_query"
}, },
@ -192,7 +192,7 @@
"description" : "Should the request should block until the delete-by-query is complete." "description" : "Should the request should block until the delete-by-query is complete."
}, },
"requests_per_second": { "requests_per_second": {
"type": "float", "type": "number",
"default": 0, "default": 0,
"description": "The throttle for this request in sub-requests per second. -1 means set no throttle." "description": "The throttle for this request in sub-requests per second. -1 means set no throttle."
} }

2
rest-api-spec/src/main/resources/rest-api-spec/api/index.json
View File

@ -54,7 +54,7 @@
"description" : "Explicit timestamp for the document" "description" : "Explicit timestamp for the document"
}, },
"ttl": { "ttl": {
"type" : "duration", "type" : "time",
"description" : "Expiration time for the document" "description" : "Expiration time for the document"
}, },
"version" : { "version" : {

2
rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json
View File

@ -26,7 +26,7 @@
"description" : "Should the request should block until the reindex is complete." "description" : "Should the request should block until the reindex is complete."
}, },
"requests_per_second": { "requests_per_second": {
"type": "float", "type": "number",
"default": 0, "default": 0,
"description": "The throttle to set on this request in sub-requests per second. -1 means set no throttle as does \"unlimited\" which is the only non-float this accepts." "description": "The throttle to set on this request in sub-requests per second. -1 means set no throttle as does \"unlimited\" which is the only non-float this accepts."
} }

2
rest-api-spec/src/main/resources/rest-api-spec/api/reindex_rethrottle.json
View File

@ -13,7 +13,7 @@
}, },
"params": { "params": {
"requests_per_second": { "requests_per_second": {
"type": "float", "type": "number",
"required": true, "required": true,
"description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle." "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."
} }

2
rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json
View File

@ -13,7 +13,7 @@
}, },
"params": { "params": {
"scroll": { "scroll": {
"type" : "duration", "type" : "time",
"description" : "Specify how long a consistent view of the index should be maintained for scrolled search" "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
}, },
"scroll_id": { "scroll_id": {

2
rest-api-spec/src/main/resources/rest-api-spec/api/search.json
View File

@ -89,7 +89,7 @@
"description" : "A comma-separated list of specific routing values" "description" : "A comma-separated list of specific routing values"
}, },
"scroll": { "scroll": {
"type" : "duration", "type" : "time",
"description" : "Specify how long a consistent view of the index should be maintained for scrolled search" "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
}, },
"search_type": { "search_type": {

2
rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json
View File

@ -39,7 +39,7 @@
"description" : "A comma-separated list of specific routing values" "description" : "A comma-separated list of specific routing values"
}, },
"scroll": { "scroll": {
"type" : "duration", "type" : "time",
"description" : "Specify how long a consistent view of the index should be maintained for scrolled search" "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
}, },
"search_type": { "search_type": {

2
rest-api-spec/src/main/resources/rest-api-spec/api/update.json
View File

@ -73,7 +73,7 @@
"description": "Explicit timestamp for the document" "description": "Explicit timestamp for the document"
}, },
"ttl": { "ttl": {
"type": "duration", "type": "time",
"description": "Expiration time for the document" "description": "Expiration time for the document"
}, },
"version": { "version": {

6
rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json
View File

@ -102,7 +102,7 @@
"description" : "A comma-separated list of specific routing values" "description" : "A comma-separated list of specific routing values"
}, },
"scroll": { "scroll": {
"type" : "duration", "type" : "time",
"description" : "Specify how long a consistent view of the index should be maintained for scrolled search" "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
}, },
"search_type": { "search_type": {
@ -194,7 +194,7 @@
"description" : "Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)" "description" : "Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
}, },
"scroll_size": { "scroll_size": {
"type": "integer", "type": "number",
"defaut_value": 100, "defaut_value": 100,
"description": "Size on the scroll request powering the update_by_query" "description": "Size on the scroll request powering the update_by_query"
}, },
@ -204,7 +204,7 @@
"description" : "Should the request should block until the reindex is complete." "description" : "Should the request should block until the reindex is complete."
}, },
"requests_per_second": { "requests_per_second": {
"type": "float", "type": "number",
"default": 0, "default": 0,
"description": "The throttle to set on this request in sub-requests per second. -1 means set no throttle as does \"unlimited\" which is the only non-float this accepts." "description": "The throttle to set on this request in sub-requests per second. -1 means set no throttle as does \"unlimited\" which is the only non-float this accepts."
} }