Skip to content

Commit 7095d6b

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 52627aa commit 7095d6b

File tree

7 files changed

+208
-178
lines changed

7 files changed

+208
-178
lines changed

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

Lines changed: 37 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -84399,6 +84399,27 @@ h|[.extension-name]##REST Clients Config##
8439984399
h|Type
8440084400
h|Default
8440184401

84402+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-scope[`quarkus.rest-client.scope`]##
84403+
ifdef::add-copy-button-to-config-props[]
84404+
config_property_copy_button:+++quarkus.rest-client.scope+++[]
84405+
endif::add-copy-button-to-config-props[]
84406+
84407+
84408+
[.description]
84409+
--
84410+
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.
84411+
84412+
84413+
ifdef::add-copy-button-to-env-var[]
84414+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_SCOPE+++[]
84415+
endif::add-copy-button-to-env-var[]
84416+
ifndef::add-copy-button-to-env-var[]
84417+
Environment variable: `+++QUARKUS_REST_CLIENT_SCOPE+++`
84418+
endif::add-copy-button-to-env-var[]
84419+
--
84420+
|string
84421+
|
84422+
8440284423
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-removes-trailing-slash[`quarkus.rest-client.removes-trailing-slash`]##
8440384424
ifdef::add-copy-button-to-config-props[]
8440484425
config_property_copy_button:+++quarkus.rest-client.removes-trailing-slash+++[]
@@ -84821,33 +84842,6 @@ endif::add-copy-button-to-env-var[]
8482184842
|string
8482284843
|
8482384844

84824-
a| [[quarkus-rest-client-config_quarkus-rest-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-scope[`quarkus.rest-client.scope`]##
84825-
ifdef::add-copy-button-to-config-props[]
84826-
config_property_copy_button:+++quarkus.rest-client.scope+++[]
84827-
endif::add-copy-button-to-config-props[]
84828-
84829-
84830-
[.description]
84831-
--
84832-
The CDI scope to use for injections of REST client instances. Value can be either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as"ApplicationScoped").
84833-
84834-
Default scope for the rest-client extension is "Dependent" (which is the spec-compliant behavior).
84835-
84836-
Default scope for the rest-client-reactive extension is "ApplicationScoped".
84837-
84838-
Can be overwritten by client-specific settings.
84839-
84840-
84841-
ifdef::add-copy-button-to-env-var[]
84842-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_SCOPE+++[]
84843-
endif::add-copy-button-to-env-var[]
84844-
ifndef::add-copy-button-to-env-var[]
84845-
Environment variable: `+++QUARKUS_REST_CLIENT_SCOPE+++`
84846-
endif::add-copy-button-to-env-var[]
84847-
--
84848-
|string
84849-
|
84850-
8485184845
a| [[quarkus-rest-client-config_quarkus-rest-client-query-param-style]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-query-param-style[`quarkus.rest-client.query-param-style`]##
8485284846
ifdef::add-copy-button-to-config-props[]
8485384847
config_property_copy_button:+++quarkus.rest-client.query-param-style+++[]
@@ -85254,9 +85248,9 @@ endif::add-copy-button-to-env-var[]
8525485248
|int
8525585249
|`+++100+++`
8525685250

85257-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-scope[`quarkus.rest-client."clients".scope`]##
85251+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-scope[`quarkus.rest-client."client".scope`]##
8525885252
ifdef::add-copy-button-to-config-props[]
85259-
config_property_copy_button:+++quarkus.rest-client."clients".scope+++[]
85253+
config_property_copy_button:+++quarkus.rest-client."client".scope+++[]
8526085254
endif::add-copy-button-to-config-props[]
8526185255

8526285256

@@ -85266,18 +85260,18 @@ The CDI scope to use for injection. This property can contain either a fully qua
8526685260

8526785261

8526885262
ifdef::add-copy-button-to-env-var[]
85269-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__SCOPE+++[]
85263+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__SCOPE+++[]
8527085264
endif::add-copy-button-to-env-var[]
8527185265
ifndef::add-copy-button-to-env-var[]
85272-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__SCOPE+++`
85266+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__SCOPE+++`
8527385267
endif::add-copy-button-to-env-var[]
8527485268
--
8527585269
|string
8527685270
|
8527785271

85278-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-enable-local-proxy]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-enable-local-proxy[`quarkus.rest-client."clients".enable-local-proxy`]##
85272+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-enable-local-proxy]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-local-proxy[`quarkus.rest-client."client".enable-local-proxy`]##
8527985273
ifdef::add-copy-button-to-config-props[]
85280-
config_property_copy_button:+++quarkus.rest-client."clients".enable-local-proxy+++[]
85274+
config_property_copy_button:+++quarkus.rest-client."client".enable-local-proxy+++[]
8528185275
endif::add-copy-button-to-config-props[]
8528285276

8528385277

@@ -85291,18 +85285,18 @@ This property only applicable to dev and test mode.
8529185285

8529285286

8529385287
ifdef::add-copy-button-to-env-var[]
85294-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__ENABLE_LOCAL_PROXY+++[]
85288+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_LOCAL_PROXY+++[]
8529585289
endif::add-copy-button-to-env-var[]
8529685290
ifndef::add-copy-button-to-env-var[]
85297-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__ENABLE_LOCAL_PROXY+++`
85291+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_LOCAL_PROXY+++`
8529885292
endif::add-copy-button-to-env-var[]
8529985293
--
8530085294
|boolean
8530185295
|`+++false+++`
8530285296

85303-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-local-proxy-provider]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-local-proxy-provider[`quarkus.rest-client."clients".local-proxy-provider`]##
85297+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-local-proxy-provider]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-local-proxy-provider[`quarkus.rest-client."client".local-proxy-provider`]##
8530485298
ifdef::add-copy-button-to-config-props[]
85305-
config_property_copy_button:+++quarkus.rest-client."clients".local-proxy-provider+++[]
85299+
config_property_copy_button:+++quarkus.rest-client."client".local-proxy-provider+++[]
8530685300
endif::add-copy-button-to-config-props[]
8530785301

8530885302

@@ -85318,18 +85312,18 @@ The algorithm for picking between multiple provider is the following:
8531885312

8531985313

8532085314
ifdef::add-copy-button-to-env-var[]
85321-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__LOCAL_PROXY_PROVIDER+++[]
85315+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__LOCAL_PROXY_PROVIDER+++[]
8532285316
endif::add-copy-button-to-env-var[]
8532385317
ifndef::add-copy-button-to-env-var[]
85324-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__LOCAL_PROXY_PROVIDER+++`
85318+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__LOCAL_PROXY_PROVIDER+++`
8532585319
endif::add-copy-button-to-env-var[]
8532685320
--
8532785321
|string
8532885322
|
8532985323

85330-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-removes-trailing-slash[`quarkus.rest-client."clients".removes-trailing-slash`]##
85324+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-removes-trailing-slash[`quarkus.rest-client."client".removes-trailing-slash`]##
8533185325
ifdef::add-copy-button-to-config-props[]
85332-
config_property_copy_button:+++quarkus.rest-client."clients".removes-trailing-slash+++[]
85326+
config_property_copy_button:+++quarkus.rest-client."client".removes-trailing-slash+++[]
8533385327
endif::add-copy-button-to-config-props[]
8533485328

8533585329

@@ -85339,10 +85333,10 @@ If true, the extension will automatically remove the trailing slash in the paths
8533985333

8534085334

8534185335
ifdef::add-copy-button-to-env-var[]
85342-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__REMOVES_TRAILING_SLASH+++[]
85336+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__REMOVES_TRAILING_SLASH+++[]
8534385337
endif::add-copy-button-to-env-var[]
8534485338
ifndef::add-copy-button-to-env-var[]
85345-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__REMOVES_TRAILING_SLASH+++`
85339+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__REMOVES_TRAILING_SLASH+++`
8534685340
endif::add-copy-button-to-env-var[]
8534785341
--
8534885342
|boolean

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

Lines changed: 37 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@ h|[.header-title]##Configuration property##
77
h|Type
88
h|Default
99

10+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-scope[`quarkus.rest-client.scope`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.rest-client.scope+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
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.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_SCOPE+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_REST_CLIENT_SCOPE+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|string
29+
|
30+
1031
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-removes-trailing-slash[`quarkus.rest-client.removes-trailing-slash`]##
1132
ifdef::add-copy-button-to-config-props[]
1233
config_property_copy_button:+++quarkus.rest-client.removes-trailing-slash+++[]
@@ -429,33 +450,6 @@ endif::add-copy-button-to-env-var[]
429450
|string
430451
|
431452

432-
a| [[quarkus-rest-client-config_quarkus-rest-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-scope[`quarkus.rest-client.scope`]##
433-
ifdef::add-copy-button-to-config-props[]
434-
config_property_copy_button:+++quarkus.rest-client.scope+++[]
435-
endif::add-copy-button-to-config-props[]
436-
437-
438-
[.description]
439-
--
440-
The CDI scope to use for injections of REST client instances. Value can be either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as"ApplicationScoped").
441-
442-
Default scope for the rest-client extension is "Dependent" (which is the spec-compliant behavior).
443-
444-
Default scope for the rest-client-reactive extension is "ApplicationScoped".
445-
446-
Can be overwritten by client-specific settings.
447-
448-
449-
ifdef::add-copy-button-to-env-var[]
450-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_SCOPE+++[]
451-
endif::add-copy-button-to-env-var[]
452-
ifndef::add-copy-button-to-env-var[]
453-
Environment variable: `+++QUARKUS_REST_CLIENT_SCOPE+++`
454-
endif::add-copy-button-to-env-var[]
455-
--
456-
|string
457-
|
458-
459453
a| [[quarkus-rest-client-config_quarkus-rest-client-query-param-style]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-query-param-style[`quarkus.rest-client.query-param-style`]##
460454
ifdef::add-copy-button-to-config-props[]
461455
config_property_copy_button:+++quarkus.rest-client.query-param-style+++[]
@@ -862,9 +856,9 @@ endif::add-copy-button-to-env-var[]
862856
|int
863857
|`+++100+++`
864858

865-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-scope[`quarkus.rest-client."clients".scope`]##
859+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-scope[`quarkus.rest-client."client".scope`]##
866860
ifdef::add-copy-button-to-config-props[]
867-
config_property_copy_button:+++quarkus.rest-client."clients".scope+++[]
861+
config_property_copy_button:+++quarkus.rest-client."client".scope+++[]
868862
endif::add-copy-button-to-config-props[]
869863

870864

@@ -874,18 +868,18 @@ The CDI scope to use for injection. This property can contain either a fully qua
874868

875869

876870
ifdef::add-copy-button-to-env-var[]
877-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__SCOPE+++[]
871+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__SCOPE+++[]
878872
endif::add-copy-button-to-env-var[]
879873
ifndef::add-copy-button-to-env-var[]
880-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__SCOPE+++`
874+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__SCOPE+++`
881875
endif::add-copy-button-to-env-var[]
882876
--
883877
|string
884878
|
885879

886-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-enable-local-proxy]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-enable-local-proxy[`quarkus.rest-client."clients".enable-local-proxy`]##
880+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-enable-local-proxy]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-enable-local-proxy[`quarkus.rest-client."client".enable-local-proxy`]##
887881
ifdef::add-copy-button-to-config-props[]
888-
config_property_copy_button:+++quarkus.rest-client."clients".enable-local-proxy+++[]
882+
config_property_copy_button:+++quarkus.rest-client."client".enable-local-proxy+++[]
889883
endif::add-copy-button-to-config-props[]
890884

891885

@@ -899,18 +893,18 @@ This property only applicable to dev and test mode.
899893

900894

901895
ifdef::add-copy-button-to-env-var[]
902-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__ENABLE_LOCAL_PROXY+++[]
896+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_LOCAL_PROXY+++[]
903897
endif::add-copy-button-to-env-var[]
904898
ifndef::add-copy-button-to-env-var[]
905-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__ENABLE_LOCAL_PROXY+++`
899+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__ENABLE_LOCAL_PROXY+++`
906900
endif::add-copy-button-to-env-var[]
907901
--
908902
|boolean
909903
|`+++false+++`
910904

911-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-local-proxy-provider]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-local-proxy-provider[`quarkus.rest-client."clients".local-proxy-provider`]##
905+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-local-proxy-provider]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-local-proxy-provider[`quarkus.rest-client."client".local-proxy-provider`]##
912906
ifdef::add-copy-button-to-config-props[]
913-
config_property_copy_button:+++quarkus.rest-client."clients".local-proxy-provider+++[]
907+
config_property_copy_button:+++quarkus.rest-client."client".local-proxy-provider+++[]
914908
endif::add-copy-button-to-config-props[]
915909

916910

@@ -926,18 +920,18 @@ The algorithm for picking between multiple provider is the following:
926920

927921

928922
ifdef::add-copy-button-to-env-var[]
929-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__LOCAL_PROXY_PROVIDER+++[]
923+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__LOCAL_PROXY_PROVIDER+++[]
930924
endif::add-copy-button-to-env-var[]
931925
ifndef::add-copy-button-to-env-var[]
932-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__LOCAL_PROXY_PROVIDER+++`
926+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__LOCAL_PROXY_PROVIDER+++`
933927
endif::add-copy-button-to-env-var[]
934928
--
935929
|string
936930
|
937931

938-
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-clients-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-clients-removes-trailing-slash[`quarkus.rest-client."clients".removes-trailing-slash`]##
932+
a|icon:lock[title=Fixed at build time] [[quarkus-rest-client-config_quarkus-rest-client-client-removes-trailing-slash]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-removes-trailing-slash[`quarkus.rest-client."client".removes-trailing-slash`]##
939933
ifdef::add-copy-button-to-config-props[]
940-
config_property_copy_button:+++quarkus.rest-client."clients".removes-trailing-slash+++[]
934+
config_property_copy_button:+++quarkus.rest-client."client".removes-trailing-slash+++[]
941935
endif::add-copy-button-to-config-props[]
942936

943937

@@ -947,10 +941,10 @@ If true, the extension will automatically remove the trailing slash in the paths
947941

948942

949943
ifdef::add-copy-button-to-env-var[]
950-
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENTS__REMOVES_TRAILING_SLASH+++[]
944+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__REMOVES_TRAILING_SLASH+++[]
951945
endif::add-copy-button-to-env-var[]
952946
ifndef::add-copy-button-to-env-var[]
953-
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENTS__REMOVES_TRAILING_SLASH+++`
947+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__REMOVES_TRAILING_SLASH+++`
954948
endif::add-copy-button-to-env-var[]
955949
--
956950
|boolean

0 commit comments

Comments
 (0)