Skip to content

Commit

Permalink
Merge pull request #41562 from rolfedh/cp-docs-small-enhancements-to-3.8
Browse files Browse the repository at this point in the history
[3.8] Small documentation enhancement/formating
  • Loading branch information
gsmet authored Jul 1, 2024
2 parents 4f09303 + 33b3266 commit 1e1599b
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
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,8 +58,8 @@ Edit the file with the following content:
[source,properties]
----
# Your configuration properties
greeting.message = hello
greeting.name = quarkus
greeting.message=hello
greeting.name=quarkus
----

== Create a REST resource
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,7 +252,7 @@ public class TokenSecuredResource {
----
<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`.

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,7 +111,7 @@ Define this property in your `src/main/resources/application.properties` file:
[source,properties]
----
# Your configuration properties
greeting.text = hello
greeting.text=hello
----

Now modify `GreetingResource` to start using the `GreetingProperties`:
Expand Down Expand Up @@ -359,7 +359,7 @@ Let's update the properties file and the `GreetingResource` class.
[source,properties]
----
# Your configuration properties
greeting.message.text = hello
greeting.message.text=hello
----

[source,java]
Expand Down

0 comments on commit 1e1599b

Please sign in to comment.