Sync documentation of main branch

quarkusio · Dec 13, 2024 · 52f95d0 · 52f95d0
1 parent 51880de
commit 52f95d0
Show file tree

Hide file tree

Showing 7 changed files with 262 additions and 6 deletions.
diff --git a/_generated-doc/main/config/quarkus-agroal.adoc b/_generated-doc/main/config/quarkus-agroal.adoc
@@ -7,6 +7,90 @@ h|[.header-title]##Configuration property##
 h|Type
 h|Default
 
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Activate or disable the dev ui page.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allow sql queries in the Dev UI page
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
 a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc+++[]

diff --git a/_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc b/_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc
@@ -7,6 +7,90 @@ h|[.header-title]##Configuration property##
 h|Type
 h|Default
 
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Activate or disable the dev ui page.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allow sql queries in the Dev UI page
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
 a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc+++[]

diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -7,6 +7,90 @@ h|[.extension-name]##Agroal - Database connection pool##
 h|Type
 h|Default
 
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-enabled[`quarkus.datasource.dev-ui.enabled`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.enabled+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Activate or disable the dev ui page.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allow-sql]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allow-sql[`quarkus.datasource.dev-ui.allow-sql`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allow-sql+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allow sql queries in the Dev UI page
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOW_SQL+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-append-to-default-select[`quarkus.datasource.dev-ui.append-to-default-select`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.append-to-default-select+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Append this to the select done to fetch the table values. eg: LIMIT 100 or TOP 100
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_APPEND_TO_DEFAULT_SELECT+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
+a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-dev-ui-allowed-db-host[`quarkus.datasource.dev-ui.allowed-db-host`]##
+ifdef::add-copy-button-to-config-props[]
+config_property_copy_button:+++quarkus.datasource.dev-ui.allowed-db-host+++[]
+endif::add-copy-button-to-config-props[]
+
+
+[.description]
+--
+Allowed database host. By default only localhost is allowed. Any provided host here will also be allowed
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_DATASOURCE_DEV_UI_ALLOWED_DB_HOST+++`
+endif::add-copy-button-to-env-var[]
+--
+|string
+|
+
 a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc[`quarkus.datasource.jdbc`]##
 ifdef::add-copy-button-to-config-props[]
 config_property_copy_button:+++quarkus.datasource.jdbc+++[]
@@ -12116,7 +12200,7 @@ endif::add-copy-button-to-config-props[]
 --
 Require that all registered HTTP authentication mechanisms must complete the authentication.
 
-Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below:
+Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The mTLS mechanism is always the first mechanism, because its priority is elevated when inclusive authentication is enabled. The identities can be retrieved using utility method as in the example below:
 
 ```
 `io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)`
@@ -82297,7 +82381,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
+Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
 
 Can be overwritten by client-specific settings.
 

diff --git a/_generated-doc/main/config/quarkus-rest-client-config.adoc b/_generated-doc/main/config/quarkus-rest-client-config.adoc
@@ -414,7 +414,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
+Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
 
 Can be overwritten by client-specific settings.
 

diff --git a/_generated-doc/main/config/quarkus-rest-client-config_quarkus.rest-client.adoc b/_generated-doc/main/config/quarkus-rest-client-config_quarkus.rest-client.adoc
@@ -414,7 +414,7 @@ endif::add-copy-button-to-config-props[]
 
 [.description]
 --
-Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.
+Fully-qualified provider classnames to include in the client. The equivalent of the `@RegisterProvider` annotation.
 
 Can be overwritten by client-specific settings.
 

diff --git a/_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc b/_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc
@@ -122,7 +122,7 @@ endif::add-copy-button-to-config-props[]
 --
 Require that all registered HTTP authentication mechanisms must complete the authentication.
 
-Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below:
+Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The mTLS mechanism is always the first mechanism, because its priority is elevated when inclusive authentication is enabled. The identities can be retrieved using utility method as in the example below:
 
 ```
 `io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)`

diff --git a/_versions/main/guides/security-authentication-mechanisms.adoc b/_versions/main/guides/security-authentication-mechanisms.adoc
@@ -602,7 +602,11 @@ quarkus.http.auth.inclusive=true
 If the authentication is inclusive then `SecurityIdentity` created by the first authentication mechanism can be
 injected into the application code.
 For example, if both <<mutual-tls>> and basic authentication mechanism authentications are required,
-the <<mutual-tls>> authentication mechanism will create `SecurityIdentity` first.
+the <<mutual-tls>> mechanism will create `SecurityIdentity` first.
+
+NOTE: The <<mutual-tls>> mechanism has the highest priority when inclusive authentication is enabled, to ensure
+that an injected `SecurityIdentity` always represents <<mutual-tls>> and can be used to get access to `SecurityIdentity`
+identities provided by other authentication mechanisms.
 
 Additional `SecurityIdentity` instances can be accessed as a `quarkus.security.identities` attribute on the first
 `SecurityIdentity`, however, accessing these extra identities directly may not be necessary, for example,