From 7ed9c1988348018a0934442e841c390d7d42893a Mon Sep 17 00:00:00 2001 From: JordenReuter <149687553+JordenReuter@users.noreply.github.com> Date: Thu, 11 Jul 2024 12:50:18 +0200 Subject: [PATCH] feat: update parent + openapi docs (#90) Co-authored-by: Andrej Petras --- docs/modules/onecx-product-store-svc/nav.adoc | 4 ++- .../onecx-product-store-svc-extensions.adoc | 26 +++++++++---------- .../pages/openapi/onecx-product-store-v1.adoc | 2 ++ pom.xml | 19 ++++++++++++++ 4 files changed, 37 insertions(+), 14 deletions(-) create mode 100644 docs/modules/onecx-product-store-svc/pages/openapi/onecx-product-store-v1.adoc diff --git a/docs/modules/onecx-product-store-svc/nav.adoc b/docs/modules/onecx-product-store-svc/nav.adoc index ae8bcd7..5ff703c 100644 --- a/docs/modules/onecx-product-store-svc/nav.adoc +++ b/docs/modules/onecx-product-store-svc/nav.adoc @@ -1 +1,3 @@ -* xref:onecx-product-store-svc:index.adoc[Product Store Service] \ No newline at end of file +* xref:onecx-product-store-svc:index.adoc[Product Store Service] +** External API(s) +*** xref:onecx-product-store-svc:openapi/onecx-product-store-v1.adoc[Product Store V1] \ No newline at end of file diff --git a/docs/modules/onecx-product-store-svc/pages/onecx-product-store-svc-extensions.adoc b/docs/modules/onecx-product-store-svc/pages/onecx-product-store-svc-extensions.adoc index 538f89c..4db6ea5 100644 --- a/docs/modules/onecx-product-store-svc/pages/onecx-product-store-svc-extensions.adoc +++ b/docs/modules/onecx-product-store-svc/pages/onecx-product-store-svc-extensions.adoc @@ -48,73 +48,73 @@ h| Version | https://quarkus.io/guides/cdi-reference[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-arc.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-liquibase | https://quarkus.io/guides/liquibase[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-liquibase.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-smallrye-health | https://quarkus.io/guides/smallrye-health[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-health.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-micrometer-registry-prometheus | https://quarkus.io/guides/telemetry-micrometer[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-micrometer-registry-prometheus.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-hibernate-orm | https://quarkus.io/guides/hibernate-orm[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-orm.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-rest | https://quarkus.io/guides/rest[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-rest.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-rest-jackson | https://quarkus.io/guides/rest-json[Link] | -| 3.12.0 +| 3.12.2 | quarkus-jdbc-postgresql | https://quarkus.io/guides/datasource[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-jdbc-postgresql.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-smallrye-openapi | https://quarkus.io/guides/openapi-swaggerui[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-hibernate-validator | https://quarkus.io/guides/validation[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-validator.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-opentelemetry | https://quarkus.io/guides/opentelemetry[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-opentelemetry.adoc[Link] -| 3.12.0 +| 3.12.2 | quarkus-oidc | https://quarkus.io/guides/security-oidc-bearer-token-authentication-tutorial[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc.adoc[Link] -| 3.12.0 +| 3.12.2 | tkit-quarkus-security @@ -132,7 +132,7 @@ h| Version | https://quarkus.io/guides/container-image[Link] | https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-container-image-docker.adoc[Link] -| 3.12.0 +| 3.12.2 | onecx-security diff --git a/docs/modules/onecx-product-store-svc/pages/openapi/onecx-product-store-v1.adoc b/docs/modules/onecx-product-store-svc/pages/openapi/onecx-product-store-v1.adoc new file mode 100644 index 0000000..3cc9aa8 --- /dev/null +++ b/docs/modules/onecx-product-store-svc/pages/openapi/onecx-product-store-v1.adoc @@ -0,0 +1,2 @@ +:page-layout: swagger +:page-swagger-url: https://raw.githubusercontent.com/onecx/onecx-product-store-svc/main/src/main/openapi/onecx-product-store-v1.yaml diff --git a/pom.xml b/pom.xml index bf9baec..11d29ac 100644 --- a/pom.xml +++ b/pom.xml @@ -144,6 +144,25 @@ + + org.tkit.maven + tkit-docs-quarkus-plugin + + + docs + prepare-package + + docs + + + ${skipDocs} + + onecx-product-store-v1.yaml + + + + + org.openapitools openapi-generator-maven-plugin