Skip to content

Commit b7bf772

Browse files
committed
[DOCS] Breaking changes update
1 parent aeb415d commit b7bf772

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,28 @@ To learn how to upgrade, check out <uprade docs>.
1717
% **Action**<br> Steps for mitigating deprecation impact.
1818
% ::::
1919

20-
% ## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes]
21-
% **Release date:** March 25, 2025
20+
## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes]
2221

23-
% ::::{dropdown} Title of breaking change
24-
% Description of the breaking change.
25-
% For more information, check [PR #](PR link).
26-
% **Impact**<br> Impact of the breaking change.
27-
% **Action**<br> Steps for mitigating deprecation impact.
28-
% ::::
22+
### Scroll APIs need to send scroll_id in request body
23+
24+
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`.
25+
26+
**Impact**<br>
27+
28+
Client code using `clear_scroll` or `scroll` APIs and the deprecated `scroll_id` as a parameter needs to be updated.
29+
30+
**Action**<br>
31+
32+
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:
33+
```ruby
34+
# Before:
35+
client.clear_scroll(scroll_id: scroll_id)
36+
# Now:
37+
client.clear_scroll(body: { scroll_id: scroll_id })
38+
39+
# Before:
40+
client.scroll(scroll_id: scroll_id)
41+
# Now:
42+
client.scroll(body: { scroll_id: scroll_id })
43+
```
44+
% ::::

0 commit comments

Comments
 (0)