Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 19, 2023
1 parent 299aef5 commit e88d149
Show file tree
Hide file tree
Showing 25 changed files with 482 additions and 352 deletions.
38 changes: 19 additions & 19 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ types:
- title: Authorization of web endpoints
filename: security-authorize-web-endpoints-reference.adoc
summary: Quarkus has an integrated pluggable web security layer.
categories: "web, security"
categories: "security, web"
id: security-authorize-web-endpoints-reference
type: reference
url: /guides/security-authorize-web-endpoints-reference
Expand All @@ -18,7 +18,7 @@ types:
- title: Command Mode Applications
filename: command-mode-reference.adoc
summary: This reference guide explains how to develop command line applications with Quarkus.
categories: "command-line, core"
categories: "core, command-line"
type: reference
url: /guides/command-mode-reference
- title: Configuration Reference Guide
Expand Down Expand Up @@ -55,7 +55,7 @@ types:
- title: Logging configuration
filename: logging.adoc
summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."
categories: "getting-started, core"
categories: "core, getting-started"
id: logging
type: reference
url: /guides/logging
Expand Down Expand Up @@ -152,14 +152,14 @@ types:
- title: Authentication mechanisms in Quarkus
filename: security-authentication-mechanisms.adoc
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
categories: "web, security"
categories: "security, web"
id: security-authentication-mechanisms
type: concepts
url: /guides/security-authentication-mechanisms
- title: Basic authentication
filename: security-basic-authentication.adoc
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
categories: "web, security"
categories: "security, web"
id: security-basic-authentication
type: concepts
url: /guides/security-basic-authentication
Expand All @@ -180,21 +180,21 @@ types:
- title: OpenID Connect (OIDC) Bearer token authentication
filename: security-oidc-bearer-token-authentication.adoc
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer token authentication by using the Quarkus OpenID Connect (OIDC) extension.
categories: "web, security"
categories: "security, web"
id: security-oidc-bearer-token-authentication
type: concepts
url: /guides/security-oidc-bearer-token-authentication
- title: OpenID Connect authorization code flow mechanism for protecting web applications
filename: security-oidc-code-flow-authentication.adoc
summary: "To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension."
categories: "web, security"
categories: "security, web"
id: security-oidc-code-flow-authentication
type: concepts
url: /guides/security-oidc-code-flow-authentication
- title: Proactive authentication
filename: security-proactive-authentication.adoc
summary: Proactive authentication is enabled in Quarkus by default.
categories: "web, security"
categories: "security, web"
id: security-proactive-authentication
type: concepts
url: /guides/security-proactive-authentication
Expand Down Expand Up @@ -222,7 +222,7 @@ types:
- title: Security vulnerability detection and reporting in Quarkus
filename: security-vulnerability-detection.adoc
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
categories: "contributing, security"
categories: "security, contributing"
id: security-vulnerability-detection
type: concepts
url: /guides/security-vulnerability-detection
Expand Down Expand Up @@ -291,7 +291,7 @@ types:
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
filename: security-oidc-code-flow-authentication-tutorial.adoc
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
categories: "web, security"
categories: "security, web"
id: security-oidc-code-flow-authentication-tutorial
type: tutorial
url: /guides/security-oidc-code-flow-authentication-tutorial
Expand All @@ -304,7 +304,7 @@ types:
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
filename: security-basic-authentication-tutorial.adoc
summary: Secure your Quarkus application endpoints by combining the built-in Quarkus Basic authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC).
categories: "getting-started, security"
categories: "security, getting-started"
id: security-basic-authentication-tutorial
type: tutorial
url: /guides/security-basic-authentication-tutorial
Expand Down Expand Up @@ -917,14 +917,14 @@ types:
- title: Quarkus and Gradle
filename: gradle-tooling.adoc
summary: Develop and build your Quarkus application with Gradle
categories: "native, tooling"
categories: "tooling, native"
id: gradle-tooling
type: guide
url: /guides/gradle-tooling
- title: Quarkus and Maven
filename: maven-tooling.adoc
summary: Develop and build your Quarkus application with Maven
categories: "native, tooling"
categories: "tooling, native"
id: maven-tooling
type: guide
url: /guides/maven-tooling
Expand Down Expand Up @@ -998,7 +998,7 @@ types:
- title: Simplified Hibernate ORM with Panache and Kotlin
filename: hibernate-orm-panache-kotlin.adoc
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/hibernate-orm-panache-kotlin
- title: Simplified Hibernate Reactive with Panache
Expand All @@ -1016,13 +1016,13 @@ types:
- title: Simplified MongoDB with Panache and Kotlin
filename: mongodb-panache-kotlin.adoc
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/mongodb-panache-kotlin
- title: SmallRye Fault Tolerance
filename: smallrye-fault-tolerance.adoc
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
categories: "observability, web"
categories: "web, observability"
type: guide
url: /guides/smallrye-fault-tolerance
- title: SmallRye GraphQL
Expand Down Expand Up @@ -1052,7 +1052,7 @@ types:
- title: Testing Your Application
filename: getting-started-testing.adoc
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
categories: "core, native, tooling"
categories: "core, tooling, native"
id: testing
type: guide
url: /guides/getting-started-testing
Expand Down Expand Up @@ -1188,7 +1188,7 @@ types:
- title: Using SSL With Native Executables
filename: native-and-ssl.adoc
summary: "In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box."
categories: "core, native, security"
categories: "core, security, native"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down Expand Up @@ -1307,7 +1307,7 @@ types:
- title: Writing JSON REST Services
filename: rest-json.adoc
summary: JSON is now the lingua franca between microservices.
categories: "web, serialization"
categories: "serialization, web"
type: guide
url: /guides/rest-json
- title: Writing REST Services with RESTEasy Reactive
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.","withinAMap":false,"defaultValue":"http/protobuf","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
[{"configDocKey":{"type":"string","key":".endpoint","additionalKeys":[],"configDoc":"OTLP Exporter specific. Will override `otel.exporter.otlp.endpoint`, if set.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.exporter.otlp.endpoint<` or defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`.","withinAMap":false,"defaultValue":"http://localhost:4317/","javaDocSiteLink":"","docMapKey":"endpoint","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".headers","additionalKeys":[],"configDoc":"Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the \"=\" character. i.e.: key1=value1,key2=value2","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.CompressionType","key":".compression","additionalKeys":[],"configDoc":"Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression","configPhase":"BUILD_TIME","acceptedValues":["`gzip`","`none`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".protocol","additionalKeys":[],"configDoc":"OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.","withinAMap":false,"defaultValue":"http/protobuf","javaDocSiteLink":"","docMapKey":"protocol","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.KeyCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".key-cert.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-cert","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.opentelemetry.runtime.config.runtime.exporter.OtlpExporterTracesConfig.TrustCert","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".trust-cert.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

Large diffs are not rendered by default.

Loading

0 comments on commit e88d149

Please sign in to comment.