summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/scroll.json
diff options
context:
space:
mode:
Diffstat (limited to 'rest-api-spec/api/scroll.json')
-rw-r--r--rest-api-spec/api/scroll.json29
1 files changed, 29 insertions, 0 deletions
diff --git a/rest-api-spec/api/scroll.json b/rest-api-spec/api/scroll.json
new file mode 100644
index 0000000..b01af64
--- /dev/null
+++ b/rest-api-spec/api/scroll.json
@@ -0,0 +1,29 @@
+{
+ "scroll": {
+ "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html",
+ "methods": ["GET", "POST"],
+ "url": {
+ "path": "/_search/scroll",
+ "paths": ["/_search/scroll", "/_search/scroll/{scroll_id}"],
+ "parts": {
+ "scroll_id": {
+ "type" : "string",
+ "description" : "The scroll ID"
+ }
+ },
+ "params": {
+ "scroll": {
+ "type" : "duration",
+ "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
+ },
+ "scroll_id": {
+ "type" : "string",
+ "description" : "The scroll ID for scrolled search"
+ }
+ }
+ },
+ "body": {
+ "description": "The scroll ID if not passed by URL or query parameter."
+ }
+ }
+}