Skip to content

Commit 0a5f66f

Browse files
author
quarkusbot
committed
Sync web site with Quarkus documentation
1 parent 6e8b498 commit 0a5f66f

10 files changed

+69
-14
lines changed

_generated-doc/3.20/infra/quarkus-all-build-items.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7235,7 +7235,11 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/r
72357235
[.description]
72367236
--
72377237
Represents a JAX-RS resource that is generated. Meant to be used by extension that generate JAX-RS resources as part of their build time processing
7238-
-- a|`java.lang.String name`
7238+
-- a|`java.lang.String binaryName`
7239+
7240+
_No Javadoc found_
7241+
7242+
`java.lang.String internalName`
72397243

72407244
_No Javadoc found_
72417245

_versions/3.20/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Common attributes.
22
// --> No blank lines (it ends the document header)
33
:project-name: Quarkus
4-
:quarkus-version: 3.20.1
4+
:quarkus-version: 3.20.2
55
:quarkus-platform-groupid: io.quarkus.platform
66
// .
77
:maven-version: 3.9.9

_versions/3.20/guides/databases-dev-services.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,14 @@ Dev Services volumes can be mapped to the filesystem or the classpath:
150150
# Using a filesystem volume:
151151
quarkus.datasource.devservices.volumes."/path/from"=/container/to <1>
152152
# Using a classpath volume:
153-
quarkus.datasource.devservices.volumes."classpath:./file"=/container/to <2>
153+
quarkus.datasource.devservices.volumes."classpath\:./file"=/container/to <2>
154154
----
155155

156156
<1> The file or folder "/path/from" from the local machine will be accessible at "/container/to" in the container.
157157
<2> When using classpath volumes, the location has to start with "classpath:". The file or folder "./file" from the project's classpath will be accessible at "/container/to" in the container.
158158

159+
CAUTION: The colon character `:` needs to be escaped in `.properties` files as `\:`, or it will be interpreted as a key/value separator.
160+
159161
IMPORTANT: when using a classpath volume, the container will only be granted read permission. On the other hand, when using a filesystem volume, the container will be granted read and write permission.
160162

161163
=== Example of mapping volumes to persist the database data
@@ -217,7 +219,7 @@ Login credentials are the same for most databases, except when the database requ
217219
|`quarkus` for the default datasource or name of the datasource
218220

219221
|Microsoft SQL Server
220-
|`SA`
222+
|`sa`
221223
|`Quarkus123`
222224
|
223225

_versions/3.20/guides/flyway.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,3 +448,27 @@ quarkus.openshift.init-task-defaults.wait-for-container.image=my/wait-for-image:
448448
----
449449

450450
**Note**: In this context globally means `for all extensions that support init task externalization`.
451+
452+
== Known Issues in Flyway
453+
454+
=== Oracle: Multiple schemas in Dev Services
455+
456+
When having multiple schemas in Oracle, you can use the `quarkus.flyway.schemas` property to specify the schemas that Flyway should manage.
457+
However, because this is executed in the DB as the `quarkus` user, you need to either give DBA privileges to the user that is executing the migration (`quarkus`) or perform the necessary DDLs before the Dev Service starts. This is done with the `quarkus.datasource.devservices.init-script-path` configuration.
458+
459+
==== Giving DBA privileges to the user
460+
461+
- In your application, create a SQL file named `001-devservice-init.sql` (for ordering purposes, it can be any name really) in your `src/main/resources` with the following content:
462+
463+
[source,sql]
464+
----
465+
ALTER SESSION SET CONTAINER=quarkus;
466+
GRANT DBA TO quarkus;
467+
----
468+
469+
- Add the following configuration to your `application.properties`:
470+
471+
[source,properties]
472+
----
473+
quarkus.datasource.devservices.init-script-path=001-devservice-init.sql
474+
----

_versions/3.20/guides/observability-devservices-lgtm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ This is the most common way to output metrics from Micrometer and the default wa
5353
.pom.xml
5454
----
5555
<dependency>
56-
<groupId>io.quarkiverse.micrometer.registry</groupId>
56+
<groupId>io.quarkus</groupId>
5757
<artifactId>quarkus-micrometer-registry-prometheus</artifactId>
5858
</dependency>
5959
----
6060

6161
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
6262
.build.gradle
6363
----
64-
implementation("io.quarkiverse.micrometer.registry:quarkus-micrometer-registry-prometheus")
64+
implementation("io.quarkus:quarkus-micrometer-registry-prometheus")
6565
----
6666

6767
==== Using the Micrometer OTLP registry

_versions/3.20/guides/qute-reference.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2041,9 +2041,13 @@ public class ItemResource {
20412041
[[type_safe_fragments]]
20422042
==== Type-safe Fragments
20432043

2044-
You can also define a type-safe <<fragments,fragment>> in your Java code.
2045-
A _native static_ method with the name that contains a dollar sign `$` denotes a method that represents a fragment of a type-safe template.
2046-
The name of the fragment is derived from the annotated method name.
2044+
You can also define a type-safe <<fragments,fragment>> of a type-safe template in your Java code.
2045+
There are two ways to define a type-safe fragment:
2046+
2047+
1. A _native static_ method annotated with `@CheckedTemplate`, with a name that contains a dollar sign `$`.
2048+
2. A Java record that implements `io.quarkus.qute.TemplateInstance` and its name contains a dollar sign `$`.
2049+
2050+
The name of the fragment is derived from the annotated member name.
20472051
The part before the last occurrence of a dollar sign `$` is the method name of the related type-safe template.
20482052
The part after the last occurrence of a dollar sign is the fragment identifier.
20492053
The strategy defined by the relevant `CheckedTemplate#defaultName()` is honored when constructing the defaulted names.
@@ -2062,6 +2066,9 @@ class Templates {
20622066
20632067
// defines a fragment of Templates#items() with identifier "item"
20642068
static native TemplateInstance items$item(Item item); <1>
2069+
2070+
// type-safe fragment as a Java record - functionally equivalent to the items$item() method above
2071+
record items$item(Item item) implements TemplateInstance {}
20652072
}
20662073
----
20672074
<1> Quarkus validates at build time that each template that corresponds to the `Templates#items()` contains a fragment with identifier `item`. Moreover, the parameters of the fragment method are validated too. In general, all type-safe expressions that are found in the fragment and that reference some data from the original/outer template require a specific parameter to be present.

_versions/3.20/guides/security-jwt-build.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ SmallRye JWT supports the following properties, which can be used to customize h
370370
|`smallrye.jwt.new-token.issuer` |none |Token issuer used to set an `iss` (issuer) claim value if this claim has not already been set.
371371
|`smallrye.jwt.new-token.audience` |none |Token audience used to set an `aud` (audience) claim value if this claim has not already been set.
372372
|`smallrye.jwt.new-token.override-matching-claims` |`false` | Set this property to `true` for `smallrye.jwt.new-token.issuer` and `smallrye.jwt.new-token.audience` values to override the already initialized `iss` (issuer) and `aud` (audience) claims.
373+
|smallrye.jwt.new-token.add-default-claims|true|Set this property to `false` to disable an automatic addition of the `iat` (issued at), `exp` (expiration time) and `jti` (token identifier) claims when such claims have not already been set.
373374
|`smallrye.jwt.keystore.type` |`JKS` |This property can be used to customize a keystore type if either `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` or both of these properties point to a `KeyStore` file. If it is not set then the file name will be checked to determine the keystore type before defaulting to `JKS`.
374375
|`smallrye.jwt.keystore.provider` | |This property can be used to customize a `KeyStore` provider if `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` point to a `KeyStore` file.
375376
|`smallrye.jwt.keystore.password` | |Keystore password. If `smallrye.jwt.sign.key.location` or `smallrye.jwt.encrypt.key.location` point to a `KeyStore` file, this property must be set.

_versions/3.20/guides/security-openid-connect-providers.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,21 @@ quarkus.oidc.client-id=<Client ID>
230230
quarkus.oidc.credentials.secret=<Secret>
231231
----
232232

233+
[NOTE]
234+
====
235+
By default, Quarkus GitHub provider submits the client id and secret in the HTTP Authorization header.
236+
However, GitHub may require that both client id and secret are submitted as form parameters instead.
237+
When you get HTTP 401 error after logging in to GitHub and being redirected back to Quarkus MCP server,
238+
replace the `quarkus.oidc.credentials.secret=<Secret>` property
239+
with the following two properties instead:
240+
241+
[source,properties]
242+
----
243+
quarkus.oidc.credentials.client-secret.method=post
244+
quarkus.oidc.credentials.client-secret.value=<Secret>
245+
----
246+
====
247+
233248
`quarkus.oidc.provider=github` will request GitHub to add a `user:email` scope to issued access tokens. For information about overriding this scope or requesting more scopes, see the <<provider-scope>> section.
234249

235250
TIP: You can also send access tokens issued by GitHub to `quarkus.oidc.application-type=service` or `quarkus.oidc.application-type=hybrid` Quarkus applications.

_versions/3.20/guides/telemetry-micrometer.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -727,15 +727,17 @@ The value cannot be overridden at runtime.
727727
If you enable the management interface without customizing the management network interface and port, the metrics are exposed under: `http://0.0.0.0:9000/q/metrics`.
728728

729729
You can configure the path of each exposed format using:
730+
730731
[source, properties]
731732
----
732-
quarkus.micrometer.export.json.enabled=true # Enable json metrics
733+
quarkus.micrometer.export.json.enabled=true <1>
733734
quarkus.micrometer.export.json.path=metrics/json
734735
quarkus.micrometer.export.prometheus.path=metrics/prometheus
735736
----
737+
<1> Enable JSON metrics
736738

737-
With such a configuration, the json metrics will be available from `http://0.0.0.0:9000/q/metrics/json`.
738-
The prometheus metrics will be available from `http://0.0.0.0:9000/q/metrics/prometheus`.
739+
With such a configuration, the JSON metrics will be available from `http://0.0.0.0:9000/q/metrics/json`.
740+
The Prometheus metrics will be available from `http://0.0.0.0:9000/q/metrics/prometheus`.
739741

740742
Refer to the xref:./management-interface-reference.adoc[management interface reference] for more information.
741743

_versions/3.20/guides/vertx-reference.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,7 +704,7 @@ The `EventBus` object provides methods to:
704704
[source, java]
705705
----
706706
// Case 1
707-
bus.sendAndForget("greeting", name)
707+
bus.send("greeting", name)
708708
// Case 2
709709
bus.publish("greeting", name)
710710
// Case 3
@@ -730,7 +730,7 @@ Read xref:./virtual-threads.adoc[the virtual thread guide] for more details.
730730

731731
=== Use codecs
732732

733-
The https://vertx.io/docs/vertx-core/java/#event_bus[Vert.x Event Bus] uses https://vertx.io/docs/vertx-core/java/#_message_codecs[codecs] to _serialize_ and _deserialize_ message objects.
733+
The link:++https://vertx.io/docs/vertx-core/java/#event_bus++[Vert.x Event Bus] uses link:++https://vertx.io/docs/vertx-core/java/#_message_codecs++[codecs] to _serialize_ and _deserialize_ message objects.
734734
Quarkus provides a default codec for local delivery.
735735
This codec is automatically used for return types and message body parameters of local consumers, i.e. methods annotated with `@ConsumeEvent` where `ConsumeEvent#local() == true` (which is the default).
736736

0 commit comments

Comments
 (0)