Skip to content

Commit

Permalink
Sync web site with Quarkus documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quarkusbot committed Sep 26, 2024
1 parent 5d6645f commit ceb7503
Show file tree
Hide file tree
Showing 835 changed files with 411,828 additions and 0 deletions.
3,084 changes: 3,084 additions & 0 deletions _data/versioned/3-15/index/quarkus.yaml

Large diffs are not rendered by default.

21,344 changes: 21,344 additions & 0 deletions _data/versioned/3-15/index/relations.yaml

Large diffs are not rendered by default.

609 changes: 609 additions & 0 deletions _generated-doc/3.15/config/quarkus-agroal.adoc

Large diffs are not rendered by default.

609 changes: 609 additions & 0 deletions _generated-doc/3.15/config/quarkus-agroal_quarkus.datasource.adoc

Large diffs are not rendered by default.

76,279 changes: 76,279 additions & 0 deletions _generated-doc/3.15/config/quarkus-all-config.adoc

Large diffs are not rendered by default.

82 changes: 82 additions & 0 deletions _generated-doc/3.15/config/quarkus-amazon-lambda-http.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-amazon-lambda-http_quarkus-lambda-http
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##

[.description]
--
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##

[.description]
--
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##

[.description]
--
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##

[.description]
--
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"


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

|===


:!summaryTableId:
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-amazon-lambda-http_quarkus-lambda-http
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##

[.description]
--
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##

[.description]
--
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##

[.description]
--
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"


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

a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##

[.description]
--
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"


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

|===


:!summaryTableId:
82 changes: 82 additions & 0 deletions _generated-doc/3.15/config/quarkus-amazon-lambda-rest.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-amazon-lambda-rest_quarkus-lambda-http
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##

[.description]
--
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##

[.description]
--
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##

[.description]
--
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##

[.description]
--
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"


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

|===


:!summaryTableId:
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
:summaryTableId: quarkus-amazon-lambda-rest_quarkus-lambda-http
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##

[.description]
--
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##

[.description]
--
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##

[.description]
--
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"


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

a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##

[.description]
--
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"


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

|===


:!summaryTableId:
Loading

0 comments on commit ceb7503

Please sign in to comment.