Skip to content

Javadoc badges #393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 25, 2024
Merged

Javadoc badges #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46fda9f
javadoc badges
SentryMan Feb 23, 2024
f8717bf
update javadoc typos
SentryMan Feb 24, 2024
662365e
fix doc
SentryMan Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# [Avaje-HTTP](https://avaje.io/http/)
[![Discord](https://img.shields.io/discord/1074074312421683250?color=%237289da&label=discord)](https://discord.gg/Qcqf9R27BR)
[![Build](https://github.com/avaje/avaje-http/actions/workflows/build.yml/badge.svg)](https://github.com/avaje/avaje-http/actions/workflows/build.yml)
[![Maven Central : avaje-inject](https://img.shields.io/maven-central/v/io.avaje/avaje-http-api.svg?label=Maven%20Central)](https://maven-badges.herokuapp.com/maven-central/io.avaje/avaje-http-api)
[![javadoc](https://javadoc.io/badge2/io.avaje/avaje-http-api/http_api_javadoc.svg?&color=purple)](https://javadoc.io/doc/io.avaje/avaje-http-api)
[![javadoc](https://javadoc.io/badge2/io.avaje/avaje-http-client/http_client_javadoc.svg?&color=purple)](https://javadoc.io/doc/io.avaje/avaje-http-client)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/avaje/avaje-inject/blob/master/LICENSE)
[![Discord](https://img.shields.io/discord/1074074312421683250?color=%237289da&label=discord)](https://discord.gg/Qcqf9R27BR)

HTTP server and client libraries via code generation.

Expand Down
3 changes: 2 additions & 1 deletion http-client/src/main/java/io/avaje/http/client/HttpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.net.Authenticator;
import java.net.CookieHandler;
import java.net.ProxySelector;
import java.net.http.HttpRequest;
import java.time.Duration;
import java.util.Map;
import java.util.concurrent.Executor;
Expand Down Expand Up @@ -69,7 +70,7 @@ static Builder builder() {
HttpClientRequest request();

/**
* Return a UrlBuilder to use to build an URL taking into account the base URL.
* Returns a UrlBuilder to build a URL, considering the base URL.
*/
UrlBuilder url();

Expand Down
24 changes: 12 additions & 12 deletions http-client/src/main/java/io/avaje/http/client/HttpClientResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public interface HttpClientResponse {
/**
* Return the response with the body containing a single instance of the given type.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -76,7 +76,7 @@ public interface HttpClientResponse {
/**
* Return the response with the body containing a single instance of the given type.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -88,7 +88,7 @@ public interface HttpClientResponse {
/**
* Return the response with the body containing a list of the given type.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -101,7 +101,7 @@ public interface HttpClientResponse {
/**
* Return the response with the body containing a list of the given type.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -122,7 +122,7 @@ public interface HttpClientResponse {
* may not be available at the time of the callback. As such {@link RequestLogger}
* will not include response content when logging stream request/response
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -143,7 +143,7 @@ public interface HttpClientResponse {
* may not be available at the time of the callback. As such {@link RequestLogger}
* will not include response content when logging stream request/response
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -156,7 +156,7 @@ public interface HttpClientResponse {
/**
* Return the response as a single bean.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -169,7 +169,7 @@ public interface HttpClientResponse {
/**
* Return the response as a list of beans.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -190,7 +190,7 @@ public interface HttpClientResponse {
* may not be available at the time of the callback. As such {@link RequestLogger}
* will not include response content when logging stream request/response
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -203,7 +203,7 @@ public interface HttpClientResponse {
/**
* Return the response as a single bean.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -215,7 +215,7 @@ public interface HttpClientResponse {
/**
* Return the response as a list of beans.
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand All @@ -235,7 +235,7 @@ public interface HttpClientResponse {
* may not be available at the time of the callback. As such {@link RequestLogger}
* will not include response content when logging stream request/response
* <p>
* If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
* If the HTTP statusCode is not in the 2XX range, an HttpException is thrown containing
* the HttpResponse. This is the cause in the CompletionException when using an async request.
*
* @param type The type of the bean to convert the response content into.
Expand Down