#/component/*/key does not allow '/' or '~1'

Author: hauner

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

@@ -169,6 +169,8 @@ private boolean isExternalDocument (URI documentUri) {
         if (refName.isEmpty()) {
             refName = documentUri.getPath();
         }
+        refName = toComponentKey(refName);
+
         RawValue refValue = getRefValue (documentBucket, refPointer);
         Bucket refBucket = getRefBucket (refPointer, refValue);
 
@@ -339,7 +341,12 @@ private Bucket createBucket(Scope scope, @Nullable Object source, JsonPointer lo
     }
 
     private String createRefPointer (String type, String refName) {
-        return String.format ("#/components/%s/%s", type, JsonPointerSupport.encode(refName));
+        return String.format ("#/components/%s/%s", type, refName);
+    }
+
+    private String toComponentKey(String refName) {
+        // /component/*/key pattern does not allow '/'
+        return refName.replace("/", "--");
     }
 
     private void walkSchema (Scope currentScope, Object value, JsonPointer location) {

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

@@ -299,9 +299,9 @@ class OpenApiBundlerSpec : FreeSpec({
 
         val ref = getObject(bundled, "/paths/~1foo")
         ref.size shouldBe 1
-        ref[$$"$ref"].shouldBe("#/components/pathItems/~1bundle-ref-path-item~1foo.api.yaml")
+        ref[$$"$ref"].shouldBe("#/components/pathItems/--bundle-ref-path-item--foo.api.yaml")
 
-        val component = getObject(bundled, "/components/pathItems/~1bundle-ref-path-item~1foo.api.yaml")
+        val component = getObject(bundled, "/components/pathItems/--bundle-ref-path-item--foo.api.yaml")
         component.shouldNotBeNull()
     }
 
@@ -347,12 +347,12 @@ class OpenApiBundlerSpec : FreeSpec({
 
         val ref = getObject(bundled, "/paths/~1foo")
         ref.size shouldBe 1
-        ref[$$"$ref"].shouldBe("#/components/pathItems/~1bundle-ref-nested~1foo.api.yaml")
+        ref[$$"$ref"].shouldBe("#/components/pathItems/--bundle-ref-nested--foo.api.yaml")
 
-        val component = getObject(bundled, "/components/pathItems/~1bundle-ref-nested~1foo.api.yaml")
+        val component = getObject(bundled, "/components/pathItems/--bundle-ref-nested--foo.api.yaml")
         component.shouldNotBeNull()
 
-        val barRef = getObject(bundled, "/components/pathItems/~1bundle-ref-nested~1foo.api.yaml/get/responses/200/content/application~1json/schema")
+        val barRef = getObject(bundled, "/components/pathItems/--bundle-ref-nested--foo.api.yaml/get/responses/200/content/application~1json/schema")
         barRef[$$"$ref"].shouldBe("#/components/schemas/Bar")
         val barComponent = bundled.getRawValue(from("/components/schemas/Bar"))
         barComponent.shouldNotBeNull()
@@ -397,6 +397,5 @@ class OpenApiBundlerSpec : FreeSpec({
         getObject(bundled, "/components/mediaTypes/Bar").shouldNotBeNull()
     }
 
-    // should not modify in-document refs
-    // conflict if name of bundled component is already used
+   // conflict if name of bundled component is already used
 })