Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 19, 2024
1 parent 526f725 commit 406642b
Show file tree
Hide file tree
Showing 18 changed files with 323 additions and 22 deletions.
Original file line number Diff line number Diff line change
@@ -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":"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 use 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":"","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}}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"configs\".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":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIGS__SCOPE","enum":false}}]
[{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"configs\".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":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scope","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIGS__SCOPE","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.rest-client.\"configs\".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 use 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":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enable-local-proxy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.rest-client.\"configs\".local-proxy-provider","additionalKeys":[],"configDoc":"","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"local-proxy-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.rest-client","since":null,"environmentVariable":"QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER","enum":false}}]

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7086,6 +7086,25 @@ _No Javadoc found_
_No Javadoc found_




a|https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest-client/deployment/src/main/java/io/quarkus/rest/client/reactive/deployment/RegisteredRestClientBuildItem.java[`io.quarkus.rest.client.reactive.deployment.RegisteredRestClientBuildItem`, window="_blank"]
[.description]
--
Contains information about the REST Clients that have been discovered via `org.eclipse.microprofile.rest.client.inject.RegisterRestClient`
-- a|`org.jboss.jandex.ClassInfo classInfo`
_No Javadoc found_

`java.util.Optional<String> configKey`

_No Javadoc found_

`java.util.Optional<String> defaultBaseUri`

_No Javadoc found_


|===
== REST Client - SPI
[.configuration-reference,cols=2*]
Expand All @@ -7105,6 +7124,29 @@ Make it possible to add, remove or alter annotations on various components. The
_No Javadoc found_




a|https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest-client/spi-deployment/src/main/java/io/quarkus/rest/client/reactive/spi/RestClientHttpProxyBuildItem.java[`io.quarkus.rest.client.reactive.spi.RestClientHttpProxyBuildItem`, window="_blank"]
[.description]
--
Represents the data necessary for creating a Http proxy for a REST Client
-- a|`java.lang.String className`
_No Javadoc found_

`java.lang.String baseUri`

_No Javadoc found_

`java.util.Optional<String> provider`

_No Javadoc found_

`java.io.Closeable closeable`

_No Javadoc found_


|===
== REST data with Panache
[.configuration-reference,cols=2*]
Expand Down
55 changes: 55 additions & 0 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62800,6 +62800,42 @@ endif::add-copy-button-to-env-var[]
|


a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-configs-enable-local-proxy]]`link:#quarkus-rest-client-config_quarkus-rest-client-configs-enable-local-proxy[quarkus.rest-client."configs".enable-local-proxy]`


[.description]
--
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 use HTTPS.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

This property only applicable to dev and test mode.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-configs-local-proxy-provider]]`link:#quarkus-rest-client-config_quarkus-rest-client-configs-local-proxy-provider[quarkus.rest-client."configs".local-proxy-provider]`


[.description]
--
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-rest-client-config_quarkus-rest-client-config-key-url]]`link:#quarkus-rest-client-config_quarkus-rest-client-config-key-url[quarkus.rest-client."config-key".url]`


Expand Down Expand Up @@ -62834,6 +62870,25 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-rest-client-config_quarkus-rest-client-config-key-override-uri]]`link:#quarkus-rest-client-config_quarkus-rest-client-config-key-override-uri[quarkus.rest-client."config-key".override-uri]`


[.description]
--
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-rest-client-config_quarkus-rest-client-config-key-providers]]`link:#quarkus-rest-client-config_quarkus-rest-client-config-key-providers[quarkus.rest-client."config-key".providers]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,40 @@ endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-restclient-config-rest-clients-build-time-config_quarkus-rest-client-configs-enable-local-proxy]]`link:#quarkus-rest-client-restclient-config-rest-clients-build-time-config_quarkus-rest-client-configs-enable-local-proxy[quarkus.rest-client."configs".enable-local-proxy]`


[.description]
--
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 use HTTPS.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

This property only applicable to dev and test mode.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-restclient-config-rest-clients-build-time-config_quarkus-rest-client-configs-local-proxy-provider]]`link:#quarkus-rest-client-restclient-config-rest-clients-build-time-config_quarkus-rest-client-configs-local-proxy-provider[quarkus.rest-client."configs".local-proxy-provider]`


[.description]
--
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--|string
|

|===
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,25 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-override-uri]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-override-uri[quarkus.rest-client."config-key".override-uri]`


[.description]
--
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-providers]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus-rest-client-config-key-providers[quarkus.rest-client."config-key".providers]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,42 @@ endif::add-copy-button-to-env-var[]
|


a|icon:lock[title=Fixed at build time] [[quarkus-restclient-config-general-config-items_quarkus-rest-client-configs-enable-local-proxy]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-configs-enable-local-proxy[quarkus.rest-client."configs".enable-local-proxy]`


[.description]
--
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 use HTTPS.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

This property only applicable to dev and test mode.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-restclient-config-general-config-items_quarkus-rest-client-configs-local-proxy-provider]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-configs-local-proxy-provider[quarkus.rest-client."configs".local-proxy-provider]`


[.description]
--
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-url]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-url[quarkus.rest-client."config-key".url]`


Expand Down Expand Up @@ -105,6 +141,25 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-override-uri]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-override-uri[quarkus.rest-client."config-key".override-uri]`


[.description]
--
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__OVERRIDE_URI+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-providers]]`link:#quarkus-restclient-config-general-config-items_quarkus-rest-client-config-key-providers[quarkus.rest-client."config-key".providers]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,40 @@ endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-restclient-config-rest-client-build-config_quarkus-rest-client-configs-enable-local-proxy]]`link:#quarkus-restclient-config-rest-client-build-config_quarkus-rest-client-configs-enable-local-proxy[quarkus.rest-client."configs".enable-local-proxy]`


[.description]
--
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 use HTTPS.

This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).

This property only applicable to dev and test mode.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__ENABLE_LOCAL_PROXY+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-restclient-config-rest-client-build-config_quarkus-rest-client-configs-local-proxy-provider]]`link:#quarkus-restclient-config-rest-client-build-config_quarkus-rest-client-configs-local-proxy-provider[quarkus.rest-client."configs".local-proxy-provider]`


[.description]
--
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIGS__LOCAL_PROXY_PROVIDER+++`
endif::add-copy-button-to-env-var[]
--|string
|

|===
Loading

0 comments on commit 406642b

Please sign in to comment.