Skip to content
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.

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

Fix typos in rest doc #39522

Merged
merged 2 commits into from
Mar 18, 2024
Merged
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions docs/src/main/asciidoc/rest.adoc
Original file line number Diff line number Diff line change
@@ -88,8 +88,8 @@ Resource:: Represents your domain object. This is what your API serves and modif
Representation:: How your resource is represented on the wire, can vary depending on content types
Content type:: Designates a particular representation (also called a media type), for example `text/plain` or `application/json`
HTTP:: Underlying wire protocol for routing REST calls (see https://tools.ietf.org/html/rfc7230[HTTP specifications])
HTTP request:: the request part of the HTTP call, consisting of an HTTP method, a target URI, headers and an optional message body
HTTP response:: the response part of the HTTP call, consisting of an HTTP response status, headers and an optional message body
HTTP request:: The request part of the HTTP call, consisting of an HTTP method, a target URI, headers and an optional message body
HTTP response:: The response part of the HTTP call, consisting of an HTTP response status, headers and an optional message body

=== Declaring endpoints: URI mapping

@@ -2310,9 +2310,9 @@ quarkus.log.category."org.jboss.resteasy.reactive.common.core.AbstractResteasyRe

==== Via annotations

You can declare functions which are invoked in the following phases of the request processing:
You can declare functions that are invoked in the following phases of the request processing:

- Before the endpoint method is identified: pre-routing request filter
- Before the endpoint method is identified: pre-matching request filter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@geoand can you check this one?

The rest looks good.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this makes sense as it's the same terminology used in the filter declaration

- After routing, but before the endpoint method is called: normal request filter
- After the endpoint method is called: response filter

@@ -2491,7 +2491,7 @@ A `ContainerResponseFilter` will also be called for <<exception-mapping, handled

[[readers-writers]]

Whenever your endpoint methods return an object (of when they return a
Whenever your endpoint methods return an object (or when they return a
link:{resteasy-reactive-common-api}/org/jboss/resteasy/reactive/RestResponse.html[`RestResponse<?>`]
or link:{jaxrsapi}/jakarta/ws/rs/core/Response.html[`Response`] with
an entity), Quarkus REST will look for a way to map that into an HTTP response body.
Loading