Skip to content

Commit 3a18c94

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 5e8a303 commit 3a18c94

15 files changed

+266
-116
lines changed

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

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64711,9 +64711,11 @@ endif::add-copy-button-to-config-props[]
6471164711

6471264712
[.description]
6471364713
--
64714-
Micrometer MeterBinder discovery.
64714+
Micrometer MeterBinder discovery. In other words, enables the automatic metrics instrumentation.
6471564715

64716-
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default.
64716+
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default. In other words, automatic metrics instrumentation will be ON by default.
64717+
64718+
`quarkus.micrometer.binder.enable-all` overrides this property, meaning when this is set to `false`, and `enable-all` is true, discovery of all MeterBinder will still happen.
6471764719

6471864720

6471964721
ifdef::add-copy-button-to-env-var[]
@@ -65082,6 +65084,31 @@ endif::add-copy-button-to-env-var[]
6508265084
|boolean
6508365085
|
6508465086

65087+
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-binder-enable-all]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-enable-all[`quarkus.micrometer.binder.enable-all`]##
65088+
ifdef::add-copy-button-to-config-props[]
65089+
config_property_copy_button:+++quarkus.micrometer.binder.enable-all+++[]
65090+
endif::add-copy-button-to-config-props[]
65091+
65092+
65093+
[.description]
65094+
--
65095+
Enable all binders. Activates all metrics regardless off their particular default.
65096+
65097+
This property has precedence over all `BinderConfig` binders. In other words, if the `quarkus.micrometer.binder.jvm` is set to `false` and `quarkus.micrometer.binder.enabled-all` is set to `true`, all JVM metrics will be enabled.
65098+
65099+
Also takes precedence over `quarkus.micrometer.binder-enabled-default`, if binder discover is disabled, discovery of all metrics will still happen.
65100+
65101+
65102+
ifdef::add-copy-button-to-env-var[]
65103+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++[]
65104+
endif::add-copy-button-to-env-var[]
65105+
ifndef::add-copy-button-to-env-var[]
65106+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++`
65107+
endif::add-copy-button-to-env-var[]
65108+
--
65109+
|boolean
65110+
|`+++false+++`
65111+
6508565112
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-json-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-json-enabled[`quarkus.micrometer.export.json.enabled`]##
6508665113
ifdef::add-copy-button-to-config-props[]
6508765114
config_property_copy_button:+++quarkus.micrometer.export.json.enabled+++[]
@@ -79066,6 +79093,45 @@ endif::add-copy-button-to-env-var[]
7906679093
|boolean
7906779094
|`+++true+++`
7906879095

79096+
a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-debug-enabled]] [.property-path]##link:#quarkus-qute_quarkus-qute-debug-enabled[`quarkus.qute.debug.enabled`]##
79097+
ifdef::add-copy-button-to-config-props[]
79098+
config_property_copy_button:+++quarkus.qute.debug.enabled+++[]
79099+
endif::add-copy-button-to-config-props[]
79100+
79101+
79102+
[.description]
79103+
--
79104+
Enables or disables the Qute debug mode. This feature is experimental.
79105+
79106+
When enabled, Qute templates can be debugged directly at runtime. This includes the ability to:
79107+
79108+
- Set breakpoints inside templates
79109+
- Inspect the stack trace of visited template nodes during rendering
79110+
- Evaluate expressions in the current Qute context
79111+
79112+
79113+
79114+
This mode is intended for development and troubleshooting purposes.
79115+
79116+
*Default value:* `false`
79117+
79118+
Example configuration:
79119+
79120+
```
79121+
quarkus.qute.debug.enabled = true
79122+
```
79123+
79124+
79125+
ifdef::add-copy-button-to-env-var[]
79126+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEBUG_ENABLED+++[]
79127+
endif::add-copy-button-to-env-var[]
79128+
ifndef::add-copy-button-to-env-var[]
79129+
Environment variable: `+++QUARKUS_QUTE_DEBUG_ENABLED+++`
79130+
endif::add-copy-button-to-env-var[]
79131+
--
79132+
|boolean
79133+
|`+++false+++`
79134+
7906979135
a| [[quarkus-qute_quarkus-qute-property-not-found-strategy]] [.property-path]##link:#quarkus-qute_quarkus-qute-property-not-found-strategy[`quarkus.qute.property-not-found-strategy`]##
7907079136
ifdef::add-copy-button-to-config-props[]
7907179137
config_property_copy_button:+++quarkus.qute.property-not-found-strategy+++[]
@@ -92516,7 +92582,13 @@ endif::add-copy-button-to-config-props[]
9251692582

9251792583
[.description]
9251892584
--
92519-
Set the strategy to automatically create an operation Id
92585+
Set the strategy to automatically create an operation Id. The strategy may be one of the predefined values or the name of a fully-qualified class that implements the `io.smallrye.openapi.api.OperationIdGenerator` interface.
92586+
92587+
Predefined strategies:
92588+
92589+
- `method`: generate an operationId with the resource method's name
92590+
- `class-method`: generate an operationId with the resource class's simple name and the resource method's name
92591+
- `package-class-method`: generate an operationId with the resource class's fully-qualified name and the resource method's name
9252092592

9252192593

9252292594
ifdef::add-copy-button-to-env-var[]
@@ -92526,7 +92598,7 @@ ifndef::add-copy-button-to-env-var[]
9252692598
Environment variable: `+++QUARKUS_SMALLRYE_OPENAPI_OPERATION_ID_STRATEGY+++`
9252792599
endif::add-copy-button-to-env-var[]
9252892600
--
92529-
a|`method`, `class-method`, `package-class-method`
92601+
|string
9253092602
|
9253192603

9253292604
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples]] [.property-path]##link:#quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples[`quarkus.smallrye-openapi.merge-schema-examples`]##

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

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@ endif::add-copy-button-to-config-props[]
6161

6262
[.description]
6363
--
64-
Micrometer MeterBinder discovery.
64+
Micrometer MeterBinder discovery. In other words, enables the automatic metrics instrumentation.
6565

66-
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default.
66+
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default. In other words, automatic metrics instrumentation will be ON by default.
67+
68+
`quarkus.micrometer.binder.enable-all` overrides this property, meaning when this is set to `false`, and `enable-all` is true, discovery of all MeterBinder will still happen.
6769

6870

6971
ifdef::add-copy-button-to-env-var[]
@@ -432,6 +434,31 @@ endif::add-copy-button-to-env-var[]
432434
|boolean
433435
|
434436

437+
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-binder-enable-all]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-enable-all[`quarkus.micrometer.binder.enable-all`]##
438+
ifdef::add-copy-button-to-config-props[]
439+
config_property_copy_button:+++quarkus.micrometer.binder.enable-all+++[]
440+
endif::add-copy-button-to-config-props[]
441+
442+
443+
[.description]
444+
--
445+
Enable all binders. Activates all metrics regardless off their particular default.
446+
447+
This property has precedence over all `BinderConfig` binders. In other words, if the `quarkus.micrometer.binder.jvm` is set to `false` and `quarkus.micrometer.binder.enabled-all` is set to `true`, all JVM metrics will be enabled.
448+
449+
Also takes precedence over `quarkus.micrometer.binder-enabled-default`, if binder discover is disabled, discovery of all metrics will still happen.
450+
451+
452+
ifdef::add-copy-button-to-env-var[]
453+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++[]
454+
endif::add-copy-button-to-env-var[]
455+
ifndef::add-copy-button-to-env-var[]
456+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++`
457+
endif::add-copy-button-to-env-var[]
458+
--
459+
|boolean
460+
|`+++false+++`
461+
435462
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-json-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-json-enabled[`quarkus.micrometer.export.json.enabled`]##
436463
ifdef::add-copy-button-to-config-props[]
437464
config_property_copy_button:+++quarkus.micrometer.export.json.enabled+++[]

‎_generated-doc/main/config/quarkus-micrometer_quarkus.micrometer.adoc‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@ endif::add-copy-button-to-config-props[]
6161

6262
[.description]
6363
--
64-
Micrometer MeterBinder discovery.
64+
Micrometer MeterBinder discovery. In other words, enables the automatic metrics instrumentation.
6565

66-
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default.
66+
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default. In other words, automatic metrics instrumentation will be ON by default.
67+
68+
`quarkus.micrometer.binder.enable-all` overrides this property, meaning when this is set to `false`, and `enable-all` is true, discovery of all MeterBinder will still happen.
6769

6870

6971
ifdef::add-copy-button-to-env-var[]
@@ -432,6 +434,31 @@ endif::add-copy-button-to-env-var[]
432434
|boolean
433435
|
434436

437+
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-binder-enable-all]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-enable-all[`quarkus.micrometer.binder.enable-all`]##
438+
ifdef::add-copy-button-to-config-props[]
439+
config_property_copy_button:+++quarkus.micrometer.binder.enable-all+++[]
440+
endif::add-copy-button-to-config-props[]
441+
442+
443+
[.description]
444+
--
445+
Enable all binders. Activates all metrics regardless off their particular default.
446+
447+
This property has precedence over all `BinderConfig` binders. In other words, if the `quarkus.micrometer.binder.jvm` is set to `false` and `quarkus.micrometer.binder.enabled-all` is set to `true`, all JVM metrics will be enabled.
448+
449+
Also takes precedence over `quarkus.micrometer.binder-enabled-default`, if binder discover is disabled, discovery of all metrics will still happen.
450+
451+
452+
ifdef::add-copy-button-to-env-var[]
453+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++[]
454+
endif::add-copy-button-to-env-var[]
455+
ifndef::add-copy-button-to-env-var[]
456+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_ENABLE_ALL+++`
457+
endif::add-copy-button-to-env-var[]
458+
--
459+
|boolean
460+
|`+++false+++`
461+
435462
a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-json-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-json-enabled[`quarkus.micrometer.export.json.enabled`]##
436463
ifdef::add-copy-button-to-config-props[]
437464
config_property_copy_button:+++quarkus.micrometer.export.json.enabled+++[]

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,45 @@ endif::add-copy-button-to-env-var[]
243243
|boolean
244244
|`+++true+++`
245245

246+
a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-debug-enabled]] [.property-path]##link:#quarkus-qute_quarkus-qute-debug-enabled[`quarkus.qute.debug.enabled`]##
247+
ifdef::add-copy-button-to-config-props[]
248+
config_property_copy_button:+++quarkus.qute.debug.enabled+++[]
249+
endif::add-copy-button-to-config-props[]
250+
251+
252+
[.description]
253+
--
254+
Enables or disables the Qute debug mode. This feature is experimental.
255+
256+
When enabled, Qute templates can be debugged directly at runtime. This includes the ability to:
257+
258+
- Set breakpoints inside templates
259+
- Inspect the stack trace of visited template nodes during rendering
260+
- Evaluate expressions in the current Qute context
261+
262+
263+
264+
This mode is intended for development and troubleshooting purposes.
265+
266+
*Default value:* `false`
267+
268+
Example configuration:
269+
270+
```
271+
quarkus.qute.debug.enabled = true
272+
```
273+
274+
275+
ifdef::add-copy-button-to-env-var[]
276+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEBUG_ENABLED+++[]
277+
endif::add-copy-button-to-env-var[]
278+
ifndef::add-copy-button-to-env-var[]
279+
Environment variable: `+++QUARKUS_QUTE_DEBUG_ENABLED+++`
280+
endif::add-copy-button-to-env-var[]
281+
--
282+
|boolean
283+
|`+++false+++`
284+
246285
a| [[quarkus-qute_quarkus-qute-property-not-found-strategy]] [.property-path]##link:#quarkus-qute_quarkus-qute-property-not-found-strategy[`quarkus.qute.property-not-found-strategy`]##
247286
ifdef::add-copy-button-to-config-props[]
248287
config_property_copy_button:+++quarkus.qute.property-not-found-strategy+++[]

‎_generated-doc/main/config/quarkus-qute_quarkus.qute.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,45 @@ endif::add-copy-button-to-env-var[]
243243
|boolean
244244
|`+++true+++`
245245

246+
a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-debug-enabled]] [.property-path]##link:#quarkus-qute_quarkus-qute-debug-enabled[`quarkus.qute.debug.enabled`]##
247+
ifdef::add-copy-button-to-config-props[]
248+
config_property_copy_button:+++quarkus.qute.debug.enabled+++[]
249+
endif::add-copy-button-to-config-props[]
250+
251+
252+
[.description]
253+
--
254+
Enables or disables the Qute debug mode. This feature is experimental.
255+
256+
When enabled, Qute templates can be debugged directly at runtime. This includes the ability to:
257+
258+
- Set breakpoints inside templates
259+
- Inspect the stack trace of visited template nodes during rendering
260+
- Evaluate expressions in the current Qute context
261+
262+
263+
264+
This mode is intended for development and troubleshooting purposes.
265+
266+
*Default value:* `false`
267+
268+
Example configuration:
269+
270+
```
271+
quarkus.qute.debug.enabled = true
272+
```
273+
274+
275+
ifdef::add-copy-button-to-env-var[]
276+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEBUG_ENABLED+++[]
277+
endif::add-copy-button-to-env-var[]
278+
ifndef::add-copy-button-to-env-var[]
279+
Environment variable: `+++QUARKUS_QUTE_DEBUG_ENABLED+++`
280+
endif::add-copy-button-to-env-var[]
281+
--
282+
|boolean
283+
|`+++false+++`
284+
246285
a| [[quarkus-qute_quarkus-qute-property-not-found-strategy]] [.property-path]##link:#quarkus-qute_quarkus-qute-property-not-found-strategy[`quarkus.qute.property-not-found-strategy`]##
247286
ifdef::add-copy-button-to-config-props[]
248287
config_property_copy_button:+++quarkus.qute.property-not-found-strategy+++[]

‎_generated-doc/main/config/quarkus-smallrye-openapi.adoc‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -834,7 +834,13 @@ endif::add-copy-button-to-config-props[]
834834

835835
[.description]
836836
--
837-
Set the strategy to automatically create an operation Id
837+
Set the strategy to automatically create an operation Id. The strategy may be one of the predefined values or the name of a fully-qualified class that implements the `io.smallrye.openapi.api.OperationIdGenerator` interface.
838+
839+
Predefined strategies:
840+
841+
- `method`: generate an operationId with the resource method's name
842+
- `class-method`: generate an operationId with the resource class's simple name and the resource method's name
843+
- `package-class-method`: generate an operationId with the resource class's fully-qualified name and the resource method's name
838844

839845

840846
ifdef::add-copy-button-to-env-var[]
@@ -844,7 +850,7 @@ ifndef::add-copy-button-to-env-var[]
844850
Environment variable: `+++QUARKUS_SMALLRYE_OPENAPI_OPERATION_ID_STRATEGY+++`
845851
endif::add-copy-button-to-env-var[]
846852
--
847-
a|`method`, `class-method`, `package-class-method`
853+
|string
848854
|
849855

850856
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples]] [.property-path]##link:#quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples[`quarkus.smallrye-openapi.merge-schema-examples`]##

‎_generated-doc/main/config/quarkus-smallrye-openapi_quarkus.smallrye-openapi.adoc‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -834,7 +834,13 @@ endif::add-copy-button-to-config-props[]
834834

835835
[.description]
836836
--
837-
Set the strategy to automatically create an operation Id
837+
Set the strategy to automatically create an operation Id. The strategy may be one of the predefined values or the name of a fully-qualified class that implements the `io.smallrye.openapi.api.OperationIdGenerator` interface.
838+
839+
Predefined strategies:
840+
841+
- `method`: generate an operationId with the resource method's name
842+
- `class-method`: generate an operationId with the resource class's simple name and the resource method's name
843+
- `package-class-method`: generate an operationId with the resource class's fully-qualified name and the resource method's name
838844

839845

840846
ifdef::add-copy-button-to-env-var[]
@@ -844,7 +850,7 @@ ifndef::add-copy-button-to-env-var[]
844850
Environment variable: `+++QUARKUS_SMALLRYE_OPENAPI_OPERATION_ID_STRATEGY+++`
845851
endif::add-copy-button-to-env-var[]
846852
--
847-
a|`method`, `class-method`, `package-class-method`
853+
|string
848854
|
849855

850856
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples]] [.property-path]##link:#quarkus-smallrye-openapi_quarkus-smallrye-openapi-merge-schema-examples[`quarkus.smallrye-openapi.merge-schema-examples`]##

0 commit comments

Comments
 (0)