From 33b3266441f6fb0675c73abdc4bc8b7c08e3a3a3 Mon Sep 17 00:00:00 2001 From: Jakub Jedlicka Date: Wed, 3 Apr 2024 16:49:02 +0200 Subject: [PATCH] Small documentation enhancement/formating --- docs/src/main/asciidoc/config-reference.adoc | 4 ++-- docs/src/main/asciidoc/config.adoc | 4 ++-- .../asciidoc/security-authorize-web-endpoints-reference.adoc | 2 +- docs/src/main/asciidoc/security-basic-authentication.adoc | 2 +- docs/src/main/asciidoc/security-jwt.adoc | 2 +- docs/src/main/asciidoc/spring-boot-properties.adoc | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/src/main/asciidoc/config-reference.adoc b/docs/src/main/asciidoc/config-reference.adoc index c205732044559..1d7bec30bcbd8 100644 --- a/docs/src/main/asciidoc/config-reference.adoc +++ b/docs/src/main/asciidoc/config-reference.adoc @@ -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 @@ -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 diff --git a/docs/src/main/asciidoc/config.adoc b/docs/src/main/asciidoc/config.adoc index 89f0d72eabc23..650cd1cc39ffc 100644 --- a/docs/src/main/asciidoc/config.adoc +++ b/docs/src/main/asciidoc/config.adoc @@ -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 diff --git a/docs/src/main/asciidoc/security-authorize-web-endpoints-reference.adoc b/docs/src/main/asciidoc/security-authorize-web-endpoints-reference.adoc index a0c3f78659ccd..6573051c0c53f 100644 --- a/docs/src/main/asciidoc/security-authorize-web-endpoints-reference.adoc +++ b/docs/src/main/asciidoc/security-authorize-web-endpoints-reference.adoc @@ -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] ---- diff --git a/docs/src/main/asciidoc/security-basic-authentication.adoc b/docs/src/main/asciidoc/security-basic-authentication.adoc index acb0afa6d4488..8d3d00fd5765f 100644 --- a/docs/src/main/asciidoc/security-basic-authentication.adoc +++ b/docs/src/main/asciidoc/security-basic-authentication.adoc @@ -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 diff --git a/docs/src/main/asciidoc/security-jwt.adoc b/docs/src/main/asciidoc/security-jwt.adoc index 586feadd7d8d3..30742afb2ba13 100644 --- a/docs/src/main/asciidoc/security-jwt.adoc +++ b/docs/src/main/asciidoc/security-jwt.adoc @@ -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`. diff --git a/docs/src/main/asciidoc/spring-boot-properties.adoc b/docs/src/main/asciidoc/spring-boot-properties.adoc index b9c4c74310e56..241fcfb91bbf6 100644 --- a/docs/src/main/asciidoc/spring-boot-properties.adoc +++ b/docs/src/main/asciidoc/spring-boot-properties.adoc @@ -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`: @@ -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]