Skip to content

Commit acd1dd3

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent bc1bd59 commit acd1dd3

File tree

6 files changed

+165
-7
lines changed

6 files changed

+165
-7
lines changed

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81609,6 +81609,31 @@ endif::add-copy-button-to-env-var[]
8160981609
|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]]
8161081610
|`8k`
8161181611

81612+
a| [[quarkus-rest-client-config_quarkus-rest-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-enable-compression[`quarkus.rest-client.enable-compression`]##
81613+
ifdef::add-copy-button-to-config-props[]
81614+
config_property_copy_button:+++quarkus.rest-client.enable-compression+++[]
81615+
endif::add-copy-button-to-config-props[]
81616+
81617+
81618+
[.description]
81619+
--
81620+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
81621+
81622+
This property is not applicable to the RESTEasy Client.
81623+
81624+
Can be overwritten by client-specific settings.
81625+
81626+
81627+
ifdef::add-copy-button-to-env-var[]
81628+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++[]
81629+
endif::add-copy-button-to-env-var[]
81630+
ifndef::add-copy-button-to-env-var[]
81631+
Environment variable: `+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++`
81632+
endif::add-copy-button-to-env-var[]
81633+
--
81634+
|boolean
81635+
|
81636+
8161281637
a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]##
8161381638
ifdef::add-copy-button-to-config-props[]
8161481639
config_property_copy_button:+++quarkus.rest-client.alpn+++[]
@@ -82503,6 +82528,29 @@ endif::add-copy-button-to-env-var[]
8250382528
|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]]
8250482529
|`8K`
8250582530

82531+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
82532+
ifdef::add-copy-button-to-config-props[]
82533+
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
82534+
endif::add-copy-button-to-config-props[]
82535+
82536+
82537+
[.description]
82538+
--
82539+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
82540+
82541+
This property is not applicable to the RESTEasy Client.
82542+
82543+
82544+
ifdef::add-copy-button-to-env-var[]
82545+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
82546+
endif::add-copy-button-to-env-var[]
82547+
ifndef::add-copy-button-to-env-var[]
82548+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
82549+
endif::add-copy-button-to-env-var[]
82550+
--
82551+
|boolean
82552+
|
82553+
8250682554
a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]##
8250782555
ifdef::add-copy-button-to-config-props[]
8250882556
config_property_copy_button:+++quarkus.rest-client."client".alpn+++[]

‎_generated-doc/main/config/quarkus-rest-client-config.adoc‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,31 @@ endif::add-copy-button-to-env-var[]
711711
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
712712
|`8k`
713713

714+
a| [[quarkus-rest-client-config_quarkus-rest-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-enable-compression[`quarkus.rest-client.enable-compression`]##
715+
ifdef::add-copy-button-to-config-props[]
716+
config_property_copy_button:+++quarkus.rest-client.enable-compression+++[]
717+
endif::add-copy-button-to-config-props[]
718+
719+
720+
[.description]
721+
--
722+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
723+
724+
This property is not applicable to the RESTEasy Client.
725+
726+
Can be overwritten by client-specific settings.
727+
728+
729+
ifdef::add-copy-button-to-env-var[]
730+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++[]
731+
endif::add-copy-button-to-env-var[]
732+
ifndef::add-copy-button-to-env-var[]
733+
Environment variable: `+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++`
734+
endif::add-copy-button-to-env-var[]
735+
--
736+
|boolean
737+
|
738+
714739
a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]##
715740
ifdef::add-copy-button-to-config-props[]
716741
config_property_copy_button:+++quarkus.rest-client.alpn+++[]
@@ -1605,6 +1630,29 @@ endif::add-copy-button-to-env-var[]
16051630
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
16061631
|`8K`
16071632

1633+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
1634+
ifdef::add-copy-button-to-config-props[]
1635+
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
1636+
endif::add-copy-button-to-config-props[]
1637+
1638+
1639+
[.description]
1640+
--
1641+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
1642+
1643+
This property is not applicable to the RESTEasy Client.
1644+
1645+
1646+
ifdef::add-copy-button-to-env-var[]
1647+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
1648+
endif::add-copy-button-to-env-var[]
1649+
ifndef::add-copy-button-to-env-var[]
1650+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
1651+
endif::add-copy-button-to-env-var[]
1652+
--
1653+
|boolean
1654+
|
1655+
16081656
a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]##
16091657
ifdef::add-copy-button-to-config-props[]
16101658
config_property_copy_button:+++quarkus.rest-client."client".alpn+++[]

‎_generated-doc/main/config/quarkus-rest-client-config_quarkus.rest-client.adoc‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,31 @@ endif::add-copy-button-to-env-var[]
711711
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
712712
|`8k`
713713

714+
a| [[quarkus-rest-client-config_quarkus-rest-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-enable-compression[`quarkus.rest-client.enable-compression`]##
715+
ifdef::add-copy-button-to-config-props[]
716+
config_property_copy_button:+++quarkus.rest-client.enable-compression+++[]
717+
endif::add-copy-button-to-config-props[]
718+
719+
720+
[.description]
721+
--
722+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
723+
724+
This property is not applicable to the RESTEasy Client.
725+
726+
Can be overwritten by client-specific settings.
727+
728+
729+
ifdef::add-copy-button-to-env-var[]
730+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++[]
731+
endif::add-copy-button-to-env-var[]
732+
ifndef::add-copy-button-to-env-var[]
733+
Environment variable: `+++QUARKUS_REST_CLIENT_ENABLE_COMPRESSION+++`
734+
endif::add-copy-button-to-env-var[]
735+
--
736+
|boolean
737+
|
738+
714739
a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]##
715740
ifdef::add-copy-button-to-config-props[]
716741
config_property_copy_button:+++quarkus.rest-client.alpn+++[]
@@ -1605,6 +1630,29 @@ endif::add-copy-button-to-env-var[]
16051630
|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]]
16061631
|`8K`
16071632

1633+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-enable-compression]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-compression[`quarkus.rest-client."client".enable-compression`]##
1634+
ifdef::add-copy-button-to-config-props[]
1635+
config_property_copy_button:+++quarkus.rest-client."client".enable-compression+++[]
1636+
endif::add-copy-button-to-config-props[]
1637+
1638+
1639+
[.description]
1640+
--
1641+
Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
1642+
1643+
This property is not applicable to the RESTEasy Client.
1644+
1645+
1646+
ifdef::add-copy-button-to-env-var[]
1647+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++[]
1648+
endif::add-copy-button-to-env-var[]
1649+
ifndef::add-copy-button-to-env-var[]
1650+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_COMPRESSION+++`
1651+
endif::add-copy-button-to-env-var[]
1652+
--
1653+
|boolean
1654+
|
1655+
16081656
a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]##
16091657
ifdef::add-copy-button-to-config-props[]
16101658
config_property_copy_button:+++quarkus.rest-client."client".alpn+++[]

‎_versions/main/guides/config-reference.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ configuration name to its most likely dotted format. This works fine for fixed c
9191
names that contain dynamic segments. In this case, Quarkus is unable to determine if `DATASOURCE_NAME` should be
9292
converted to `datasource.name` or `datasource-name` (or any other special character separator).
9393
94-
For this reason, such properties always require their dotted version name in another source (the value can be left
95-
empty) to disambiguate the Environment Variable name. It will provide additional information to perform a two-way
96-
conversion and match the property names together.
94+
For this reason, such properties always require their dotted version name in another source to disambiguate the
95+
Environment Variable name. It will provide additional information to perform a two-way conversion and match the
96+
property names together.
9797
9898
[source,properties]
9999
----
100-
# value can be left empty
100+
# value can be left empty but must be supplied by another source at runtime (or be an optional)
101101
quarkus.datasource."datasource-name".jdbc.url=
102102
----
103103

‎_versions/main/guides/opentelemetry-tracing.adoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,10 @@ See the main xref:opentelemetry.adoc#exporters[OpenTelemetry Guide exporters] se
617617
* https://quarkus.io/extensions/io.quarkus/quarkus-agroal[`quarkus-agroal`]
618618
* https://quarkus.io/guides/grpc-getting-started[`quarkus-grpc`]
619619
* https://quarkus.io/guides/redis[`quarkus-redis-client`]
620-
* https://quarkus.io/extensions/io.quarkus/quarkus-rest-client-jaxrs[`quarkus-rest-client-jaxrs`]
621620
* https://quarkus.io/guides/rest[`quarkus-rest`]
622-
* https://quarkus.io/guides/resteasy[`quarkus-resteasy-jackson`]
621+
* https://quarkus.io/guides/rest[`quarkus-rest-client`]
622+
* https://quarkus.io/extensions/io.quarkus/quarkus-rest-client-jaxrs[`quarkus-rest-client-jaxrs`]
623+
* https://quarkus.io/guides/resteasy[`quarkus-resteasy`]
623624
* https://quarkus.io/guides/resteasy-client[`quarkus-resteasy-client`]
624625
* https://quarkus.io/guides/scheduler[`quarkus-scheduler`]
625626
* https://quarkus.io/guides/smallrye-graphql[`quarkus-smallrye-graphql`]

‎_versions/main/guides/rest-client.adoc‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1755,9 +1755,22 @@ The code uses the following pieces:
17551755
As previously mentioned, the body parameter needs to be properly crafted by the application code to conform to the service's requirements.
17561756

17571757
=== Receiving compressed messages
1758-
REST Client also supports receiving compressed messages using GZIP. You can enable the HTTP compression support by adding the property `quarkus.http.enable-compression=true`.
1758+
REST Client also supports receiving compressed messages using GZIP and can be enabled via configuration.
17591759
When this feature is enabled and a server returns a response that includes the header `Content-Encoding: gzip`, REST Client will automatically decode the content and proceed with the message handling.
17601760

1761+
An example configuration could be:
1762+
1763+
[source,properties]
1764+
----
1765+
# global configuration is used for all clients
1766+
quarkus.rest-client.enable-compression=true
1767+
1768+
# per-client configuration overrides the global settings for a specific client
1769+
quarkus.rest-client.my-client.enable-compression=true
1770+
----
1771+
1772+
The REST Client falls back onto the Quarkus wide `quarkus.http.enable-compression` configuration property (which defaults to `false`) if no REST Client specific property is set.
1773+
17611774
== Proxy support
17621775
REST Client supports sending requests through a proxy.
17631776
It honors the JVM settings for it but also allows to specify both:

0 commit comments

Comments
 (0)