Skip to content

Commit 3bf710d

Browse files
Improved the body BC break description in request/response for 8.x documentation (#2117) (#2118)
* Improved the body bc break in 8.x documentation * Removed just in the sentence (cherry picked from commit 6eabf37) Co-authored-by: Enrico Zimuel <[email protected]>
1 parent 6565509 commit 3bf710d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/changelog.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,9 @@ The client API leaks HTTP-related notions in many places, and removing them woul
361361

362362
This could be a rather big breaking change, so a double solution could be used during the 8.x lifecycle. (accepting body keys without them being wrapped in the body as well as the current solution).
363363

364+
To convert code from 7.x, you need to remove the `body` parameter in all the endpoints request.
365+
For instance, this is an example for the `search` endpoint:
366+
364367
[source,js]
365368
----
366369
// from
@@ -399,6 +402,12 @@ If you weren't extending the internals of the client, this won't be a breaking c
399402
The client API leaks HTTP-related notions in many places, and removing them would definitely improve the DX.
400403
The client will expose a new request-specific option to still get the full response details.
401404

405+
The new behaviour returns the `body` value directly as response.
406+
If you want to have the 7.x response format, you need to add `meta : true` in the request.
407+
This will return all the HTTP meta information, including the `body`.
408+
409+
For instance, this is an example for the `search` endpoint:
410+
402411
[source,js]
403412
----
404413
// from

0 commit comments

Comments
 (0)