Skip to content

Commit 97663f3

Browse files
committed
Sync documentation of main branch
1 parent 7124bbb commit 97663f3

File tree

8 files changed

+114
-11
lines changed

8 files changed

+114
-11
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69285,7 +69285,7 @@ endif::add-copy-button-to-config-props[]
6928569285

6928669286
[.description]
6928769287
--
69288-
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
69288+
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. On the other hand, if it was set to `org_xyz,org_abc`, the `org_id` claim would need to have both `org_xyz` and `org_abc` values. Strings and arrays of strings are currently the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
6928969289

6929069290

6929169291
ifdef::add-copy-button-to-env-var[]
@@ -69295,7 +69295,7 @@ ifndef::add-copy-button-to-env-var[]
6929569295
Environment variable: `+++QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++`
6929669296
endif::add-copy-button-to-env-var[]
6929769297
--
69298-
|Map<String,String>
69298+
|Map<String,Set<String>>
6929969299
|
6930069300

6930169301
a| [[quarkus-oidc_quarkus-oidc-token-token-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-token-type[`quarkus.oidc.token.token-type`]##

_generated-doc/main/config/quarkus-oidc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1931,7 +1931,7 @@ endif::add-copy-button-to-config-props[]
19311931

19321932
[.description]
19331933
--
1934-
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
1934+
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. On the other hand, if it was set to `org_xyz,org_abc`, the `org_id` claim would need to have both `org_xyz` and `org_abc` values. Strings and arrays of strings are currently the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
19351935

19361936

19371937
ifdef::add-copy-button-to-env-var[]
@@ -1941,7 +1941,7 @@ ifndef::add-copy-button-to-env-var[]
19411941
Environment variable: `+++QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++`
19421942
endif::add-copy-button-to-env-var[]
19431943
--
1944-
|Map<String,String>
1944+
|Map<String,Set<String>>
19451945
|
19461946

19471947
a| [[quarkus-oidc_quarkus-oidc-token-token-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-token-type[`quarkus.oidc.token.token-type`]##

_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1931,7 +1931,7 @@ endif::add-copy-button-to-config-props[]
19311931

19321932
[.description]
19331933
--
1934-
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
1934+
A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. On the other hand, if it was set to `org_xyz,org_abc`, the `org_id` claim would need to have both `org_xyz` and `org_abc` values. Strings and arrays of strings are currently the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.
19351935

19361936

19371937
ifdef::add-copy-button-to-env-var[]
@@ -1941,7 +1941,7 @@ ifndef::add-copy-button-to-env-var[]
19411941
Environment variable: `+++QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++`
19421942
endif::add-copy-button-to-env-var[]
19431943
--
1944-
|Map<String,String>
1944+
|Map<String,Set<String>>
19451945
|
19461946

19471947
a| [[quarkus-oidc_quarkus-oidc-token-token-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-token-type[`quarkus.oidc.token.token-type`]##

_generated-doc/main/infra/quarkus-maven-plugin-goals.adoc

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,15 @@ The properties of the plugin.
289289
|`Map`
290290
|
291291

292+
a| [[quarkus-maven-plugin-goal-build-reloadPoms]] reloadPoms
293+
294+
[.description]
295+
--
296+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
297+
--
298+
|`Set`
299+
|
300+
292301
a| [[quarkus-maven-plugin-goal-build-repoSession]] repoSession
293302

294303
[.description]
@@ -1133,6 +1142,15 @@ The properties of the plugin.
11331142
|`Map`
11341143
|
11351144

1145+
a| [[quarkus-maven-plugin-goal-deploy-reloadPoms]] reloadPoms
1146+
1147+
[.description]
1148+
--
1149+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
1150+
--
1151+
|`Set`
1152+
|
1153+
11361154
a| [[quarkus-maven-plugin-goal-deploy-repoSession]] repoSession
11371155

11381156
[.description]
@@ -1560,6 +1578,15 @@ The properties of the plugin.
15601578
|`Map`
15611579
|
15621580

1581+
a| [[quarkus-maven-plugin-goal-generate-code-reloadPoms]] reloadPoms
1582+
1583+
[.description]
1584+
--
1585+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
1586+
--
1587+
|`Set`
1588+
|
1589+
15631590
a| [[quarkus-maven-plugin-goal-generate-code-repoSession]] repoSession
15641591

15651592
[.description]
@@ -1708,6 +1735,15 @@ The properties of the plugin.
17081735
|`Map`
17091736
|
17101737

1738+
a| [[quarkus-maven-plugin-goal-generate-code-tests-reloadPoms]] reloadPoms
1739+
1740+
[.description]
1741+
--
1742+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
1743+
--
1744+
|`Set`
1745+
|
1746+
17111747
a| [[quarkus-maven-plugin-goal-generate-code-tests-repoSession]] repoSession
17121748

17131749
[.description]
@@ -1995,6 +2031,15 @@ The properties of the plugin.
19952031
|`Map`
19962032
|
19972033

2034+
a| [[quarkus-maven-plugin-goal-image-build-reloadPoms]] reloadPoms
2035+
2036+
[.description]
2037+
--
2038+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
2039+
--
2040+
|`Set`
2041+
|
2042+
19982043
a| [[quarkus-maven-plugin-goal-image-build-repoSession]] repoSession
19992044

20002045
[.description]
@@ -2202,6 +2247,15 @@ The properties of the plugin.
22022247
|`Map`
22032248
|
22042249

2250+
a| [[quarkus-maven-plugin-goal-image-push-reloadPoms]] reloadPoms
2251+
2252+
[.description]
2253+
--
2254+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
2255+
--
2256+
|`Set`
2257+
|
2258+
22052259
a| [[quarkus-maven-plugin-goal-image-push-repoSession]] repoSession
22062260

22072261
[.description]
@@ -2597,6 +2651,15 @@ The properties of the plugin.
25972651
|`Map`
25982652
|
25992653

2654+
a| [[quarkus-maven-plugin-goal-native-image-agent-reloadPoms]] reloadPoms
2655+
2656+
[.description]
2657+
--
2658+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
2659+
--
2660+
|`Set`
2661+
|
2662+
26002663
a| [[quarkus-maven-plugin-goal-native-image-agent-repoSession]] repoSession
26012664

26022665
[.description]
@@ -2736,6 +2799,15 @@ The properties of the plugin.
27362799
|`Map`
27372800
|
27382801

2802+
a| [[quarkus-maven-plugin-goal-prepare-reloadPoms]] reloadPoms
2803+
2804+
[.description]
2805+
--
2806+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
2807+
--
2808+
|`Set`
2809+
|
2810+
27392811
a| [[quarkus-maven-plugin-goal-prepare-repoSession]] repoSession
27402812

27412813
[.description]
@@ -2884,6 +2956,15 @@ The properties of the plugin.
28842956
|`Map`
28852957
|
28862958

2959+
a| [[quarkus-maven-plugin-goal-prepare-tests-reloadPoms]] reloadPoms
2960+
2961+
[.description]
2962+
--
2963+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
2964+
--
2965+
|`Set`
2966+
|
2967+
28872968
a| [[quarkus-maven-plugin-goal-prepare-tests-repoSession]] repoSession
28882969

28892970
[.description]
@@ -3411,6 +3492,15 @@ The properties of the plugin.
34113492
|`Map`
34123493
|
34133494

3495+
a| [[quarkus-maven-plugin-goal-run-reloadPoms]] reloadPoms
3496+
3497+
[.description]
3498+
--
3499+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
3500+
--
3501+
|`Set`
3502+
|
3503+
34143504
a| [[quarkus-maven-plugin-goal-run-repoSession]] repoSession
34153505

34163506
[.description]
@@ -3859,6 +3949,15 @@ a| [[quarkus-maven-plugin-goal-track-config-changes-quarkus.recorded-build-confi
38593949
|`String`
38603950
|
38613951

3952+
a| [[quarkus-maven-plugin-goal-track-config-changes-reloadPoms]] reloadPoms
3953+
3954+
[.description]
3955+
--
3956+
POM files from the workspace that should be reloaded from the disk instead of taken from the Maven reactor. This parameter is not supposed to be configured by a user.
3957+
--
3958+
|`Set`
3959+
|
3960+
38623961
a| [[quarkus-maven-plugin-goal-track-config-changes-repoSession]] repoSession
38633962

38643963
[.description]

_versions/main/guides/logging.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,9 @@ For extension development, use `org.jboss.logging.Logger.getLogger(String)` inst
143143

144144
The injection of a configured `org.jboss.logging.Logger` logger instance with the `@Inject` annotation is another alternative to adding an application logger, but is applicable only to CDI beans.
145145

146-
You can use `@Inject Logger log`, where the logger gets named after the class you inject it to, or `@Inject @LoggerName("...") Logger log`, where the logger will receive the specified name.
146+
You can use `@Inject Logger log`, where the logger gets named after the class you inject it to, or `@LoggerName("...") Logger log`, where the logger will receive the specified name. Notice, that `@Inject`
147+
is not required if you already annotated your `Logger` with `@LoggerName("...")`.
148+
147149
Once injected, you can use the `log` object to invoke logging methods.
148150

149151
.An example of two different types of logger injection:

_versions/main/guides/stork-kubernetes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ The various integrations in Quarkus extract the location of the service from tha
6161

6262
== Bootstrapping the project
6363

64-
Create a Quarkus project importing the quarkus-rest-client and quarkus-rest extensions using your favorite approach:
64+
Create a Quarkus project importing the quarkus-rest-client, quarkus-rest, and quarkus-smallrye-stork extensions using your favorite approach:
6565

6666
:create-app-artifact-id: stork-kubernetes-quickstart
67-
:create-app-extensions: quarkus-rest-client,quarkus-rest
67+
:create-app-extensions: quarkus-rest-client,quarkus-rest,quarkus-smallrye-stork
6868
include::{includes}/devtools/create-app.adoc[]
6969

7070
In the generated project, also add the following dependencies:

_versions/main/guides/stork.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ image::stork-process.png[Discovery and Selection of services,width=50%, align=ce
7070

7171
== Bootstrapping the project
7272

73-
Create a Quarkus project importing the quarkus-rest-client and quarkus-rest extensions using your favorite approach:
73+
Create a Quarkus project importing the quarkus-rest-client, quarkus-rest, and quarkus-smallrye-stork extensions using your favorite approach:
7474

7575
:create-app-artifact-id: stork-quickstart
76-
:create-app-extensions: quarkus-rest-client,quarkus-rest
76+
:create-app-extensions: quarkus-rest-client,quarkus-rest,quarkus-smallrye-stork
7777
include::{includes}/devtools/create-app.adoc[]
7878

7979
In the generated project, also add the following dependencies:

_versions/main/guides/websockets-next-reference.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1029,6 +1029,8 @@ public class ProductEndpoint {
10291029
<1> The `getProduct` callback method can only be invoked if the current security identity has an `admin` role or the user is allowed to get the product detail.
10301030
<2> The error handler is invoked in case of the authorization failure.
10311031

1032+
More information about permission checkers can be found on the JavaDoc of link:https://javadoc.io/doc/io.quarkus.security/quarkus-security/latest/io.quarkus.security.api/io/quarkus/security/PermissionChecker.html[`@PermissionChecker`].
1033+
10321034
==== Bearer token authentication
10331035

10341036
The xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication] expects that the bearer token is passed in the `Authorization` header during the initial HTTP handshake.

0 commit comments

Comments
 (0)