Skip to content

Commit d0f00cd

Browse files
committed
deprecate scroll_id as part of the URL, documented only as part of the body which is a safer behaviour as well
1 parent dfd9642 commit d0f00cd

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,15 @@
33
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html",
44
"methods": ["DELETE"],
55
"url": {
6-
"path": "/_search/scroll/{scroll_id}",
7-
"paths": ["/_search/scroll/{scroll_id}", "/_search/scroll"],
6+
"path": "/_search/scroll",
7+
"paths": [ "/_search/scroll"],
8+
"deprecated_paths" : [
9+
{
10+
"version" : "7.0",
11+
"path" : "/_search/scroll/{scroll_id}",
12+
"description" : "A scroll id can be quite large and should be specified as part of the body"
13+
}
14+
],
815
"parts": {
916
"scroll_id": {
1017
"type" : "list",

rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@
44
"methods": ["GET", "POST"],
55
"url": {
66
"path": "/_search/scroll",
7-
"paths": ["/_search/scroll", "/_search/scroll/{scroll_id}"],
7+
"paths": ["/_search/scroll"],
8+
"deprecated_paths" : [
9+
{
10+
"version" : "7.0",
11+
"path" : "/_search/scroll/{scroll_id}",
12+
"description" : "A scroll id can be quite large and should be specified as part of the body"
13+
}
14+
],
815
"parts": {
916
"scroll_id": {
1017
"type" : "string",

0 commit comments

Comments
 (0)