Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
docs: generating docs with config patch - quarkusio/quarkus#5387
Browse files Browse the repository at this point in the history
  • Loading branch information
machi1990 committed Nov 13, 2019
1 parent aa357db commit 5d57cc9
Show file tree
Hide file tree
Showing 34 changed files with 312 additions and 418 deletions.
237 changes: 110 additions & 127 deletions src/main/asciidoc/generated/all-config.adoc

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions src/main/asciidoc/generated/quarkus-amazon-lambda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ h|[[quarkus-amazon-lambda_configuration]]link:#quarkus-amazon-lambda_configurati
h|Type
h|Default

a|icon:cogs[title=Overridable at runtime] [[quarkus-amazon-lambda_quarkus.lambda.handler]]`link:#quarkus-amazon-lambda_quarkus.lambda.handler[quarkus.lambda.handler]`
a|icon:archive[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus.lambda-build-time.enable-polling-jvm-mode]]`link:#quarkus-amazon-lambda_quarkus.lambda-build-time.enable-polling-jvm-mode[quarkus.lambda-build-time.enable-polling-jvm-mode]`

[.description]
--
The handler name. Handler names are specified on handler classes using the `@javax.inject.Named` annotation. If this name is unspecified and there is exactly one unnamed implementation of `com.amazonaws.services.lambda.runtime.RequestHandler` then this unnamed handler will be used. If there is only a single named handler and the name is unspecified then the named handler will be used.
--|string
|
If true, this will enable the aws event poll loop within a Quarkus test run. This loop normally only runs in native image. This option is strictly for testing purposes.
--|boolean
|`false`


a|icon:cogs[title=Overridable at runtime] [[quarkus-amazon-lambda_quarkus.lambda.enable-polling-jvm-mode]]`link:#quarkus-amazon-lambda_quarkus.lambda.enable-polling-jvm-mode[quarkus.lambda.enable-polling-jvm-mode]`
a|icon:cogs[title=Overridable at runtime] [[quarkus-amazon-lambda_quarkus.lambda.handler]]`link:#quarkus-amazon-lambda_quarkus.lambda.handler[quarkus.lambda.handler]`

[.description]
--
If true, this will enable the aws event poll loop within a Quarkus test run. This loop normally only runs in native image. This option is strictly for testing purposes.
--|boolean
|`false`
The handler name. Handler names are specified on handler classes using the `@javax.inject.Named` annotation. If this name is unspecified and there is exactly one unnamed implementation of `com.amazonaws.services.lambda.runtime.RequestHandler` then this unnamed handler will be used. If there is only a single named handler and the name is unspecified then the named handler will be used.
--|string
|

|===
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-application-config_quar
--
The name of the application. If not set, defaults to the name of the project.
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:archive[title=Fixed at build time] [[quarkus-core-application-config_quarkus.application.version]]`link:#quarkus-core-application-config_quarkus.application.version[quarkus.application.version]`
Expand All @@ -23,6 +23,6 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-application-config_quar
--
The version of the application. If not set, defaults to the version of the project
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|

|===
5 changes: 3 additions & 2 deletions src/main/asciidoc/generated/quarkus-core-jni-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-jni-config_quarkus.jni.
[.description]
--
Paths of library to load.
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|


a|icon:archive[title=Fixed at build time] [[quarkus-core-jni-config_quarkus.jni.enable]]`link:#quarkus-core-jni-config_quarkus.jni.enable[quarkus.jni.enable]`
Expand Down
12 changes: 7 additions & 5 deletions src/main/asciidoc/generated/quarkus-core-native-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.n
[.description]
--
Additional arguments to pass to the build process
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.enable-http-url-handler]]`link:#quarkus-core-native-config_quarkus.native.enable-http-url-handler[quarkus.native.enable-http-url-handler]`
Expand Down Expand Up @@ -195,16 +196,17 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.n
--
The container runtime (e.g. docker) that is used to do an image based build. If this is set then a container build is always done.
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.container-runtime-options]]`link:#quarkus-core-native-config_quarkus.native.container-runtime-options[quarkus.native.container-runtime-options]`

[.description]
--
Options to pass to the container runtime
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.enable-vm-inspection]]`link:#quarkus-core-native-config_quarkus.native.enable-vm-inspection[quarkus.native.enable-vm-inspection]`
Expand Down
5 changes: 3 additions & 2 deletions src/main/asciidoc/generated/quarkus-core-package-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ a|icon:archive[title=Fixed at build time] [[quarkus-core-package-config_quarkus.
[.description]
--
Files that should not be copied to the output artifact
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|


a|icon:archive[title=Fixed at build time] [[quarkus-core-package-config_quarkus.package.runner-suffix]]`link:#quarkus-core-package-config_quarkus.package.runner-suffix[quarkus.package.runner-suffix]`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-co
--
AWS Access key id
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-dynamodb-config-group-aws-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key[quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]`
Expand All @@ -95,7 +95,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-co
--
AWS Secret access key
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-config_quarkus.dynamodb.aws.credentials.profile-provider.profile-name]]`link:#quarkus-dynamodb-config-group-aws-config_quarkus.dynamodb.aws.credentials.profile-provider.profile-name[quarkus.dynamodb.aws.credentials.profile-provider.profile-name]`
Expand Down Expand Up @@ -144,7 +144,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-co
--
The command that should be executed to retrieve credentials.
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|

|===
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
The command that should be executed to retrieve credentials.
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|

|===
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
AWS Access key id
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-credentials-provider-config-static-credentials-provider-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-dynamodb-config-group-aws-credentials-provider-config-static-credentials-provider-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key[quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]`
Expand All @@ -23,6 +23,6 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
AWS Secret access key
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|

|===
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
AWS Access key id
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-credentials-provider-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-dynamodb-config-group-aws-credentials-provider-config_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key[quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]`
Expand All @@ -75,7 +75,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
AWS Secret access key
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-credentials-provider-config_quarkus.dynamodb.aws.credentials.profile-provider.profile-name]]`link:#quarkus-dynamodb-config-group-aws-credentials-provider-config_quarkus.dynamodb.aws.credentials.profile-provider.profile-name[quarkus.dynamodb.aws.credentials.profile-provider.profile-name]`
Expand Down Expand Up @@ -124,7 +124,7 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-aws-cr
--
The command that should be executed to retrieve credentials.
--|string
|required icon:exclamation-circle[title=Configuration property is required]
|

|===
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@ The endpoint of the proxy server that the SDK should connect through.
Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.
--|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI]

|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config-netty-proxy-configuration_quarkus.dynamodb.async-client.proxy.non-proxy-hosts]]`link:#quarkus-dynamodb-config-group-netty-http-client-config-netty-proxy-configuration_quarkus.dynamodb.async-client.proxy.non-proxy-hosts[quarkus.dynamodb.async-client.proxy.non-proxy-hosts]`

[.description]
--
The hosts that the client is allowed to access without going through the proxy.
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|

|===
Original file line number Diff line number Diff line change
Expand Up @@ -148,16 +148,17 @@ The endpoint of the proxy server that the SDK should connect through.
Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.
--|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI]

|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.proxy.non-proxy-hosts]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.proxy.non-proxy-hosts[quarkus.dynamodb.async-client.proxy.non-proxy-hosts]`

[.description]
--
The hosts that the client is allowed to access without going through the proxy.
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.type]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.type[quarkus.dynamodb.async-client.tls-managers-provider.type]`
Expand All @@ -177,32 +178,14 @@ Available providers:
|`system-property`
a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.path]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.path[quarkus.dynamodb.async-client.tls-managers-provider.file-store.path]`

[.description]
--
Path to the key store.
--|path
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.type]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.type[quarkus.dynamodb.async-client.tls-managers-provider.file-store.type]`
a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store[quarkus.dynamodb.async-client.tls-managers-provider.file-store]`

[.description]
--
Key store type.
See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types.
--|string
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.password]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.tls-managers-provider.file-store.password[quarkus.dynamodb.async-client.tls-managers-provider.file-store.password]`

[.description]
--
Key store password
--|string
|required icon:exclamation-circle[title=Configuration property is required]
Configuration of the file store provider.
Used only if `FILE_STORE` type is chosen.
--|FileStoreTlsManagersProviderConfig
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.event-loop.override]]`link:#quarkus-dynamodb-config-group-netty-http-client-config_quarkus.dynamodb.async-client.event-loop.override[quarkus.dynamodb.async-client.event-loop.override]`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ a|icon:archive[title=Fixed at build time] [[quarkus-dynamodb-config-group-sdk-bu
--
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface.
--|list of class name
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.Class<?>>.html[java.util.List<java.lang.Class<?>>]

|

|===
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The endpoint of the proxy server that the SDK should connect through.
Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.
--|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI]

|required icon:exclamation-circle[title=Configuration property is required]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-sync-http-client-config-apache-http-client-config-http-client-proxy-configuration_quarkus.dynamodb.sync-client.apache.proxy.username]]`link:#quarkus-dynamodb-config-group-sync-http-client-config-apache-http-client-config-http-client-proxy-configuration_quarkus.dynamodb.sync-client.apache.proxy.username[quarkus.dynamodb.sync-client.apache.proxy.username]`
Expand Down Expand Up @@ -78,7 +78,8 @@ a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-sync-h
[.description]
--
The hosts that the client is allowed to access without going through the proxy.
--|list of string
|required icon:exclamation-circle[title=Configuration property is required]
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/List<java.lang.String>.html[java.util.List<java.lang.String>]

|

|===
Loading

0 comments on commit 5d57cc9

Please sign in to comment.