Fix vale errors and some warnings in the OIDC Configuration Properties reference guide

extensions/oidc-common/runtime/src/main/java/io/quarkus/oidc/common/runtime/OidcCommonConfig.java

@@ -166,13 +166,13 @@ public static enum Method {
  BASIC,
 
  /**
- * client_secret_post: client id and secret are submitted as the 'client_id' and 'client_secret' form
+ * client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form
  * parameters.
  */
  POST,
 
  /**
- * client_secret_jwt: client id and generated JWT secret are submitted as the 'client_id' and 'client_secret'
+ * client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret`
  * form
  * parameters.
  */
@@ -223,7 +223,7 @@ public void setSecretProvider(Provider secretProvider) {
  }
 
  /**
- * Supports the client authentication 'client_secret_jwt' and 'private_key_jwt' methods which involve sending a JWT
+ * Supports the client authentication 'client_secret_jwt' and `private_key_jwt` methods which involve sending a JWT
  * token
  * assertion signed with either a client secret or private key.
  *
@@ -252,13 +252,13 @@ public static class Jwt {
  public Optional<String> keyFile = Optional.empty();
 
  /**
- * If provided, indicates that JWT is signed using a private key from a key store
+ * If provided, indicates that JWT is signed using a private key from a keystore
  */
  @ConfigItem
  public Optional<String> keyStoreFile = Optional.empty();
 
  /**
- * A parameter to specify the password of the key store file.
+ * A parameter to specify the password of the keystore file.
  */
  @ConfigItem
  public Optional<String> keyStorePassword;
@@ -289,7 +289,7 @@ public static class Jwt {
  public Optional<String> tokenKeyId = Optional.empty();
 
  /**
- * Issuer of the signing key added as a JWT 'iss' claim (default: client id)
+ * Issuer of the signing key added as a JWT `iss` claim (default: client id)
  */
  @ConfigItem
  public Optional<String> issuer = Optional.empty();
@@ -441,41 +441,41 @@ public enum Verification {
  }
 
  /**
- * Certificate validation and hostname verification, which can be one of the following values from enum
- * {@link Verification}. Default is required.
+ * Certificate validation and hostname verification, which can be one of the following {@link Verification} values.
+ * Default is required.
  */
  @ConfigItem
  public Optional<Verification> verification = Optional.empty();
 
  /**
- * An optional key store which holds the certificate information instead of specifying separate files.
+ * An optional keystore which holds the certificate information instead of specifying separate files.
  */
  @ConfigItem
  public Optional<Path> keyStoreFile = Optional.empty();
 
  /**
- * An optional parameter to specify type of the key store file. If not given, the type is automatically detected
+ * An optional parameter to specify type of the keystore file. If not given, the type is automatically detected
  * based on the file name.
  */
  @ConfigItem
  public Optional<String> keyStoreFileType = Optional.empty();
 
  /**
- * An optional parameter to specify a provider of the key store file. If not given, the provider is automatically
+ * An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically
  * detected
- * based on the key store file type.
+ * based on the keystore file type.
  */
  @ConfigItem
  public Optional<String> keyStoreProvider;
 
  /**
- * A parameter to specify the password of the key store file. If not given, the default ("password") is used.
+ * A parameter to specify the password of the keystore file. If not given, the default ("password") is used.
  */
  @ConfigItem
  public Optional<String> keyStorePassword;
 
  /**
- * An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains
+ * An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains
  * multiple
  * keys and no alias is specified, the behavior is undefined.
  */
@@ -489,34 +489,34 @@ public enum Verification {
  public Optional<String> keyStoreKeyPassword = Optional.empty();
 
  /**
- * An optional trust store which holds the certificate information of the certificates to trust
+ * An optional truststore which holds the certificate information of the certificates to trust
  */
  @ConfigItem
  public Optional<Path> trustStoreFile = Optional.empty();
 
  /**
- * A parameter to specify the password of the trust store file.
+ * A parameter to specify the password of the truststore file.
  */
  @ConfigItem
  public Optional<String> trustStorePassword = Optional.empty();
 
  /**
- * A parameter to specify the alias of the trust store certificate.
+ * A parameter to specify the alias of the truststore certificate.
  */
  @ConfigItem
  public Optional<String> trustStoreCertAlias = Optional.empty();
 
  /**
- * An optional parameter to specify type of the trust store file. If not given, the type is automatically detected
+ * An optional parameter to specify type of the truststore file. If not given, the type is automatically detected
  * based on the file name.
  */
  @ConfigItem
  public Optional<String> trustStoreFileType = Optional.empty();
 
  /**
- * An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically
+ * An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically
  * detected
- * based on the trust store file type.
+ * based on the truststore file type.
  */
  @ConfigItem
  public Optional<String> trustStoreProvider;

extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/OidcBuildTimeConfig.java

@@ -22,8 +22,8 @@ public class OidcBuildTimeConfig {
  public DevUiConfig devui;
  /**
  * Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean.
- * Note it only allows to use the default implementation, one needs to configure it in order to activate it,
- * please see {@link OidcConfig#tokenCache}.
+ * Note: This only enables the default implementation. It requires configuration to be activated.
+ * See {@link OidcConfig#tokenCache}.
  */
  @ConfigItem(defaultValue = "true")
  public boolean defaultTokenCacheEnabled;

extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/devservices/keycloak/DevServicesConfig.java

@@ -23,11 +23,11 @@ public class DevServicesConfig {
  public boolean enabled = true;
 
  /**
- * The container image name to use, for container based DevServices providers.
+ * The container image name to use, for container-based DevServices providers.
  *
  * Image with a Quarkus based distribution is used by default.
  * Image with a WildFly based distribution can be selected instead, for example:
- * 'quay.io/keycloak/keycloak:19.0.3-legacy'.
+ * `quay.io/keycloak/keycloak:19.0.3-legacy`.
  * <p>
  * Note Keycloak Quarkus and Keycloak WildFly images are initialized differently.
  * By default, Dev Services for Keycloak will assume it is a Keycloak Quarkus image if the image version does not end with a
@@ -106,17 +106,17 @@ public class DevServicesConfig {
 
  /**
  * The Keycloak realm name.
- * This property will be used to create the realm if the realm file pointed to by the 'realm-path' property does not exist,
- * default value is 'quarkus' in this case.
- * If the realm file pointed to by the 'realm-path' property exists then it is still recommended to set this property
- * for Dev Services for Keycloak to avoid parsing the realm file in order to determine the realm name.
+ * This property will be used to create the realm if the realm file pointed to by the `realm-path` property does not exist,
+ * default value is `quarkus` in this case.
+ * If the realm file pointed to by the `realm-path` property exists then it is still recommended to set this property
+ * for Dev Services for Keycloak to avoid parsing the realm file to determine the realm name.
  *
  */
  @ConfigItem
  public Optional<String> realmName;
 
  /**
- * Indicates if the Keycloak realm has to be created when the realm file pointed to by the 'realm-path' property does not
+ * Indicates if the Keycloak realm has to be created when the realm file pointed to by the `realm-path` property does not
  * exist.
  *
  * Disable it if you'd like to create a realm using Keycloak Administration Console
@@ -128,7 +128,7 @@ public class DevServicesConfig {
  /**
  * The Keycloak users map containing the username and password pairs.
  * If this map is empty then two users, 'alice' and 'bob' with the passwords matching their names will be created.
- * This property will be used to create the Keycloak users if the realm file pointed to by the 'realm-path' property does
+ * This property will be used to create the Keycloak users if the realm file pointed to by the `realm-path` property does
  * not exist.
  */
  @ConfigItem
@@ -138,7 +138,7 @@ public class DevServicesConfig {
  * The Keycloak user roles.
  * If this map is empty then a user named 'alice' will get 'admin' and 'user' roles and all other users will get a 'user'
  * role.
- * This property will be used to create the Keycloak roles if the realm file pointed to by the 'realm-path' property does
+ * This property will be used to create the Keycloak roles if the realm file pointed to by the `realm-path` property does
  * not exist.
  */
  @ConfigItem