includes.attributes.adoc Maven / Gradle / Ivy
The newest version!
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2022, 2024 Oracle and/or its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
///////////////////////////////////////////////////////////////////////////////
ifndef::attributes-included[]
:attributes-included: true
// functional attributes
:imagesdir: {rootdir}/images
:helidon-version: 4.1.1
:helidon-version-is-release: true
:sourcedir: {rootdir}/../java/io/helidon/docs
ifeval::["{helidon-version-is-release}" != "true"]
:helidon-github-tree-url: https://github.com/oracle/helidon/tree/main
:helidon-github-examples-url: https://github.com/helidon-io/helidon-examples/tree/helidon-4.x/examples
endif::[]
ifeval::["{helidon-version-is-release}" == "true"]
:helidon-github-tree-url: https://github.com/oracle/helidon/tree/{helidon-version}
:helidon-github-examples-url: https://github.com/helidon-io/helidon-examples/tree/{helidon-version}/examples
endif::[]
// versions
:version-plugin-helidon: 3.0.5
:version-lib-microprofile-api: 6.1
// microprofile specifications
:version-lib-microprofile-lra-api: 2.0
:version-lib-microprofile-config: 3.1
:version-lib-microprofile-fault-tolerance-api: 4.0.2
:version-lib-microprofile-graphql: 2.0
:version-lib-microprofile-health: 4.0
:version-lib-microprofile-jwt: 2.1
:version-lib-microprofile-metrics-api: 5.1.1
:version-lib-microprofile-openapi-api: 3.1.1
:version-lib-microprofile-reactive-messaging-api: 3.0
:version-lib-microprofile-rs-operators-api: 3.0
:version-lib-microprofile-rest-client: 3.0
:version-lib-microprofile-telemetry-tck: 1.1
:version-lib-microprofile-telemetry: 1.1
:version-lib-microprofile-tracing: 3.0
// jakarta specifications
:version-lib-jakarta-core: 10
:version-lib-jakarta-cdi: 4.0
:version-lib-jakarta-websockets-api: 2.1
:version-lib-jakarta-bean-validation: 3.0
:version-lib-jakarta-jsonp-api: 2.1
:version-lib-jakarta-jsonb-api: 3.0
:version-lib-jakarta-jsonp-api: 2.1
:version-lib-jakarta-annotations-api: 2.1.1
:version-lib-jakarta-transaction-api: 2.0
:version-lib-jakarta-persistence-api: 3.1
:version-lib-jakarta-jaxrs-api: 3.1
:version-lib-jakarta-inject: 2.0
// 3rd party
:version-lib-jaeger: 1.22
:version-lib-hikaricp: 5.0.1
:version-lib-eclipselink: 4.0.2
:version-lib-hibernate: 6.1
:version-lib-oracle-jdbc: 21
:version-lib-oracle-ucp: {version-lib-oracle-jdbc}
:version-plugin-jib: 0.10.1
:version-plugin-jandex: 3.1.2
:version-lib-micrometer: 1.11.1
:version-lib-smallrye-open-api: 3.3.4
:jdk-version: 21
:jdk-doc-url: https://docs.oracle.com/en/java/javase/21
:jdk-javadoc-url: {jdk-doc-url}/docs/api
:helidon-maven-plugin-doc-url: https://github.com/oracle/helidon-build-tools/blob/{version-plugin-helidon}/maven-plugins/helidon-maven-plugin/README.md
// MicroProfile versioned URLs
:microprofile-base-url: https://download.eclipse.org/microprofile
:microprofile-open-api-base-url: {microprofile-base-url}/microprofile-open-api-{version-lib-microprofile-openapi-api}
:microprofile-open-api-spec-url: {microprofile-open-api-base-url}/microprofile-openapi-spec-{version-lib-microprofile-openapi-api}.html
:microprofile-open-api-javadoc-base-url: {microprofile-open-api-base-url}/apidocs
:microprofile-open-api-javadoc-url: {microprofile-open-api-javadoc-base-url}/org/eclipse/microprofile/openapi
:microprofile-lra-base-url: {microprofile-base-url}/microprofile-lra-{version-lib-microprofile-lra-api}
:microprofile-lra-spec-url: {microprofile-lra-base-url}/microprofile-lra-spec-{version-lib-microprofile-lra-api}.html
:microprofile-lra-javadoc-url: {microprofile-lra-base-url}/apidocs/org/eclipse/microprofile/lra/annotation/
:microprofile-fault-tolerance-base-url: {microprofile-base-url}/microprofile-fault-tolerance-{version-lib-microprofile-fault-tolerance-api}
:microprofile-fault-tolerance-spec-url: {microprofile-fault-tolerance-base-url}/microprofile-fault-tolerance-spec-{version-lib-microprofile-fault-tolerance-api}.html
:microprofile-fault-tolerance-javadoc-url: {microprofile-fault-tolerance-base-url}/apidocs
:microprofile-metrics-base-url: {microprofile-base-url}/microprofile-metrics-{version-lib-microprofile-metrics-api}
:microprofile-metrics-spec-url: {microprofile-metrics-base-url}/microprofile-metrics-spec-{version-lib-microprofile-metrics-api}.html
:microprofile-metrics-javadoc-url: {microprofile-metrics-base-url}/apidocs
:microprofile-metrics-javadoc-annotation-url: {microprofile-metrics-javadoc-url}/org/eclipse/microprofile/metrics/annotation
:microprofile-metrics-javadoc-metric-url: {microprofile-metrics-javadoc-url}/org/eclipse/microprofile/metrics
:microprofile-tracing-base-url: {microprofile-base-url}/microprofile-opentracing-{version-lib-microprofile-tracing}
:microprofile-tracing-spec-url: {microprofile-tracing-base-url}/microprofile-opentracing-spec-{version-lib-microprofile-tracing}.html
:microprofile-tracing-javadoc-url: {microprofile-tracing-base-url}/apidocs
:microprofile-health-base-url: {microprofile-base-url}/microprofile-health-{version-lib-microprofile-health}
:microprofile-health-spec-url: {microprofile-health-base-url}/microprofile-health-spec-{version-lib-microprofile-health}.html
:microprofile-health-javadoc-url: {microprofile-health-base-url}/apidocs
:microprofile-config-base-url: {microprofile-base-url}/microprofile-config-{version-lib-microprofile-config}
:microprofile-config-spec-url: {microprofile-config-base-url}/microprofile-config-spec-{version-lib-microprofile-config}.html
:microprofile-config-javadoc-url: {microprofile-config-base-url}/apidocs
:microprofile-reactive-messaging-base-url: {microprofile-base-url}/microprofile-reactive-messaging-{version-lib-microprofile-reactive-messaging-api}
:microprofile-reactive-messaging-spec-url: {microprofile-reactive-messaging-base-url}/microprofile-reactive-messaging-spec-{version-lib-microprofile-reactive-messaging-api}.html
:microprofile-reactive-messaging-javadoc-url: {microprofile-reactive-messaging-base-url}/apidocs
:microprofile-rs-operators-base-url: {microprofile-base-url}/microprofile-reactive-streams-operators-{version-lib-microprofile-rs-operators-api}
:microprofile-rs-operators-spec-url: {microprofile-rs-operators-base-url}/microprofile-reactive-streams-operators-spec-{version-lib-microprofile-rs-operators-api}.html
:microprofile-rs-operators-javadoc-url: {microprofile-rs-operators-base-url}/apidocs
:microprofile-jwt-base-url: {microprofile-base-url}/microprofile-jwt-auth-{version-lib-microprofile-jwt}
:microprofile-jwt-spec-url: {microprofile-jwt-base-url}/microprofile-jwt-auth-spec-{version-lib-microprofile-jwt}.html
:microprofile-jwt-javadoc-url: {microprofile-jwt-base-url}/apidocs
:microprofile-rest-client-base-url: {microprofile-base-url}/microprofile-rest-client-{version-lib-microprofile-rest-client}
:microprofile-rest-client-spec-url: {microprofile-rest-client-base-url}/microprofile-rest-client-spec-{version-lib-microprofile-rest-client}.html
:microprofile-rest-client-javadoc-url: {microprofile-rest-client-base-url}/apidocs
:microprofile-graphql-base-url: {microprofile-base-url}/microprofile-graphql-{version-lib-microprofile-graphql}
:microprofile-graphql-spec-url: {microprofile-graphql-base-url}/microprofile-graphql-spec-{version-lib-microprofile-graphql}.html
:microprofile-graphql-javadoc-url: {microprofile-graphql-base-url}/apidocs
// Jakarta versioned URLs
:jakarta-base-url: https://jakarta.ee/specifications
:jakarta-cdi-base-url: {jakarta-base-url}/cdi/{version-lib-jakarta-cdi}
:jakarta-cdi-spec-url: {jakarta-cdi-base-url}/jakarta-cdi-spec-{version-lib-jakarta-cdi}.html
:jakarta-cdi-javadoc-url: {jakarta-cdi-base-url}/apidocs/
:jakarta-websocket-base-url: {jakarta-base-url}/websocket/{version-lib-jakarta-websockets-api}
:jakarta-websocket-spec-url: {jakarta-websocket-base-url}/jakarta-websocket-spec-{version-lib-jakarta-websockets-api}.html
:jakarta-websocket-javadoc-url: {jakarta-websocket-base-url}/apidocs/
:jakarta-bean-validation-base-url: {jakarta-base-url}/bean-validation/{version-lib-jakarta-bean-validation}
:jakarta-bean-validation-spec-url: {jakarta-bean-validation-base-url}/jakarta-bean-validation-spec-{version-lib-jakarta-bean-validation}.html
:jakarta-bean-validation-javadoc-url: {jakarta-bean-validation-base-url}/apidocs
:jakarta-jsonp-base-url: {jakarta-base-url}/jsonp/{version-lib-jakarta-jsonp-api}
:jakarta-jsonp-javadoc-url: {jakarta-jsonp-base-url}/apidocs
:jakarta-jsonb-base-url: {jakarta-base-url}/jsonb/{version-lib-jakarta-jsonb-api}
:jakarta-jsonb-spec-url: {jakarta-jsonb-base-url}/jakarta-jsonb-spec-{version-lib-jakarta-jsonb-api}.html
:jakarta-jsonb-javadoc-url: {jakarta-jsonb-base-url}/apidocs
:jakarta-transactions-base-url: {jakarta-base-url}/transactions/{version-lib-jakarta-transaction-api}
:jakarta-transactions-spec-url: {jakarta-transactions-base-url}/jakarta-transactions-spec-{version-lib-jakarta-transaction-api}.html
:jakarta-transactions-javadoc-url: {jakarta-transactions-base-url}/apidocs
:jakarta-persistence-base-url: {jakarta-base-url}/persistence/{version-lib-jakarta-persistence-api}
:jakarta-persistence-spec-url: {jakarta-persistence-base-url}/jakarta-persistence-spec-{version-lib-jakarta-persistence-api}.html
:jakarta-persistence-javadoc-url: {jakarta-persistence-base-url}/apidocs
:jakarta-jaxrs-base-url: {jakarta-base-url}/restful-ws/{version-lib-jakarta-jaxrs-api}
:jakarta-jaxrs-spec-url: {jakarta-jaxrs-base-url}/jakarta-restful-ws-spec-{version-lib-jakarta-jaxrs-api}.html
:jakarta-jaxrs-javadoc-url: {jakarta-jaxrs-base-url}/apidocs
:jakarta-inject-base-url: {jakarta-base-url}/dependency-injection/{version-lib-jakarta-inject}
:jakarta-inject-spec-url: {jakarta-inject-base-url}/jakarta-injection-spec-{version-lib-jakarta-inject}.html
:jakarta-inject-javadoc-url: {jakarta-inject-base-url}/apidocs
:javadoc-io-base-url: https://www.javadoc.io
// base url prefix (could also be https://helidon.io/docs/latest)
:base-url:
:javadoc-base-url: {base-url}/apidocs
// Helidon component javadoc base URLs
:http-javadoc-base-url: {javadoc-base-url}/io.helidon.http
:uri-javadoc-base-url: {javadoc-base-url}/io.helidon.common.uri
:common-javadoc-base-url: {javadoc-base-url}/io.helidon.common
:config-javadoc-base-url: {javadoc-base-url}/io.helidon.config
:config-etcd-javadoc-base-url: {javadoc-base-url}/io.helidon.config.etcd
:config-git-javadoc-base-url: {javadoc-base-url}/io.helidon.config.git
:config-mapping-javadoc-base-url: {javadoc-base-url}/io.helidon.config.objectmapping
:configurable-javadoc-base-url: {javadoc-base-url}/io.helidon.common.configurable
:cors-javadoc-base-url: {javadoc-base-url}/io.helidon.cors
:faulttolerance-javadoc-base-url: {javadoc-base-url}/io.helidon.faulttolerance
:grpc-server-javadoc-base-url: {javadoc-base-url}/io.helidon.webserver.grpc
:health-javadoc-base-url: {javadoc-base-url}/io.helidon.health.checks
:http-javadoc-base-url: {javadoc-base-url}/io.helidon.http
:integration-oci-sdk-cdi-javadoc-base-url: {javadoc-base-url}/io.helidon.integrations.oci.sdk.cdi
:media-jsonp-javadoc-base-url: {javadoc-base-url}/io.helidon.http.media.jsonp
:media-jsonb-javadoc-base-url: {javadoc-base-url}/io.helidon.http.media.jsonb
:media-jackson-javadoc-base-url: {javadoc-base-url}/io.helidon.http.media.jackson
:metrics-javadoc-base-url: {javadoc-base-url}/io.helidon.metrics.api
:metrics-mp-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.metrics
:metrics-serviceapi-javadoc-base-url: {javadoc-base-url}/io.helidon.metrics.serviceapi
:micrometer-javadoc-base-url: {javadoc-base-url}/io.helidon.integrations.micrometer
:prometheus-javadoc-base-url: {javadoc-base-url}/io.helidon.metrics.prometheus
:mp-cors-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.cors
:mp-server-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.server
:mp-tyrus-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.tyrus
:mp-restclient-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.restclient
:openapi-javadoc-base-url: {javadoc-base-url}/io.helidon.openapi
:openapi-ui-javadoc-base-url: {javadoc-base-url}/io.helidon.integrations.openapi.ui
:reactive-base-url: {javadoc-base-url}/io.helidon.common.reactive
:scheduling-javadoc-base-url: {javadoc-base-url}/io.helidon.microprofile.scheduling
:security-integration-jersey-base-url: {javadoc-base-url}/io.helidon.security.integration.jersey
:security-integration-webserver-base-url: {javadoc-base-url}/io.helidon.webserver.security
:tracing-javadoc-base-url: {javadoc-base-url}/io.helidon.tracing
:webclient-javadoc-base-url: {javadoc-base-url}/io.helidon.webclient
:webserver-javadoc-base-url: {javadoc-base-url}/io.helidon.webserver
:webserver-staticcontent-javadoc-base-url: {webserver-javadoc-base-url}.staticcontent
:webserver-cors-javadoc-base-url: {javadoc-base-url}/io.helidon.webserver.cors
:graphql-javadoc-base-url: {javadoc-base-url}/io.helidon.graphql.server
:security-provider-oidc-base-url: {javadoc-base-url}/io.helidon.security.providers.oidc
:security-provider-httpauth-base-url: {javadoc-base-url}/io.helidon.security.providers.httpauth
:security-provider-header-base-url: {javadoc-base-url}/io.helidon.security.providers.header
:security-provider-httpsign-base-url: {javadoc-base-url}/io.helidon.security.providers.httpsign
:security-provider-idcs-mapper-base-url: {javadoc-base-url}/io.helidon.security.providers.idcs.mapper
:security-provider-abac-base-url: {javadoc-base-url}/io.helidon.security.providers.abac
:security-provider-google-login-base-url: {javadoc-base-url}/io.helidon.security.providers.google.login
:security-provider-jwt-base-url: {javadoc-base-url}/io.helidon.security.providers.jwt
:faulttolerance-javadoc-base-url: {javadoc-base-url}/io.helidon.faulttolerance
// 3rd party versioned URLs
:jaeger-doc-base-url: https://www.jaegertracing.io/docs/{version-lib-jaeger}
:hikaricp-base-url: https://github.com/brettwooldridge/HikariCP/blob/HikariCP-{version-lib-hikaricp}
:hikaricp-javadoc-url: {javadoc-io-base-url}/com.zaxxer/HikariCP/{version-lib-hikaricp}
:eclipselink-doc-base-url: https://www.eclipse.org/eclipselink/documentation/{version-lib-eclipselink}
:hibernate-doc-base-url: https://hibernate.org/orm/documentation/{version-lib-hibernate}
:hibernate-doc-jboss-url: https://docs.jboss.org/hibernate/orm/{version-lib-hibernate}
:hibernate-javadoc-base-url: {hibernate-doc-jboss-url}/javadocs
:jib-base-url: https://github.com/GoogleContainerTools/jib/blob/v{version-plugin-jib}-maven/jib-maven-plugin
:kafka-client-base-url: https://kafka.apache.org/28/documentation.html
:openapi-version: 3.0.0
:openapi-spec-base-url: https://github.com/OAI/OpenAPI-Specification/blob/master/versions
:openapi-spec-url: {openapi-spec-base-url}/{openapi-version}.md
:oci-sdk-config-url: https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File
:oci-database-url: https://docs.oracle.com/en-us/iaas/Content/Database/home.htm
:oci-cli-url: https://docs.oracle.com/en-us/iaas/tools/oci-cli/latest
:oci-javasdk-url: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/javasdk.htm
:oci-objstore-url: https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm
:oci-vault-url: https://docs.oracle.com/en-us/iaas/Content/KeyManagement/home.htm
:oci-javasdk-javadoc-base-url: https://docs.oracle.com/en-us/iaas/tools/java/latest
:oci-javasdk-database-javadoc-base-url: {oci-javasdk-javadoc-base-url}/com/oracle/bmc/database
:oci-javasdk-objstore-javadoc-base-url: {oci-javasdk-javadoc-base-url}/com/oracle/bmc/objectstorage
:oci-javasdk-vault-javadoc-base-url: {oci-javasdk-javadoc-base-url}/com/oracle/bmc/vault
:openmetrics-exemplar-spec-url: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#exemplars
:oracle-jdbc-doc-base-url: https://docs.oracle.com/en/database/oracle/oracle-database/{version-lib-oracle-jdbc}/jjdbc
:oracle-jdbc-javadoc-base-url: https://docs.oracle.com/en/database/oracle/oracle-database/{version-lib-oracle-jdbc}/jajdb
:oracle-ucp-doc-base-url: https://docs.oracle.com/en/database/oracle/oracle-database/{version-lib-oracle-ucp}/jjucp
:oracle-ucp-javadoc-base-url: https://docs.oracle.com/en/database/oracle/oracle-database/{version-lib-oracle-ucp}/jjuar
:micrometer-url: https://micrometer.io
:micrometer-api-url: https://docs.micrometer.io/micrometer/reference/concepts.html
:micrometer-javadoc-base-url: https://javadoc.io/doc/io.micrometer
:micrometer-javadoc-registry-prometheus-base-url: {micrometer-javadoc-base-url}/micrometer-registry-prometheus/{version-lib-micrometer}/io/micrometer/prometheus
// OpenAPI generator
:openapi-generator-version: 7.6.0
:openapi-generator-tool-base-url: https://github.com/OpenAPITools/openapi-generator
:openapi-generator-site-version: v{openapi-generator-version}
:openapi-generator-tool-docs-url: {openapi-generator-tool-base-url}/blob/{openapi-generator-site-version}/docs
:openapi-generator-tool-generators-docs-url: {openapi-generator-tool-docs-url}/generators
:openapi-generator-tool-site-url: https://openapi-generator.tech
// GraalVM
:graalvm-jdk-version: 21
:graalvm-doc-url: https://www.graalvm.org/jdk{graalvm-jdk-version}/
// OpenAPI UI
:smallrye-openapi-ui-base-url: https://github.com/smallrye/smallrye-open-api/tree/{version-lib-smallrye-open-api}/ui/open-api-ui
endif::attributes-included[]