Skip to content

Commit d972a48

Browse files
committed
[DOCS] Breaking changes update
1 parent 0a579ea commit d972a48

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,28 @@ Breaking changes can impact your Elastic applications, potentially disrupting no
1414
% **Action**<br> Steps for mitigating deprecation impact.
1515
% ::::
1616

17-
% ## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes]
17+
## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes]
1818

19-
% ::::{dropdown} Title of breaking change
20-
% Description of the breaking change.
21-
% For more information, check [PR #](PR link).
22-
% **Impact**<br> Impact of the breaking change.
23-
% **Action**<br> Steps for mitigating deprecation impact.
24-
% ::::
19+
### Scroll APIs need to send scroll_id in request body
20+
21+
Sending the `scroll_id` as a parameter has been deprecated since version 7.0.0. It needs to be specified in the request body for `clear_scroll` and `scroll`.
22+
23+
**Impact**<br>
24+
25+
Client code using `clear_scroll` or `scroll` APIs and the deprecated `scroll_id` as a parameter needs to be updated.
26+
27+
**Action**<br>
28+
29+
If you are using the `clear_scroll` or `scroll` APIs, and sending the `scroll_id` as a parameter, you need to update your code to send the `scroll_id` as part of the request body:
30+
```ruby
31+
# Before:
32+
client.clear_scroll(scroll_id: scroll_id)
33+
# Now:
34+
client.clear_scroll(body: { scroll_id: scroll_id })
35+
36+
# Before:
37+
client.scroll(scroll_id: scroll_id)
38+
# Now:
39+
client.scroll(body: { scroll_id: scroll_id })
40+
```
41+
% ::::

0 commit comments

Comments
 (0)