Renamed openapi/openapi-ui to integrations/openapi-ui (helidon-io#7761)

dalexandrov · Oct 17, 2023 · 8347553 · 8347553
1 parent ec7bd69
commit 8347553
Show file tree

Hide file tree

Showing 15 changed files with 36 additions and 20 deletions.
diff --git a/bom/pom.xml b/bom/pom.xml
@@ -911,8 +911,8 @@
                 <version>${helidon.version}</version>
             </dependency>
             <dependency>
-                <groupId>io.helidon.openapi</groupId>
-                <artifactId>helidon-openapi-ui</artifactId>
+                <groupId>io.helidon.integrations.openapi-ui</groupId>
+                <artifactId>helidon-integrations-openapi-ui</artifactId>
                 <version>${helidon.version}</version>
             </dependency>
             <dependency>

diff --git a/dependencies/pom.xml b/dependencies/pom.xml
@@ -762,6 +762,11 @@
                 <artifactId>smallrye-open-api-jaxrs</artifactId>
                 <version>${version.lib.smallrye-openapi}</version>
             </dependency>
+            <dependency>
+                <groupId>io.smallrye</groupId>
+                <artifactId>smallrye-open-api-ui</artifactId>
+                <version>${version.lib.smallrye-openapi}</version>
+            </dependency>
 
             <!-- Microstream related -->
             <dependency>

diff --git a/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc b/docs/config/io_helidon_openapi_ui_OpenApiUi.adoc
@@ -17,17 +17,17 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 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
 
 // 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
@@ -65,6 +65,16 @@ ifdef::mp-flavor[    <scope>runtime</scope>]
 </dependency>
 ----
 
+And add a runtime dependency on the SmallRye UI.
+
+[source,xml,subs=+macros]
+----
+<dependency>
+    <groupId>io.smallrye</groupId>
+    <artifactId>smallrye-open-api-ui</artifactId>
+    <scope>runtime</scope>
+</dependency>
+----
 // 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[]
+// end::additional-info[]
diff --git a/openapi/openapi-ui/pom.xml → integrations/openapi-ui/pom.xml b/openapi/openapi-ui/pom.xml → 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">
     <modelVersion>4.0.0</modelVersion>
     <parent>
-        <groupId>io.helidon.openapi</groupId>
-        <artifactId>helidon-openapi-project</artifactId>
+        <groupId>io.helidon.integrations</groupId>
+        <artifactId>helidon-integrations-project</artifactId>
         <version>4.0.0-SNAPSHOT</version>
     </parent>
 
-    <artifactId>helidon-openapi-ui</artifactId>
-    <name>Helidon OpenAPI</name>
+    <groupId>io.helidon.integrations.openapi-ui</groupId>
+    <artifactId>helidon-integrations-openapi-ui</artifactId>
+    <name>Helidon OpenAPI UI Integration</name>
 
     <description>
         Helidon OpenAPI UI implementation
@@ -49,7 +50,7 @@
         <dependency>
             <groupId>io.smallrye</groupId>
             <artifactId>smallrye-open-api-ui</artifactId>
-            <version>${version.lib.smallrye-openapi}</version>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>io.helidon.webserver</groupId>

diff --git a/...java/io/helidon/openapi/ui/OpenApiUi.java → ...on/integrations/openapi/ui/OpenApiUi.java b/...java/io/helidon/openapi/ui/OpenApiUi.java → ...on/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/ui/OpenApiUiConfigBlueprint.java → .../openapi/ui/OpenApiUiConfigBlueprint.java b/.../openapi/ui/OpenApiUiConfigBlueprint.java → .../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/...helidon/openapi/ui/OpenApiUiProvider.java → ...rations/openapi/ui/OpenApiUiProvider.java b/...helidon/openapi/ui/OpenApiUiProvider.java → ...rations/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/...a/io/helidon/openapi/ui/package-info.java → ...integrations/openapi/ui/package-info.java b/...a/io/helidon/openapi/ui/package-info.java → ...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-ui/src/main/java/module-info.java → ...openapi-ui/src/main/java/module-info.java b/...openapi-ui/src/main/java/module-info.java → ...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/.../resources/helidon-openapi-ui/favicon.ico → .../resources/helidon-openapi-ui/favicon.ico b/.../resources/helidon-openapi-ui/favicon.ico → .../resources/helidon-openapi-ui/favicon.ico
diff --git a/...ain/resources/helidon-openapi-ui/logo.svg → ...ain/resources/helidon-openapi-ui/logo.svg b/...ain/resources/helidon-openapi-ui/logo.svg → ...ain/resources/helidon-openapi-ui/logo.svg
diff --git a/.../io/helidon/openapi/ui/OpenApiUiTest.java → ...ntegrations/openapi/ui/OpenApiUiTest.java b/.../io/helidon/openapi/ui/OpenApiUiTest.java → ...ntegrations/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/...penapi-ui/src/test/resources/greeting.yml → ...penapi-ui/src/test/resources/greeting.yml b/...penapi-ui/src/test/resources/greeting.yml → ...penapi-ui/src/test/resources/greeting.yml
diff --git a/openapi/pom.xml b/openapi/pom.xml
@@ -31,7 +31,6 @@
 
     <modules>
         <module>openapi</module>
-        <module>openapi-ui</module>
     </modules>
 
     <profiles>