Skip to content

Commit 889b525

Browse files
tomas-langertomas-langer
authored
New config docs (helidon-io#4541)
* Refactored config documentation: * move to docs/config * fixed wrong annotations * added section with all generated docs * use _ instead of . in file names (could not render menu) * sorted options Signed-off-by: Tomas Langer <tomas.langer@oracle.com>
1 parent baac8b1 commit 889b525

55 files changed

Lines changed: 2420 additions & 249 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/includes/config/io.helidon.microprofile.openapi.MPOpenAPISupport.adoc renamed to docs/config/io.helidon.microprofile.openapi.MPOpenAPIBuilder.adoc

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,44 +16,55 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19+
ifndef::rootdir[:rootdir: {docdir}/..]
1920
:description: Configuration of io.helidon.microprofile.openapi.MPOpenAPISupport
2021
:keywords: helidon, config, io.helidon.microprofile.openapi.MPOpenAPISupport
2122
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.microprofile.openapi.MPOpenAPISupport
23+
include::{rootdir}/includes/attributes.adoc[]
24+
25+
= MPOpenAPISupport (microprofile.openapi) Configuration
26+
27+
// tag::config[]
28+
29+
30+
Type: link:{javadoc-base-url}/io.helidon.microprofile.openapi/io.helidon.microprofile.openapi.MPOpenAPISupport[io.helidon.microprofile.openapi.MPOpenAPISupport]
31+
2232
2333
[source,text]
24-
.Type
34+
.Config key
2535
----
26-
io.helidon.microprofile.openapi.MPOpenAPISupport
36+
mp.openapi
2737
----
2838
2939
3040
31-
==== Configuration options
32-
41+
== Configuration options
3342
3443
3544
3645
Optional configuration options:
37-
[cols="3,3,2,5"]
46+
[cols="3,3,2,5a"]
3847
3948
|===
4049
|key |type |default value |description
4150
42-
|`scan.exclude.classes` |string[&#93; |{nbsp} |Specify the list of classes to exclude from scans.
51+
|`application-path-disable` |boolean |`false` |Sets whether the app path search should be disabled.
52+
|`cors` |xref:{rootdir}/config/io_helidon_webserver_cors_CrossOriginConfig.adoc[CrossOriginConfig] |{nbsp} |Assigns the CORS settings for the OpenAPI endpoint.
53+
|`custom-schema-registry-class` |string |{nbsp} |Sets the custom schema registry class.
54+
|`filter` |string |{nbsp} |Sets the developer-provided OpenAPI filter class name.
55+
|`model.reader` |string |{nbsp} |Sets the developer-provided OpenAPI model reader class name.
4356
|`scan.classes` |string[&#93; |{nbsp} |Specify the list of classes to scan.
4457
|`scan.disable` |boolean |`false` |Disable annotation scanning.
58+
|`scan.exclude.classes` |string[&#93; |{nbsp} |Specify the list of classes to exclude from scans.
4559
|`scan.exclude.packages` |string[&#93; |{nbsp} |Specify the list of packages to exclude from scans.
4660
|`scan.packages` |string[&#93; |{nbsp} |Specify the list of packages to scan.
47-
|`web-context` |string |`/openapi` |Sets the web context path for the OpenAPI endpoint.
48-
|`cors` |link:../../shared/config/io.helidon.webserver.cors.CrossOriginConfig.adoc[CrossOriginConfig] |{nbsp} |Assigns the CORS settings for the OpenAPI endpoint.
49-
|`static-file` |string |`META-INF/openapi.(json|yaml|yml)` |Sets the file system path of the static OpenAPI document file.
50-
|`servers.operation.*` |string[&#93; |{nbsp} |Sets alternative servers to service the indicated operation (represented here by '*'). Repeat for multiple operations.
51-
|`custom-schema-registry-class` |string |{nbsp} |Sets the custom schema registry class.
5261
|`schema.*` |string |{nbsp} |Sets the schema for the indicated fully-qualified class name (represented here by '*'); value is the schema in JSON format. Repeat for multiple classes.
53-
|`application-path-disable` |boolean |`false` |Sets whether the app path search should be disabled.
54-
|`model.reader` |string |{nbsp} |Sets the developer-provided OpenAPI model reader class name.
55-
|`servers.path.{path}` |string[&#93; |{nbsp} |Sets alternative servers to service all operations at the indicated path (represented here by '*'). Repeat for multiple paths.
5662
|`servers` |string[&#93; |{nbsp} |Sets servers.
57-
|`filter` |string |{nbsp} |Sets the developer-provided OpenAPI filter class name.
63+
|`servers.operation.*` |string[&#93; |{nbsp} |Sets alternative servers to service the indicated operation (represented here by '*'). Repeat for multiple operations.
64+
|`servers.path.*` |string[&#93; |{nbsp} |Sets alternative servers to service all operations at the indicated path (represented here by '*'). Repeat for multiple paths.
65+
|`static-file` |string |`META-INF/openapi.(json|yaml|yml)` |Sets the file system path of the static OpenAPI document file.
66+
|`web-context` |string |`/openapi` |Sets the web context path for the OpenAPI endpoint.
5867
5968
|===
69+
70+
// end::config[]

‎docs/config/io.helidon.openapi.internal.OpenAPIConfigImpl.Builder.adoc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
///////////////////////////////////////////////////////////////////////////////
2+
3+
Copyright (c) 2022 Oracle and/or its affiliates.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
17+
///////////////////////////////////////////////////////////////////////////////
18+
19+
ifndef::rootdir[:rootdir: {docdir}/..]
20+
:description: Configuration of io.smallrye.openapi.api.OpenApiConfig
21+
:keywords: helidon, config, io.smallrye.openapi.api.OpenApiConfig
22+
:basic-table-intro: The table below lists the configuration keys that configure io.smallrye.openapi.api.OpenApiConfig
23+
include::{rootdir}/includes/attributes.adoc[]
24+
25+
= io.smallrye.openapi.api.OpenApiConfig Configuration
26+
27+
// tag::config[]
28+
29+
30+
Type: io.smallrye.openapi.api.OpenApiConfig
31+
32+
33+
34+
35+
== Configuration options
36+
37+
38+
39+
Optional configuration options:
40+
[cols="3,3,2,5a"]
41+
42+
|===
43+
|key |type |default value |description
44+
45+
|`application-path-disable` |boolean |`false` |Sets whether the app path search should be disabled.
46+
|`custom-schema-registry-class` |string |{nbsp} |Sets the custom schema registry class.
47+
|`filter` |string |{nbsp} |Sets the developer-provided OpenAPI filter class name.
48+
|`model.reader` |string |{nbsp} |Sets the developer-provided OpenAPI model reader class name.
49+
|`schema.*` |string |{nbsp} |Sets the schema for the indicated fully-qualified class name (represented here by '*'); value is the schema in JSON format. Repeat for multiple classes.
50+
|`servers` |string[&#93; |{nbsp} |Sets servers.
51+
|`servers.operation.*` |string[&#93; |{nbsp} |Sets alternative servers to service the indicated operation (represented here by '*'). Repeat for multiple operations.
52+
|`servers.path.*` |string[&#93; |{nbsp} |Sets alternative servers to service all operations at the indicated path (represented here by '*'). Repeat for multiple paths.
53+
54+
|===
55+
56+
// end::config[]

‎docs/config/io.helidon.tracing.jaeger.JaegerTracerBuilder.adoc‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
///////////////////////////////////////////////////////////////////////////////
2+
3+
Copyright (c) 2022 Oracle and/or its affiliates.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
17+
///////////////////////////////////////////////////////////////////////////////
18+
19+
ifndef::rootdir[:rootdir: {docdir}/..]
20+
:description: Configuration of io.helidon.tracing.Tracer
21+
:keywords: helidon, config, io.helidon.tracing.Tracer
22+
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.tracing.Tracer
23+
include::{rootdir}/includes/attributes.adoc[]
24+
25+
= Tracer (tracing) Configuration
26+
27+
// tag::config[]
28+
29+
Jaeger tracer configuration.
30+
31+
32+
Type: link:{javadoc-base-url}/io.helidon.tracing/io.helidon.tracing.Tracer[io.helidon.tracing.Tracer]
33+
34+
35+
This is a standalone configuration type, prefix from configuration root: `tracing`
36+
37+
38+
39+
== Configuration options
40+
41+
42+
43+
Optional configuration options:
44+
[cols="3,3,2,5a"]
45+
46+
|===
47+
|key |type |default value |description
48+
49+
|`boolean-tags` |Map&lt;string, boolean&gt; |{nbsp} |Tracer level tags that get added to all reported spans.
50+
|`enabled` |boolean |`true` |When enabled, tracing will be sent. If enabled is false, tracing should
51+
use a no-op tracer.
52+
|`global` |boolean |`true` |When enabled, the created instance is also registered as a global tracer.
53+
|`host` |string |{nbsp} |Host to use to connect to tracing collector.
54+
Default is defined by each tracing integration.
55+
|`int-tags` |Map&lt;string, int&gt; |{nbsp} |Tracer level tags that get added to all reported spans.
56+
|`path` |string |{nbsp} |Path on the collector host to use when sending data to tracing collector.
57+
Default is defined by each tracing integration.
58+
|`port` |int |{nbsp} |Port to use to connect to tracing collector.
59+
Default is defined by each tracing integration.
60+
|`protocol` |string |{nbsp} |Protocol to use (such as `http` or `https`) to connect to tracing collector.
61+
Default is defined by each tracing integration.
62+
|`service` |string |{nbsp} |Service name of the traced service.
63+
|`tags` |Map&lt;string, string&gt; |{nbsp} |Tracer level tags that get added to all reported spans.
64+
65+
|===
66+
67+
// end::config[]

docs/includes/config/io.helidon.common.configurable.LruCache.adoc renamed to docs/config/io_helidon_common_configurable_LruCache.adoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,34 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19+
ifndef::rootdir[:rootdir: {docdir}/..]
1920
:description: Configuration of io.helidon.common.configurable.LruCache
2021
:keywords: helidon, config, io.helidon.common.configurable.LruCache
2122
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.common.configurable.LruCache
23+
include::{rootdir}/includes/attributes.adoc[]
2224
23-
[source,text]
24-
.Type
25-
----
26-
io.helidon.common.configurable.LruCache
27-
----
25+
= LruCache (common.configurable) Configuration
2826
27+
// tag::config[]
2928
3029
31-
==== Configuration options
30+
Type: link:{javadoc-base-url}/io.helidon.common.configurable/io.helidon.common.configurable.LruCache[io.helidon.common.configurable.LruCache]
3231
3332
3433
3534
35+
== Configuration options
36+
37+
38+
3639
Optional configuration options:
37-
[cols="3,3,2,5"]
40+
[cols="3,3,2,5a"]
3841
3942
|===
4043
|key |type |default value |description
4144
4245
|`capacity` |int |`10000` |Configure capacity of the cache.
4346
4447
|===
48+
49+
// end::config[]

docs/includes/config/io.helidon.common.configurable.Resource.adoc renamed to docs/config/io_helidon_common_configurable_Resource.adoc

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,36 +16,41 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19+
ifndef::rootdir[:rootdir: {docdir}/..]
1920
:description: Configuration of io.helidon.common.configurable.Resource
2021
:keywords: helidon, config, io.helidon.common.configurable.Resource
2122
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.common.configurable.Resource
23+
include::{rootdir}/includes/attributes.adoc[]
2224
23-
[source,text]
24-
.Type
25-
----
26-
io.helidon.common.configurable.Resource
27-
----
25+
= Resource (common.configurable) Configuration
2826
27+
// tag::config[]
2928
3029
31-
==== Configuration options
30+
Type: link:{javadoc-base-url}/io.helidon.common.configurable/io.helidon.common.configurable.Resource[io.helidon.common.configurable.Resource]
3231
3332
3433
3534
35+
== Configuration options
36+
37+
38+
3639
Optional configuration options:
37-
[cols="3,3,2,5"]
40+
[cols="3,3,2,5a"]
3841
3942
|===
4043
|key |type |default value |description
4144
45+
|`content` |string |{nbsp} |Base64 encoded content of the resource
46+
|`content-plain` |string |{nbsp} |Plain text content of the resource
4247
|`path` |string |{nbsp} |File system path to the resource.
43-
|`resource-path` |string |{nbsp} |Classpath location of the resource.
4448
|`proxy-host` |string |{nbsp} |Host of the proxy when using url.
49+
|`proxy-port` |int |{nbsp} |Port of the proxy when using url.
50+
|`resource-path` |string |{nbsp} |Classpath location of the resource.
4551
|`uri` |URI |{nbsp} |URI of the resource.
4652
|`use-proxy` |boolean |`true` |Whether to use proxy. Only used if proxy-host is defined as well.
47-
|`content-plain` |string |{nbsp} |Plain text content of the resource
48-
|`proxy-port` |int |{nbsp} |Port of the proxy when using url.
49-
|`content` |string |{nbsp} |Base64 encoded content of the resource
5053
5154
|===
55+
56+
// end::config[]

docs/includes/config/io.helidon.common.configurable.ScheduledThreadPoolSupplier.adoc renamed to docs/config/io_helidon_common_configurable_ScheduledThreadPoolSupplier.adoc

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,37 @@
1616

1717
///////////////////////////////////////////////////////////////////////////////
1818
19+
ifndef::rootdir[:rootdir: {docdir}/..]
1920
:description: Configuration of io.helidon.common.configurable.ScheduledThreadPoolSupplier
2021
:keywords: helidon, config, io.helidon.common.configurable.ScheduledThreadPoolSupplier
2122
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.common.configurable.ScheduledThreadPoolSupplier
23+
include::{rootdir}/includes/attributes.adoc[]
2224
23-
[source,text]
24-
.Type
25-
----
26-
io.helidon.common.configurable.ScheduledThreadPoolSupplier
27-
----
25+
= ScheduledThreadPoolSupplier (common.configurable) Configuration
2826
27+
// tag::config[]
2928
3029
31-
==== Configuration options
30+
Type: link:{javadoc-base-url}/io.helidon.common.configurable/io.helidon.common.configurable.ScheduledThreadPoolSupplier[io.helidon.common.configurable.ScheduledThreadPoolSupplier]
3231
3332
3433
3534
35+
== Configuration options
36+
37+
38+
3639
Optional configuration options:
37-
[cols="3,3,2,5"]
40+
[cols="3,3,2,5a"]
3841
3942
|===
4043
|key |type |default value |description
4144
42-
|`thread-name-prefix` |string |`helidon-` |Name prefix for threads in this thread pool executor.
43-
|`should-prestart` |boolean |`true` |Whether to prestart core threads in this thread pool executor.
4445
|`core-pool-size` |int |`16` |Core pool size of the thread pool executor.
4546
|`is-daemon` |boolean |`true` |Is daemon of the thread pool executor.
47+
|`should-prestart` |boolean |`true` |Whether to prestart core threads in this thread pool executor.
48+
|`thread-name-prefix` |string |`helidon-` |Name prefix for threads in this thread pool executor.
4649
4750
|===
51+
52+
// end::config[]

0 commit comments

Comments
 (0)