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

[3.8] Small documentation enhancement/formating #41562

Merged
merged 1 commit into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/config-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ converted default value. However, when the property is explicitly empty, the def
[source,properties]
----
# missing value, optional property
greeting.name =
greeting.name=
----

In this case, since `greeting.name` was configured to be `Optional*` up above, the corresponding property value will
Expand All @@ -248,7 +248,7 @@ On the other hand, this example:
[source,properties]
----
# missing value, non-optional
greeting.suffix =
greeting.suffix=
----

will result in a `java.util.NoSuchElementException: SRCFG02004: Required property greeting.message not found` on
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@
[source,properties]
----
# Your configuration properties
greeting.message = hello
greeting.name = quarkus
greeting.message=hello
greeting.name=quarkus
----

== Create a REST resource

Check warning on line 65 in docs/src/main/asciidoc/config.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Create a REST resource'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Create a REST resource'.", "location": {"path": "docs/src/main/asciidoc/config.adoc", "range": {"start": {"line": 65, "column": 4}}}, "severity": "INFO"}

Create the `org.acme.config.GreetingResource` REST resource with the following content:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ For more information, see link:https://quarkus.io/blog/path-resolution-in-quarku
=== Map `SecurityIdentity` roles

Winning role-based policy can map the `SecurityIdentity` roles to the deployment-specific roles.
These roles are then applicable for endpoint authorization by using the @RolesAllowed annotation.
These roles are then applicable for endpoint authorization by using the `@RolesAllowed` annotation.

[source,properties]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/security-basic-authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For more information about how you can secure your Quarkus applications by using

== Role-based access control

{project-name} also includes built-in security to allow for role-based access control (RBAC) based on the common security annotations @RolesAllowed, @DenyAll, @PermitAll on REST endpoints and CDI beans.
{project-name} also includes built-in security to allow for role-based access control (RBAC) based on the common security annotations `@RolesAllowed`, `@DenyAll`, `@PermitAll` on REST endpoints and CDI beans.
For more information, see the Quarkus xref:security-authorize-web-endpoints-reference.adoc[Authorization of web endpoints] guide.

== References
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/security-jwt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,9 @@
----
<1> Here we inject `JsonWebToken`
<2> This new endpoint will be located at /secured/roles-allowed
<3> @RolesAllowed is a Jakarta common security annotation that indicates that the given endpoint is accessible by a caller if
<3> `@RolesAllowed` is a Jakarta common security annotation that indicates that the given endpoint is accessible by a caller if
they have either a "User" or "Admin" role assigned.
<4> Here we build the reply the same way as in the `hello` method but also add a value of the JWT `birthdate` claim by directly calling the injected `JsonWebToken`.

Check warning on line 257 in docs/src/main/asciidoc/security-jwt.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-jwt.adoc", "range": {"start": {"line": 257, "column": 31}}}, "severity": "INFO"}

After you make this addition to your `TokenSecuredResource`, rerun the `./mvnw compile quarkus:dev` command, and then try `curl -v http://127.0.0.1:8080/secured/roles-allowed; echo` to attempt to access the new endpoint.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/spring-boot-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@
[source,properties]
----
# Your configuration properties
greeting.text = hello
greeting.text=hello
----

Now modify `GreetingResource` to start using the `GreetingProperties`:

Check warning on line 117 in docs/src/main/asciidoc/spring-boot-properties.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/spring-boot-properties.adoc", "range": {"start": {"line": 117, "column": 39}}}, "severity": "INFO"}

[source,java]
----
Expand Down Expand Up @@ -359,7 +359,7 @@
[source,properties]
----
# Your configuration properties
greeting.message.text = hello
greeting.message.text=hello
----

[source,java]
Expand Down
Loading