Skip to content

Commit

Permalink
Merge pull request #39346 from geoand/rest-client-large-payloads
Browse files Browse the repository at this point in the history
Document the types of allowed large payloads in REST Client
  • Loading branch information
geoand authored Mar 12, 2024
2 parents 5c25ff5 + cac4366 commit 4ca065f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/src/main/asciidoc/rest-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,18 @@ public ClientMultipartForm buildClientMultipartForm(MultiPartPayloadFormData inp
<2> Adding attribute `jsonPayload` directly to `ClientMultipartForm`
<3> Adding `FileUpload` objects to `ClientMultipartForm` as binaryFileUpload with contentType.

=== Sending large payloads

The REST Client is capable of sending arbitrarily large HTTP bodies without buffering the contents in memory, if one of the following types is used:

* `InputStream`
* `Multi<io.vertx.mutiny.core.buffer.Buffer>`

Furthermore, the client can also send arbitrarily large files if one of the following types is used:

* `File`
* `Path`


== Create the configuration

Expand Down

0 comments on commit 4ca065f

Please sign in to comment.