Relative references using `$def` are being URL encoded

[drpump]

We are using a $defs section in our schemas. Schemas within the $defs section are referenced via local file references, and these schemas can themselves have cross references to other files. The ref parser is correctly injecting a$defs cross-reference but replacing the $defs with %24defs (i.e. it is applying URL encoding). I don’t think this behaviour is correct: while $ is a reserved character in the URIs RFC, it is designated as a sub-delimiter

For example in the parent file:

{
  “properties”: {
     “foo”: “string”
  },
  ”$defs”: {
    “myschema”: {
       “$ref”: “./myschema.json”
    },
    ”otherschema”: {
       “$ref”: “./otherschema.json”
    }
  }
}

And the myschema.json file:

{
      “allOf”: [
        { “$ref”: “./otherschema.json” },
        { 
           “properties”: {
              “someProp”: “string”
           }
        }
      ]
}

Flattening results in:

{
  “properties”: {
     “foo”: “string”
  },
  ”$defs”: {
    “myschema”: {
      “allOf”: [
        { “$ref”: “#/%24defs/otherschema.” },
        { 
           “properties”: {
              “someProp”: “string”
            }
        }
      ]  
    },
    ”otherschema”: {
         “properties”: {
            “otherProp”: “string”
         }
     }
  }
}

[mortal-dog]

There was the same issue 262 which was closed in March. However, This issue still exists in the latest version

[drpump]

Note that this is occurring in v11.6.4. I haven’t updated to 11.7 yet.

I encountered this issue with v11.6.4. Just did a quick test with 11.7 and it makes no difference.

[simontaurus]

It also seems like the $defs keyword of a schema is not handled like the previous keyword definitions, but since this is not enforced and the convention changed over time makes it really tricky.
See also: https://json-schema.org/draft/2019-09/release-notes#semi-incompatible-changes

Code dealing with "definitions"
https://github.com/search?q=repo%3AAPIDevTools%2Fjson-schema-ref-parser+definitions&type=code

Especially:

json-schema-ref-parser/lib/bundle.ts

Line 77 in 27abe40

// Most people will expect references to be bundled into the the "definitions" property,

No matching code for "defs"
https://github.com/search?q=repo%3AAPIDevTools%2Fjson-schema-ref-parser+defs&type=code

However, not really related to the encoding of $ in json-pointers.

[KurtGokhan]

Is there a plan to fix this? Is there a workaround?

Edit: I guess it works if I replace all $defs with definitions, and wrap all $ref in allOf because of the issue #370

[jonluca]

Not currently, although we are open to PRs

[ThomasJejkal]

This was obviously not be fixed by #383, we still face the described problem. However, this fork seems to address this issue with a fix. Would be great if it finds its way into the next version.

[jonluca]

This has been fixed. The $ character in $defs is no longer URL-encoded as %24 in JSON pointer references during bundling. The Pointer.join method uses RFC 6901 encoding only (~0 and ~1), explicitly avoiding encodeURIComponent. Regression tests are in test/specs/bundle-defs-encoding/bundle-defs-encoding.spec.ts.