Skip to content

Commit fad04d2

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 23a7b88 commit fad04d2

File tree

5 files changed

+103
-6
lines changed

5 files changed

+103
-6
lines changed

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90182,6 +90182,29 @@ endif::add-copy-button-to-env-var[]
9018290182
a|list of `uuid`, `object`, `json`
9018390183
|
9018490184

90185+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name[`quarkus.smallrye-graphql.authorization-client-init-payload-name`]##
90186+
ifdef::add-copy-button-to-config-props[]
90187+
config_property_copy_button:+++quarkus.smallrye-graphql.authorization-client-init-payload-name+++[]
90188+
endif::add-copy-button-to-config-props[]
90189+
90190+
90191+
[.description]
90192+
--
90193+
The name of the key inside the client init payload which contains Authorization information. The associated value of this is treated in the same way as sent over as a Authorization header. Using headers is the preferred way, however in some languages, such as JavaScript, it is not possible to send headers over websockets. +
90194+
If sending headers are not an option, another viable option is link:https://quarkus.io/guides/websockets-next-reference#bearer-token-authentication[Bearer Token Authentication] which might be preferable over this in some cases as it's able to inject headers before the WebSocket is opened. +
90195+
Default is undefined, which means the client init payload will not be checked for Authorization information.
90196+
90197+
90198+
ifdef::add-copy-button-to-env-var[]
90199+
Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++[]
90200+
endif::add-copy-button-to-env-var[]
90201+
ifndef::add-copy-button-to-env-var[]
90202+
Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++`
90203+
endif::add-copy-button-to-env-var[]
90204+
--
90205+
|string
90206+
|
90207+
9018590208
a| [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled[`quarkus.smallrye-graphql.ui.enabled`]##
9018690209
ifdef::add-copy-button-to-config-props[]
9018790210
config_property_copy_button:+++quarkus.smallrye-graphql.ui.enabled+++[]

‎_generated-doc/main/config/quarkus-smallrye-graphql.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,29 @@ endif::add-copy-button-to-env-var[]
616616
a|list of `uuid`, `object`, `json`
617617
|
618618

619+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name[`quarkus.smallrye-graphql.authorization-client-init-payload-name`]##
620+
ifdef::add-copy-button-to-config-props[]
621+
config_property_copy_button:+++quarkus.smallrye-graphql.authorization-client-init-payload-name+++[]
622+
endif::add-copy-button-to-config-props[]
623+
624+
625+
[.description]
626+
--
627+
The name of the key inside the client init payload which contains Authorization information. The associated value of this is treated in the same way as sent over as a Authorization header. Using headers is the preferred way, however in some languages, such as JavaScript, it is not possible to send headers over websockets. +
628+
If sending headers are not an option, another viable option is link:https://quarkus.io/guides/websockets-next-reference#bearer-token-authentication[Bearer Token Authentication] which might be preferable over this in some cases as it's able to inject headers before the WebSocket is opened. +
629+
Default is undefined, which means the client init payload will not be checked for Authorization information.
630+
631+
632+
ifdef::add-copy-button-to-env-var[]
633+
Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++[]
634+
endif::add-copy-button-to-env-var[]
635+
ifndef::add-copy-button-to-env-var[]
636+
Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++`
637+
endif::add-copy-button-to-env-var[]
638+
--
639+
|string
640+
|
641+
619642
a| [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled[`quarkus.smallrye-graphql.ui.enabled`]##
620643
ifdef::add-copy-button-to-config-props[]
621644
config_property_copy_button:+++quarkus.smallrye-graphql.ui.enabled+++[]

‎_generated-doc/main/config/quarkus-smallrye-graphql_quarkus.smallrye-graphql.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,29 @@ endif::add-copy-button-to-env-var[]
616616
a|list of `uuid`, `object`, `json`
617617
|
618618

619+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-authorization-client-init-payload-name[`quarkus.smallrye-graphql.authorization-client-init-payload-name`]##
620+
ifdef::add-copy-button-to-config-props[]
621+
config_property_copy_button:+++quarkus.smallrye-graphql.authorization-client-init-payload-name+++[]
622+
endif::add-copy-button-to-config-props[]
623+
624+
625+
[.description]
626+
--
627+
The name of the key inside the client init payload which contains Authorization information. The associated value of this is treated in the same way as sent over as a Authorization header. Using headers is the preferred way, however in some languages, such as JavaScript, it is not possible to send headers over websockets. +
628+
If sending headers are not an option, another viable option is link:https://quarkus.io/guides/websockets-next-reference#bearer-token-authentication[Bearer Token Authentication] which might be preferable over this in some cases as it's able to inject headers before the WebSocket is opened. +
629+
Default is undefined, which means the client init payload will not be checked for Authorization information.
630+
631+
632+
ifdef::add-copy-button-to-env-var[]
633+
Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++[]
634+
endif::add-copy-button-to-env-var[]
635+
ifndef::add-copy-button-to-env-var[]
636+
Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_AUTHORIZATION_CLIENT_INIT_PAYLOAD_NAME+++`
637+
endif::add-copy-button-to-env-var[]
638+
--
639+
|string
640+
|
641+
619642
a| [[quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled]] [.property-path]##link:#quarkus-smallrye-graphql_quarkus-smallrye-graphql-ui-enabled[`quarkus.smallrye-graphql.ui.enabled`]##
620643
ifdef::add-copy-button-to-config-props[]
621644
config_property_copy_button:+++quarkus.smallrye-graphql.ui.enabled+++[]

‎_versions/main/guides/blaze-persistence.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Add the following dependencies to your project:
5151
</dependency>
5252
<dependency>
5353
<groupId>com.blazebit</groupId>
54-
<artifactId>blaze-persistence-integration-hibernate-7.0</artifactId>
54+
<artifactId>blaze-persistence-integration-hibernate-7.1</artifactId>
5555
<scope>runtime</scope>
5656
</dependency>
5757
----
@@ -60,7 +60,7 @@ Add the following dependencies to your project:
6060
.Using Gradle
6161
----
6262
implementation("com.blazebit:blaze-persistence-integration-quarkus-3")
63-
runtimeOnly("com.blazebit:blaze-persistence-integration-hibernate-7.0")
63+
runtimeOnly("com.blazebit:blaze-persistence-integration-hibernate-7.1")
6464
----
6565

6666
The use in native images requires a dependency on the entity view annotation processor that may be extracted into a separate `native` profile:

‎_versions/main/guides/writing-extensions.adoc‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,10 +1535,38 @@ This same SPI can also be used to provide a custom annotation that will substitu
15351535
==== Injecting Configuration into Recorders
15361536

15371537
Configuration objects with phase `RUNTIME` or `BUILD_AND_RUNTIME_FIXED` can be injected into recorders via constructor
1538-
injection. Just create a constructor that takes the configuration objects the recorder needs. If the recorder has multiple
1539-
constructors you can annotate the one you want Quarkus to use with `@Inject`. If the recorder wants to inject runtime config
1540-
but is also used at static init time then it needs to inject a `RuntimeValue<ConfigObject>`, this value will only be set
1541-
when the runtime methods are being invoked.
1538+
injection. The constructor requires a parameter for each configuration object type. If the Configuration object type is
1539+
declared to be in the `RUNTIME` phase, it must be wrapped in a `RuntimeValue<>` type.
1540+
1541+
[source%nowrap,java]
1542+
----
1543+
@ConfigMapping(prefix = "quarkus.btrt")
1544+
@ConfigRoot(phase = ConfigPhase.BUILD_AND_RUNTIME_FIXED)
1545+
public interface BuildAndRuntimeFixedConfig {
1546+
1547+
}
1548+
1549+
@ConfigMapping(prefix = "quarkus.rt")
1550+
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
1551+
public interface RuntimeConfig {
1552+
1553+
}
1554+
1555+
@Recorder
1556+
class ExtensionRecorder {
1557+
private final BuildAndRuntimeFixedConfig buildAndRuntimeFixedConfig;
1558+
private final RuntimeValue<RuntimeConfig> runtimeConfig;
1559+
1560+
public ExtensionRecorder(
1561+
BuildAndRuntimeFixedConfig buildAndRuntimeFixedConfig,
1562+
RuntimeValue<RuntimeConfig> runtimeConfig) {
1563+
this.buildAndRuntimeFixedConfig = buildAndRuntimeFixedConfig;
1564+
this.runtimeConfig = runtimeConfig;
1565+
}
1566+
}
1567+
----
1568+
1569+
NOTE: If the recorder has multiple constructors you can annotate the one you want Quarkus to use with `@Inject`.
15421570

15431571
==== RecorderContext
15441572

0 commit comments

Comments
 (0)