Skip to content

Commit

Permalink
Sync web site with Quarkus documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quarkusbot committed Jan 11, 2024
1 parent 41b6dba commit 739b2e2
Show file tree
Hide file tree
Showing 16 changed files with 59 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.form-field-name","additionalKeys":[],"configDoc":"Form field name which keeps a CSRF token.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"form-field-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-header-name","additionalKeys":[],"configDoc":"Token header which can provide a CSRF token.","withinAMap":false,"defaultValue":"X-CSRF-TOKEN","javaDocSiteLink":"","docMapKey":"token-header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-name","additionalKeys":[],"configDoc":"CSRF cookie name.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.csrf-reactive.cookie-max-age","additionalKeys":[],"configDoc":"CSRF cookie max age.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cookie-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-path","additionalKeys":[],"configDoc":"CSRF cookie path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-domain","additionalKeys":[],"configDoc":"CSRF cookie domain.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-http-only","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"cookie-http-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.create-token-path","additionalKeys":[],"configDoc":"Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.csrf-reactive.token-size","additionalKeys":[],"configDoc":"Random CSRF token size in bytes.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"token-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-signature-key","additionalKeys":[],"configDoc":"CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-signature-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.verify-token","additionalKeys":[],"configDoc":"Verify CSRF token in the CSRF filter. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the `form-field-name` form property and jakarta.ws.rs.CookieParam which refers to the `CsrfReactiveConfig++#++cookieName` cookie. Note that even if the CSRF token verification in the CSRF filter is disabled, the filter will still perform checks to ensure the token is available, has the correct `token-size` in bytes and that the Content-Type HTTP header is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.require-form-url-encoded","additionalKeys":[],"configDoc":"Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if `verify-token` property is enabled and `token-header-name` is not configured.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"require-form-url-encoded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}}]
[{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.form-field-name","additionalKeys":[],"configDoc":"Form field name which keeps a CSRF token.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"form-field-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-header-name","additionalKeys":[],"configDoc":"Token header which can provide a CSRF token.","withinAMap":false,"defaultValue":"X-CSRF-TOKEN","javaDocSiteLink":"","docMapKey":"token-header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-name","additionalKeys":[],"configDoc":"CSRF cookie name.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.csrf-reactive.cookie-max-age","additionalKeys":[],"configDoc":"CSRF cookie max age.","withinAMap":false,"defaultValue":"2H","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cookie-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-path","additionalKeys":[],"configDoc":"CSRF cookie path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-domain","additionalKeys":[],"configDoc":"CSRF cookie domain.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-http-only","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"cookie-http-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.create-token-path","additionalKeys":[],"configDoc":"Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.csrf-reactive.token-size","additionalKeys":[],"configDoc":"Random CSRF token size in bytes.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"token-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-signature-key","additionalKeys":[],"configDoc":"CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-signature-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.verify-token","additionalKeys":[],"configDoc":"Verify CSRF token in the CSRF filter. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the `form-field-name` form property and jakarta.ws.rs.CookieParam which refers to the `CsrfReactiveConfig++#++cookieName` cookie. Note that even if the CSRF token verification in the CSRF filter is disabled, the filter will still perform checks to ensure the token is available, has the correct `token-size` in bytes and that the Content-Type HTTP header is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.require-form-url-encoded","additionalKeys":[],"configDoc":"Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if `verify-token` property is enabled and `token-header-name` is not configured.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"require-form-url-encoded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}}]
4 changes: 4 additions & 0 deletions _generated-doc/latest/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1832,6 +1832,10 @@ a| `String providerClass` :: +++<i>No Javadoc found</i>+++
[%header,cols=2*]
|===
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment/src/main/java/io/quarkus/resteasy/reactive/server/deployment/BuiltInReaderOverrideBuildItem.java[`io.quarkus.resteasy.reactive.server.deployment.BuiltInReaderOverrideBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String readerClassName` :: +++<i>No Javadoc found</i>+++
`String overrideClassName` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment/src/main/java/io/quarkus/resteasy/reactive/server/deployment/ContextResolversBuildItem.java[`io.quarkus.resteasy.reactive.server.deployment.ContextResolversBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `ContextResolvers contextResolvers` :: +++<i>No Javadoc found</i>+++
Expand Down
2 changes: 1 addition & 1 deletion _generated-doc/latest/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4658,7 +4658,7 @@ Environment variable: `+++QUARKUS_CSRF_REACTIVE_COOKIE_MAX_AGE+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
|`10M`
|`2H`


a| [[quarkus-csrf-reactive_quarkus.csrf-reactive.cookie-path]]`link:#quarkus-csrf-reactive_quarkus.csrf-reactive.cookie-path[quarkus.csrf-reactive.cookie-path]`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Environment variable: `+++QUARKUS_CSRF_REACTIVE_COOKIE_MAX_AGE+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
|`10M`
|`2H`


a| [[quarkus-csrf-reactive-csrf-reactive-config_quarkus.csrf-reactive.cookie-path]]`link:#quarkus-csrf-reactive-csrf-reactive-config_quarkus.csrf-reactive.cookie-path[quarkus.csrf-reactive.cookie-path]`
Expand Down
2 changes: 1 addition & 1 deletion _generated-doc/latest/config/quarkus-csrf-reactive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Environment variable: `+++QUARKUS_CSRF_REACTIVE_COOKIE_MAX_AGE+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
|`10M`
|`2H`


a| [[quarkus-csrf-reactive_quarkus.csrf-reactive.cookie-path]]`link:#quarkus-csrf-reactive_quarkus.csrf-reactive.cookie-path[quarkus.csrf-reactive.cookie-path]`
Expand Down
4 changes: 2 additions & 2 deletions _guides/_attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Common attributes.
// --> No blank lines (it ends the document header)
:project-name: Quarkus
:quarkus-version: 3.6.4
:quarkus-version: 3.6.5
:quarkus-platform-groupid: io.quarkus.platform
// .
:maven-version: 3.9.6
Expand All @@ -21,7 +21,7 @@
:keycloak-docker-image: quay.io/keycloak/keycloak:23.0.0
:jandex-version: 3.1.6
:jandex-gradle-plugin-version: 1.0.0
:kotlin-version: 1.9.21
:kotlin-version: 1.9.22
:grpc-version: 1.59.0
:protoc-version: 3.24.4
:gcf-invoker-version: 1.3.0
Expand Down
2 changes: 0 additions & 2 deletions _guides/cache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ include::_attributes.adoc[]

In this guide, you will learn how to enable application data caching in any CDI managed bean of your Quarkus application.

include::{includes}/extension-status.adoc[]

== Prerequisites

include::{includes}/prerequisites.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion _guides/getting-started-testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1088,7 +1088,7 @@ or starting a mock HTTP server using https://wiremock.org/[Wiremock] (an example


=== Altering the test class
When creating a custom `QuarkusTestResourceLifecycleManager` that needs to inject the something into the test class, the `inject` methods can be used.
When creating a custom `QuarkusTestResourceLifecycleManager` that needs to inject something into the test class, the `inject` methods can be used.
If for example you have a test like the following:

[source,java]
Expand Down
2 changes: 1 addition & 1 deletion _guides/kafka-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ For Strimzi, you can select any image with a Kafka version which has Kraft suppo

[source, properties]
----
quarkus.kafka.devservices.image-name=quay.io/strimzi-test-container/test-container:0.100.0-kafka-3.1.0
quarkus.kafka.devservices.image-name=quay.io/strimzi-test-container/test-container:0.105.0-kafka-3.6.0
----

== Configuring Kafka topics
Expand Down
4 changes: 2 additions & 2 deletions _guides/kafka-reactive-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ version: '3.5'
services:
zookeeper:
image: quay.io/strimzi/kafka:0.23.0-kafka-2.8.0
image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1
command: [
"sh", "-c",
"bin/zookeeper-server-start.sh config/zookeeper.properties"
Expand All @@ -420,7 +420,7 @@ services:
- kafka-quickstart-network
kafka:
image: quay.io/strimzi/kafka:0.23.0-kafka-2.8.0
image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1
command: [
"sh", "-c",
"bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT}"
Expand Down
8 changes: 4 additions & 4 deletions _guides/kafka-schema-registry-avro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ version: '2'
services:
zookeeper:
image: quay.io/strimzi/kafka:0.22.1-kafka-2.7.0
image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1
command: [
"sh", "-c",
"bin/zookeeper-server-start.sh config/zookeeper.properties"
Expand All @@ -335,7 +335,7 @@ services:
LOG_DIR: /tmp/logs
kafka:
image: quay.io/strimzi/kafka:0.22.1-kafka-2.7.0
image: quay.io/strimzi/kafka:0.39.0-kafka-3.6.1
command: [
"sh", "-c",
"bin/kafka-server-start.sh config/server.properties --override listeners=$${KAFKA_LISTENERS} --override advertised.listeners=$${KAFKA_ADVERTISED_LISTENERS} --override zookeeper.connect=$${KAFKA_ZOOKEEPER_CONNECT}"
Expand Down Expand Up @@ -545,7 +545,7 @@ If we couldn't use Dev Services and wanted to start a Kafka broker and Apicurio
<dependency>
<groupId>io.strimzi</groupId>
<artifactId>strimzi-test-container</artifactId>
<version>0.22.1</version>
<version>0.105.0</version>
<scope>test</scope>
<exclusions>
<exclusion>
Expand All @@ -559,7 +559,7 @@ If we couldn't use Dev Services and wanted to start a Kafka broker and Apicurio
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
.build.gradle
----
testImplementation("io.strimzi:strimzi-test-container:0.22.1") {
testImplementation("io.strimzi:strimzi-test-container:0.105.0") {
exclude group: "org.apache.logging.log4j", module: "log4j-core"
}
----
Expand Down
Loading

0 comments on commit 739b2e2

Please sign in to comment.