bundling result is always an object

Author: hauner

openapi-parser/src/main/java/io/openapiparser/OpenApiBundler.java

@@ -42,7 +42,7 @@ public OpenApiBundler (Context context, DocumentStore documents, Bucket root) {
         this.rootDocumentUri = root.getScope ().getDocumentUri ();
     }
 
-    public Object bundle () {
+    public Map<String, Object> bundle () {
         URI documentUri = root.getScope ().getDocumentUri ();
         Object document = documents.get (documentUri);
 

openapi-parser/src/main/java/io/openapiparser/OpenApiResult.java

@@ -11,6 +11,7 @@
 
 import java.io.IOException;
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * OpenAPI parser result.
@@ -41,11 +42,11 @@ enum Version { V30, V31 }
     <T> T getModel (Class<T> api);
 
     /**
-     * bundle the document. The bundled document has to be parsed again to navigate the OpenAPI model.
+     * Experimental. Bundle the document. The bundled document has to be parsed to navigate its OpenAPI model.
      *
-     * @return the bundled document tree.
+     * @return a raw bundled copy of the OpenAPI document.
      */
-    Object bundle();
+    Map<String, Object> bundle();
 
     /**
      * Experimental. Write the document. This will produce useful results only if the document is a single file

openapi-parser/src/main/java/io/openapiparser/OpenApiResult30.java

@@ -17,6 +17,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 import static io.openapiparser.OpenApiSchemas.OPENAPI_SCHEMA_30;
@@ -52,7 +53,7 @@ public <T> T getModel (Class<T> api) {
     }
 
     @Override
-    public Object bundle () {
+    public Map<String, Object> bundle () {
         return new OpenApiBundler (context, documents, root).bundle ();
     }
 

openapi-parser/src/main/java/io/openapiparser/OpenApiResult31.java

@@ -21,6 +21,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 import static io.openapiparser.OpenApiSchemas.OPENAPI_SCHEMA_31;
@@ -58,7 +59,7 @@ public <T> T getModel (Class<T> api) {
     }
 
     @Override
-    public Object bundle () {
+    public Map<String, Object> bundle () {
         return new OpenApiBundler (context, documents, root).bundle ();
     }
 

openapi-parser/src/test/kotlin/io/openapiparser/BundleSpec.kt

@@ -8,10 +8,15 @@ package io.openapiparser
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.shouldBe
 import io.openapiparser.model.v31.OpenApi
+import io.openapiprocessor.jackson.JacksonJsonWriter
+import io.openapiprocessor.jackson.JacksonYamlWriter
 import io.openapiprocessor.jsonschema.reader.UriReader
 import io.openapiprocessor.jsonschema.schema.DocumentLoader
 import io.openapiprocessor.jsonschema.schema.DocumentStore
 import io.openapiprocessor.snakeyaml.SnakeYamlConverter
+import io.openapiprocessor.snakeyaml.SnakeYamlWriter
+import java.io.FileWriter
+import java.io.StringWriter
 import java.net.URI
 
 class BundleSpec : StringSpec({
@@ -36,4 +41,42 @@ class BundleSpec : StringSpec({
         val api = bundled.getModel(OpenApi::class.java)
         api.components!!.schemas.size shouldBe 2
     }
+
+    "bundle & save example" {
+        // val loader = DocumentLoader(UriReader(), SnakeYamlConverter())
+
+        // parse a multi file OpeAPI document (from resources)
+        val originalDocs = DocumentStore()
+        val originalParser = OpenApiParser(originalDocs, loader)
+        val originalResult = originalParser.parse("/bundle-ref-nested/openapi31.yaml")
+
+        // bundle the OpenAPI, i.e. move $ref content to "components.schemas" and friends if the
+        // ref points to a different file. The original document is not touched.
+        val bundled = originalResult.bundle()
+
+        // parse the bundled document (this creates a reference map for ref lookups) to navigate
+        // its OpenAPI model.
+        val bundledDocs = DocumentStore()
+        val bundledParser = OpenApiParser(bundledDocs, loader)
+        val bundledResult = bundledParser.parse(URI.create("/bundle-ref-nested/openapi31.yaml"), bundled)
+
+        // We could use the same document store, but it would override the original (root) document
+        // if we use the same id (in this case file name). We can use a different id to avoid that.
+        //val bundledParser = OpenApiParser(bundledDocs, loader)
+        //val bundledResult = bundledParser.parse(URI.create("/bundled/openapi.yaml"), bundled)
+
+        val api = bundledResult.getModel(OpenApi::class.java)
+        val summary = api.info.summary
+
+        // write the bundled OpenAPI document. Use the alternative constructor to configure the
+        // jackson, snake yaml specific formatting.
+        val out = StringWriter()
+//        val out = FileWriter("bundled.yaml")
+        val writer = JacksonYamlWriter(out)
+        //val writer = SnakeYamlWriter(out)
+        //val writer = JacksonJsonWriter(out)
+        bundledResult.write(writer)
+
+        println(out.toString())
+    }
 })