Skip to content

Commit 3fea007

Browse files
committed
Sync documentation of main branch
1 parent 2d0e10d commit 3fea007

File tree

35 files changed

+951
-846
lines changed

35 files changed

+951
-846
lines changed

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientBuildConfig

Lines changed: 0 additions & 1 deletion
This file was deleted.

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig

Lines changed: 0 additions & 1 deletion
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".scope","additionalKeys":[],"configDoc":"The CDI scope to use for injection. This property can contain either a fully qualified class name of a CDI scope annotation (such as \"jakarta.enterprise.context.ApplicationScoped\") or its simple name (such as \"ApplicationScoped\"). By default, this is not set which means the interface is not registered as a bean unless it is annotated with `RegisterRestClient`. If an interface is not annotated with `RegisterRestClient` and this property is set, then Quarkus will make the interface a bean of the configured scope.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SCOPE","enum":false}},{"configDocKey":{"type":"boolean","key":".enable-local-proxy","additionalKeys":[],"configDoc":"If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy server (that is managed by Quarkus). This can be very useful for capturing network traffic to a service that uses HTTPS.\n\nThis property is not applicable to the RESTEasy Client, only the Quarkus REST client (formerly RESTEasy Reactive client).\n\nThis property only applicable to dev and test mode.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-local-proxy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLE_LOCAL_PROXY","enum":false}},{"configDocKey":{"type":"string","key":".local-proxy-provider","additionalKeys":[],"configDoc":"This setting is used to select which proxy provider to use if there are multiple ones. It only applies if `enable-local-proxy` is true.\n\nThe algorithm for picking between multiple provider is the following:\n\n - If only the default is around, use it (its name is `default`)\n - If there is only one besides the default, use it\n - If there are multiple ones, fail","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-proxy-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_LOCAL_PROXY_PROVIDER","enum":false}}]

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientsConfig.RestClientConfig

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.container.image.jib.deployment.ContainerImageJibConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.container.image.openshift.deployment.ContainerImageOpenshiftConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"io.quarkus.container.image.openshift.deployment.BuildStrategy","key":"quarkus.s2i.build-strategy","additionalKeys":[],"configDoc":"The build config strategy to use.","withinAMap":false,"defaultValue":"binary","javaDocSiteLink":"","docMapKey":"build-strategy","configPhase":"BUILD_TIME","acceptedValues":["`binary`","`docker`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-jvm-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21:1.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.19` is used as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"base-jvm-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_JVM_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-native-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the native binary build","withinAMap":false,"defaultValue":"quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0","javaDocSiteLink":"","docMapKey":"base-native-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_NATIVE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jvm-arguments","additionalKeys":[],"configDoc":"The JVM arguments to pass to the JVM when starting the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jvm-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JVM_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-arguments","additionalKeys":[],"configDoc":"Additional arguments to pass when starting the native application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-directory","additionalKeys":[],"configDoc":"The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.","withinAMap":false,"defaultValue":"/deployments/target/","javaDocSiteLink":"","docMapKey":"jar-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-file-name","additionalKeys":[],"configDoc":"The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jar-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-directory","additionalKeys":[],"configDoc":"The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.","withinAMap":false,"defaultValue":"/home/quarkus/","javaDocSiteLink":"","docMapKey":"native-binary-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-file-name","additionalKeys":[],"configDoc":"The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-binary-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_FILE_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.s2i.build-timeout","additionalKeys":[],"configDoc":"The build timeout.","withinAMap":false,"defaultValue":"PT5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"build-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_TIMEOUT","enum":false}}]
1+
[{"configDocKey":{"type":"io.quarkus.container.image.openshift.deployment.BuildStrategy","key":"quarkus.s2i.build-strategy","additionalKeys":[],"configDoc":"The build config strategy to use.","withinAMap":false,"defaultValue":"binary","javaDocSiteLink":"","docMapKey":"build-strategy","configPhase":"BUILD_TIME","acceptedValues":["`binary`","`docker`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-jvm-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.20` is used as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"base-jvm-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_JVM_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-native-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the native binary build","withinAMap":false,"defaultValue":"quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0","javaDocSiteLink":"","docMapKey":"base-native-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_NATIVE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jvm-arguments","additionalKeys":[],"configDoc":"The JVM arguments to pass to the JVM when starting the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jvm-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JVM_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-arguments","additionalKeys":[],"configDoc":"Additional arguments to pass when starting the native application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-directory","additionalKeys":[],"configDoc":"The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.","withinAMap":false,"defaultValue":"/deployments/target/","javaDocSiteLink":"","docMapKey":"jar-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-file-name","additionalKeys":[],"configDoc":"The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jar-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-directory","additionalKeys":[],"configDoc":"The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.","withinAMap":false,"defaultValue":"/home/quarkus/","javaDocSiteLink":"","docMapKey":"native-binary-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-file-name","additionalKeys":[],"configDoc":"The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-binary-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_FILE_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.s2i.build-timeout","additionalKeys":[],"configDoc":"The build timeout.","withinAMap":false,"defaultValue":"PT5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"build-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_TIMEOUT","enum":false}}]

0 commit comments

Comments
 (0)