Fixes #10293 - Improve documentation on how to write a response body … #10434
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…in Jetty 12. Updated documentation about: * Content.Source * Content.Sink * Handler * Request/Response Updated few APIs to make easier to write applications. Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
joakime
reviewed
Aug 29, 2023
| * @return a new {@link Completable} passed to the consumer | ||
| * @see #with(Consumer) | ||
| */ | ||
| public Completable compose(Consumer<Completable> consumer) |
There was a problem hiding this comment.
This seems like a change that's bigger than just documentation.
joakime
reviewed
Aug 29, 2023
| Fields formFields = FormFields.from(request).get(); | ||
| return Fields.combine(queryFields, formFields); | ||
| CompletableFuture<Fields> contentFields = FormFields.from(request); | ||
| return contentFields.thenApply(formFields -> Fields.combine(queryFields, formFields)); |
There was a problem hiding this comment.
Another change that isn't just documentation? is this what broke the tests in this latest build?
joakime
reviewed
Aug 29, 2023
| * @param charset the charset to use to decode bytes | ||
| * @return the {@link CompletableFuture} to notify when the whole content has been read | ||
| */ | ||
| static CompletableFuture<String> asStringAsync(Source source, Charset charset) |
There was a problem hiding this comment.
Another non-documentation change?
joakime
requested changes
Aug 29, 2023
| @@ -25,7 +25,9 @@ public class HttpStatus | |||
| public static final int CONTINUE_100 = 100; | |||
| public static final int SWITCHING_PROTOCOLS_101 = 101; | |||
| public static final int PROCESSING_102 = 102; | |||
| @Deprecated(forRemoval = true) | |||
There was a problem hiding this comment.
Can we also have since ...
Suggested change
| @Deprecated(forRemoval = true) | |
| @Deprecated(forRemoval = true, since = "12.0.1") |
| @@ -104,7 +106,9 @@ public enum Code | |||
| CONTINUE(CONTINUE_100, "Continue"), | |||
| SWITCHING_PROTOCOLS(SWITCHING_PROTOCOLS_101, "Switching Protocols"), | |||
| PROCESSING(PROCESSING_102, "Processing"), | |||
| @Deprecated(forRemoval = true) | |||
There was a problem hiding this comment.
Suggested change
| @Deprecated(forRemoval = true) | |
| @Deprecated(forRemoval = true, since = "12.0.1" |
| @@ -123,7 +127,7 @@ public enum Code | |||
| NOT_MODIFIED(NOT_MODIFIED_304, "Not Modified"), | |||
| USE_PROXY(USE_PROXY_305, "Use Proxy"), | |||
| TEMPORARY_REDIRECT(TEMPORARY_REDIRECT_307, "Temporary Redirect"), | |||
| // Keeping the typo for backward compatibility for a while | |||
| @Deprecated(forRemoval = true) | |||
There was a problem hiding this comment.
Suggested change
| @Deprecated(forRemoval = true) | |
| @Deprecated(forRemoval = true, since = "12.0.1" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…in Jetty 12.
Updated documentation about:
Updated few APIs to make easier to write applications.