From b3ea7e9096fb9fbced5db7197e7b6f53bdadc3bc Mon Sep 17 00:00:00 2001 From: Joe Di Pol Date: Mon, 9 Oct 2023 17:07:14 -0700 Subject: [PATCH] Renamed openapi/openapi-ui to integrations/openapi-ui --- bom/pom.xml | 4 ++-- dependencies/pom.xml | 5 +++++ docs/config/io_helidon_openapi_ui_OpenApiUi.adoc | 8 ++++---- docs/includes/openapi/openapi-ui.adoc | 12 +++++++++++- {openapi => integrations}/openapi-ui/pom.xml | 11 ++++++----- .../helidon/integrations}/openapi/ui/OpenApiUi.java | 2 +- .../openapi/ui/OpenApiUiConfigBlueprint.java | 2 +- .../integrations}/openapi/ui/OpenApiUiProvider.java | 2 +- .../integrations}/openapi/ui/package-info.java | 2 +- .../openapi-ui/src/main/java/module-info.java | 5 +++-- .../main/resources/helidon-openapi-ui/favicon.ico | Bin .../src/main/resources/helidon-openapi-ui/logo.svg | 0 .../integrations}/openapi/ui/OpenApiUiTest.java | 2 +- .../openapi-ui/src/test/resources/greeting.yml | 0 openapi/pom.xml | 1 - 15 files changed, 36 insertions(+), 20 deletions(-) rename {openapi => integrations}/openapi-ui/pom.xml (94%) rename {openapi/openapi-ui/src/main/java/io/helidon => integrations/openapi-ui/src/main/java/io/helidon/integrations}/openapi/ui/OpenApiUi.java (99%) rename {openapi/openapi-ui/src/main/java/io/helidon => integrations/openapi-ui/src/main/java/io/helidon/integrations}/openapi/ui/OpenApiUiConfigBlueprint.java (97%) rename {openapi/openapi-ui/src/main/java/io/helidon => integrations/openapi-ui/src/main/java/io/helidon/integrations}/openapi/ui/OpenApiUiProvider.java (96%) rename {openapi/openapi-ui/src/main/java/io/helidon => integrations/openapi-ui/src/main/java/io/helidon/integrations}/openapi/ui/package-info.java (93%) rename {openapi => integrations}/openapi-ui/src/main/java/module-info.java (89%) rename {openapi => integrations}/openapi-ui/src/main/resources/helidon-openapi-ui/favicon.ico (100%) rename {openapi => integrations}/openapi-ui/src/main/resources/helidon-openapi-ui/logo.svg (100%) rename {openapi/openapi-ui/src/test/java/io/helidon => integrations/openapi-ui/src/test/java/io/helidon/integrations}/openapi/ui/OpenApiUiTest.java (99%) rename {openapi => integrations}/openapi-ui/src/test/resources/greeting.yml (100%) diff --git a/bom/pom.xml b/bom/pom.xml index 9baf6465362..28461116438 100644 --- a/bom/pom.xml +++ b/bom/pom.xml @@ -911,8 +911,8 @@ ${helidon.version} - io.helidon.openapi - helidon-openapi-ui + io.helidon.integrations.openapi-ui + helidon-integrations-openapi-ui ${helidon.version} diff --git a/dependencies/pom.xml b/dependencies/pom.xml index fe01502b47f..b0fa588c635 100644 --- a/dependencies/pom.xml +++ b/dependencies/pom.xml @@ -762,6 +762,11 @@ smallrye-open-api-jaxrs ${version.lib.smallrye-openapi} + + io.smallrye + smallrye-open-api-ui + ${version.lib.smallrye-openapi} + diff --git a/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc b/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc index 9db0e32dd62..f9fcf1970fd 100644 --- a/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc +++ b/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc @@ -17,9 +17,9 @@ /////////////////////////////////////////////////////////////////////////////// ifndef::rootdir[:rootdir: {docdir}/..] -:description: Configuration of io.helidon.openapi.ui.OpenApiUi -:keywords: helidon, config, io.helidon.openapi.ui.OpenApiUi -:basic-table-intro: The table below lists the configuration keys that configure io.helidon.openapi.ui.OpenApiUi +:description: Configuration of io.helidon.integrations.openapi.ui.OpenApiUi +:keywords: helidon, config, io.helidon.integrations.openapi.ui.OpenApiUi +:basic-table-intro: The table below lists the configuration keys that configure io.helidon.integrations.openapi.ui.OpenApiUi include::{rootdir}/includes/attributes.adoc[] = OpenApiUi (openapi.ui) Configuration @@ -27,7 +27,7 @@ include::{rootdir}/includes/attributes.adoc[] // tag::config[] -Type: link:{javadoc-base-url}/io.helidon.openapi.ui/io/helidon/openapi/ui/OpenApiUi.html[io.helidon.openapi.ui.OpenApiUi] +Type: link:{javadoc-base-url}/io.helidon.openapi.ui/io/helidon/openapi/ui/OpenApiUi.html[io.helidon.integrations.openapi.ui.OpenApiUi] diff --git a/docs/includes/openapi/openapi-ui.adoc b/docs/includes/openapi/openapi-ui.adoc index 7153db99887..ac226977a00 100644 --- a/docs/includes/openapi/openapi-ui.adoc +++ b/docs/includes/openapi/openapi-ui.adoc @@ -65,6 +65,16 @@ ifdef::mp-flavor[ runtime] ---- +And add a runtime dependency on the SmallRye UI. + +[source,xml,subs=+macros] +---- + + io.smallrye + smallrye-open-api-ui + runtime + +---- // end::dependencies[] // tag::usage[] @@ -197,4 +207,4 @@ Any options you configure override the values Helidon assigns, possibly interfer xref:{openapi-page}[Helidon OpenAPI {flavor-uc} documentation] link:{smallrye-openapi-ui-base-url}[SmallRye OpenAPI UI GitHub site] -// end::additional-info[] \ No newline at end of file +// end::additional-info[] diff --git a/openapi/openapi-ui/pom.xml b/integrations/openapi-ui/pom.xml similarity index 94% rename from openapi/openapi-ui/pom.xml rename to integrations/openapi-ui/pom.xml index 8511bbeccf2..07252851b16 100644 --- a/openapi/openapi-ui/pom.xml +++ b/integrations/openapi-ui/pom.xml @@ -19,13 +19,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - io.helidon.openapi - helidon-openapi-project + io.helidon.integrations + helidon-integrations-project 4.0.0-SNAPSHOT - helidon-openapi-ui - Helidon OpenAPI + io.helidon.integrations.openapi-ui + helidon-integrations-openapi-ui + Helidon OpenAPI UI Integration Helidon OpenAPI UI implementation @@ -49,7 +50,7 @@ io.smallrye smallrye-open-api-ui - ${version.lib.smallrye-openapi} + provided io.helidon.webserver diff --git a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUi.java b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUi.java similarity index 99% rename from openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUi.java rename to integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUi.java index 775b15843e7..78472146d94 100644 --- a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUi.java +++ b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUi.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.helidon.openapi.ui; +package io.helidon.integrations.openapi.ui; import java.io.IOException; import java.io.UncheckedIOException; diff --git a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiConfigBlueprint.java b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiConfigBlueprint.java similarity index 97% rename from openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiConfigBlueprint.java rename to integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiConfigBlueprint.java index 73ce8b11db6..a12bb3b6573 100644 --- a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiConfigBlueprint.java +++ b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiConfigBlueprint.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package io.helidon.openapi.ui; +package io.helidon.integrations.openapi.ui; import java.util.Map; import java.util.Optional; diff --git a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiProvider.java b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiProvider.java similarity index 96% rename from openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiProvider.java rename to integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiProvider.java index 43a3c127986..1350d9f625c 100644 --- a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/OpenApiUiProvider.java +++ b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/OpenApiUiProvider.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.helidon.openapi.ui; +package io.helidon.integrations.openapi.ui; import io.helidon.common.config.Config; import io.helidon.openapi.spi.OpenApiServiceProvider; diff --git a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/package-info.java b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/package-info.java similarity index 93% rename from openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/package-info.java rename to integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/package-info.java index cd9b011798a..78020242ebb 100644 --- a/openapi/openapi-ui/src/main/java/io/helidon/openapi/ui/package-info.java +++ b/integrations/openapi-ui/src/main/java/io/helidon/integrations/openapi/ui/package-info.java @@ -17,4 +17,4 @@ /** * Helidon OpenAPI UI support. */ -package io.helidon.openapi.ui; +package io.helidon.integrations.openapi.ui; diff --git a/openapi/openapi-ui/src/main/java/module-info.java b/integrations/openapi-ui/src/main/java/module-info.java similarity index 89% rename from openapi/openapi-ui/src/main/java/module-info.java rename to integrations/openapi-ui/src/main/java/module-info.java index 38713373ca1..65d6acad1ae 100644 --- a/openapi/openapi-ui/src/main/java/module-info.java +++ b/integrations/openapi-ui/src/main/java/module-info.java @@ -15,12 +15,13 @@ */ import io.helidon.common.features.api.Feature; import io.helidon.common.features.api.HelidonFlavor; +import io.helidon.integrations.openapi.ui.OpenApiUiProvider; @Feature(value = "OpenAPI UI", description = "OpenAPI UI support", in = HelidonFlavor.SE ) -module io.helidon.openapi.ui { +module io.helidon.integrations.openapi.ui { requires io.helidon.common.features.api; requires io.helidon.common.media.type; requires io.helidon.openapi; @@ -31,5 +32,5 @@ requires smallrye.open.api.ui; provides io.helidon.openapi.spi.OpenApiServiceProvider with - io.helidon.openapi.ui.OpenApiUiProvider; + OpenApiUiProvider; } diff --git a/openapi/openapi-ui/src/main/resources/helidon-openapi-ui/favicon.ico b/integrations/openapi-ui/src/main/resources/helidon-openapi-ui/favicon.ico similarity index 100% rename from openapi/openapi-ui/src/main/resources/helidon-openapi-ui/favicon.ico rename to integrations/openapi-ui/src/main/resources/helidon-openapi-ui/favicon.ico diff --git a/openapi/openapi-ui/src/main/resources/helidon-openapi-ui/logo.svg b/integrations/openapi-ui/src/main/resources/helidon-openapi-ui/logo.svg similarity index 100% rename from openapi/openapi-ui/src/main/resources/helidon-openapi-ui/logo.svg rename to integrations/openapi-ui/src/main/resources/helidon-openapi-ui/logo.svg diff --git a/openapi/openapi-ui/src/test/java/io/helidon/openapi/ui/OpenApiUiTest.java b/integrations/openapi-ui/src/test/java/io/helidon/integrations/openapi/ui/OpenApiUiTest.java similarity index 99% rename from openapi/openapi-ui/src/test/java/io/helidon/openapi/ui/OpenApiUiTest.java rename to integrations/openapi-ui/src/test/java/io/helidon/integrations/openapi/ui/OpenApiUiTest.java index 1efb1960bd4..b1b28e3aed1 100644 --- a/openapi/openapi-ui/src/test/java/io/helidon/openapi/ui/OpenApiUiTest.java +++ b/integrations/openapi-ui/src/test/java/io/helidon/integrations/openapi/ui/OpenApiUiTest.java @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package io.helidon.openapi.ui; +package io.helidon.integrations.openapi.ui; import java.util.Map; diff --git a/openapi/openapi-ui/src/test/resources/greeting.yml b/integrations/openapi-ui/src/test/resources/greeting.yml similarity index 100% rename from openapi/openapi-ui/src/test/resources/greeting.yml rename to integrations/openapi-ui/src/test/resources/greeting.yml diff --git a/openapi/pom.xml b/openapi/pom.xml index 5cbf41aa88e..64d14212efc 100644 --- a/openapi/pom.xml +++ b/openapi/pom.xml @@ -31,7 +31,6 @@ openapi - openapi-ui