[4.x] Allow SE users work with OpenApiFeature instead of SeOpenApiFeature (helidon-io#7103)

tjquinno · web-flow · commit 52d3572d471d · 2023-06-29T11:14:35.000-05:00
diff --git a/examples/quickstarts/helidon-quickstart-se/pom.xml b/examples/quickstarts/helidon-quickstart-se/pom.xml
@@ -58,8 +58,8 @@
             <artifactId>helidon-metrics</artifactId>
         </dependency>
         <dependency>
-            <groupId>io.helidon.nima.openapi</groupId>
-            <artifactId>helidon-nima-openapi</artifactId>
+            <groupId>io.helidon.openapi</groupId>
+            <artifactId>helidon-openapi</artifactId>
         </dependency>
         <dependency>
             <groupId>io.helidon.config</groupId>
diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java
@@ -18,9 +18,9 @@
 
 import io.helidon.logging.common.LogConfig;
 import io.helidon.nima.observe.ObserveFeature;
-import io.helidon.nima.openapi.SeOpenApiFeature;
 import io.helidon.nima.webserver.WebServer;
 import io.helidon.nima.webserver.http.HttpRouting;
+import io.helidon.openapi.OpenApiFeature;
 
 /**
  * The application main class.
@@ -54,7 +54,7 @@ public static void main(String[] args) {
      * Updates HTTP Routing and registers observe providers.
      */
     static void routing(HttpRouting.Builder routing) {
-        SeOpenApiFeature openApi = SeOpenApiFeature.builder().build();
+        OpenApiFeature openApi = OpenApiFeature.builder().build();
         GreetService greetService = new GreetService();
         routing.addFeature(openApi)
                 .register("/greet", greetService)
diff --git a/microprofile/openapi/src/main/java/io/helidon/microprofile/openapi/MpOpenApiFeature.java b/microprofile/openapi/src/main/java/io/helidon/microprofile/openapi/MpOpenApiFeature.java
@@ -58,7 +58,7 @@ public class MpOpenApiFeature extends OpenApiFeature {
      *
      * @return new builder
      */
-    static MPOpenAPIBuilder builder() {
+    public static MPOpenAPIBuilder builder() {
         return new MPOpenAPIBuilder();
     }
 
diff --git a/microprofile/openapi/src/test/java/io/helidon/microprofile/openapi/test/MyModelReader.java b/microprofile/openapi/src/test/java/io/helidon/microprofile/openapi/test/MyModelReader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2023 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.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.helidon.nima.openapi.test;
+package io.helidon.microprofile.openapi.test;
 
 import org.eclipse.microprofile.openapi.OASFactory;
 import org.eclipse.microprofile.openapi.OASModelReader;
diff --git a/microprofile/openapi/src/test/java/io/helidon/microprofile/openapi/test/MySimpleFilter.java b/microprofile/openapi/src/test/java/io/helidon/microprofile/openapi/test/MySimpleFilter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2023 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.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.helidon.nima.openapi.test;
+package io.helidon.microprofile.openapi.test;
 
 import java.util.Map;
 
diff --git a/microprofile/openapi/src/test/resources/openapi-greeting.yml b/microprofile/openapi/src/test/resources/openapi-greeting.yml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/openapi-time-server.yml b/microprofile/openapi/src/test/resources/openapi-time-server.yml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/petstore.json b/microprofile/openapi/src/test/resources/petstore.json
diff --git a/microprofile/openapi/src/test/resources/petstore.yaml b/microprofile/openapi/src/test/resources/petstore.yaml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2020, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/serverCORSRestricted.yaml b/microprofile/openapi/src/test/resources/serverCORSRestricted.yaml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2020, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/serverConfig.yml b/microprofile/openapi/src/test/resources/serverConfig.yml
@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/serverNoCORS.properties b/microprofile/openapi/src/test/resources/serverNoCORS.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2020, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/serverTest.properties b/microprofile/openapi/src/test/resources/serverTest.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2023 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.
@@ -13,8 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # 
-openapi.model.reader: io.helidon.nima.openapi.test.MyModelReader
-openapi.filter: io.helidon.nima.openapi.test.MySimpleFilter
+openapi.model.reader: io.helidon.microprofile.openapi.test.MyModelReader
+openapi.filter: io.helidon.openapi.microprofile.MySimpleFilter
 openapi.servers: s1,s2
 openapi.servers.path.path1: p1s1,p1s2
 openapi.servers.path.path2: p2s1,p2s2
diff --git a/microprofile/openapi/src/test/resources/simple.properties b/microprofile/openapi/src/test/resources/simple.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2019, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2023 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.
@@ -13,8 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # 
-openapi.model.reader: io.helidon.nima.openapi.test.MyModelReader
-openapi.filter: io.helidon.nima.openapi.test.MySimpleFilter
+openapi.model.reader: io.helidon.microprofile.openapi.test.MyModelReader
+openapi.filter: io.helidon.microprofile.openapi.test.MySimpleFilter
 openapi.servers: s1,s2
 openapi.servers.path.path1: p1s1,p1s2
 openapi.servers.path.path2: p2s1,p2s2
diff --git a/microprofile/openapi/src/test/resources/withBooleanAddlProps.yml b/microprofile/openapi/src/test/resources/withBooleanAddlProps.yml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2021, 2023 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.
diff --git a/microprofile/openapi/src/test/resources/withSchemaAddlProps.yml b/microprofile/openapi/src/test/resources/withSchemaAddlProps.yml
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2021, 2023 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.
diff --git a/nima/pom.xml b/nima/pom.xml
@@ -49,7 +49,6 @@
         <module>fault-tolerance</module>
         <module>testing</module>
         <module>service-common</module>
-        <module>openapi</module>
         <module>graphql</module>
     </modules>
 
diff --git a/openapi/src/main/java/io/helidon/openapi/OpenApiFeature.java b/openapi/src/main/java/io/helidon/openapi/OpenApiFeature.java
@@ -68,6 +68,15 @@ public abstract class OpenApiFeature extends HelidonFeatureSupport {
      */
     public static final String DEFAULT_CONTEXT = "/openapi";
 
+    /**
+     * Returns a new builder for preparing an SE variant of {@code OpenApiFeature}.
+     *
+     * @return new builder
+     */
+    public static Builder<?, ?> builder() {
+        return new SeOpenApiFeature.Builder();
+    }
+
     /**
      * URL query parameter for specifying the requested format when retrieving the OpenAPI document.
      */
diff --git a/openapi/src/main/java/io/helidon/openapi/SeOpenApiFeature.java b/openapi/src/main/java/io/helidon/openapi/SeOpenApiFeature.java
@@ -13,26 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.helidon.nima.openapi;
-
-import io.helidon.openapi.OpenApiFeature;
+package io.helidon.openapi;
 
 /**
  * SE implementation of {@link OpenApiFeature}.
  */
-public class SeOpenApiFeature extends OpenApiFeature {
+class SeOpenApiFeature extends OpenApiFeature {
 
     private static final System.Logger LOGGER = System.getLogger(SeOpenApiFeature.class.getName());
 
-    /**
-     * Create a new builder for the feature.
-     *
-     * @return the new builder
-     */
-    public static Builder builder() {
-        return new Builder();
-    }
-
     /**
      * Creates a new instance.
      *
diff --git a/openapi/src/test/java/io/helidon/openapi/StaticFileOnlyOpenApiFeatureImpl.java b/openapi/src/test/java/io/helidon/openapi/StaticFileOnlyOpenApiFeatureImpl.java
@@ -15,24 +15,22 @@
  */
 package io.helidon.openapi;
 
-import java.io.StringReader;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
 
 import jakarta.json.Json;
 import jakarta.json.JsonBuilderFactory;
 import jakarta.json.JsonObject;
-import jakarta.json.stream.JsonParser;
 import org.yaml.snakeyaml.Yaml;
 
-public class StaticFileOnlyOpenApiFeatureImpl extends OpenApiFeature {
+class StaticFileOnlyOpenApiFeatureImpl extends OpenApiFeature {
 
     private static final System.Logger LOGGER = System.getLogger(StaticFileOnlyOpenApiFeatureImpl.class.getName());
 
     private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Map.of());
 
-    static Builder builder() {
+    public static Builder builder() {
         return new Builder();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public class MpOpenApiFeature extends OpenApiFeature {`
`58`	`58`	`*`
`59`	`59`	`* @return new builder`
`60`	`60`	`*/`
`61`		`- static MPOpenAPIBuilder builder() {`
	`61`	`+ public static MPOpenAPIBuilder builder() {`
`62`	`62`	`return new MPOpenAPIBuilder();`
`63`	`63`	`}`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#`
`2`		`-# Copyright (c) 2019, 2022 Oracle and/or its affiliates.`
	`2`	`+# Copyright (c) 2019, 2023 Oracle and/or its affiliates.`
`3`	`3`	`#`
`4`	`4`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#`
`2`		`-# Copyright (c) 2020, 2022 Oracle and/or its affiliates.`
	`2`	`+# Copyright (c) 2020, 2023 Oracle and/or its affiliates.`
`3`	`3`	`#`
`4`	`4`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`# you may not use this file except in compliance with the License.`