OpenSearch/rest-api-spec/api/scroll.json

34 lines
967 B
JSON

{
"scroll": {
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/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": {
"source": {
"type" : "string",
"description" : "The URL-encoded request definition"
},
"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."
}
}
}