Support relative $ref references about jsonform

[igorpan]

Is there any progress on internal references? I just downloaded JsonForm for the first time and instantly encountered this when I tried to use my schema. And I think I can't avoid using $ref because I need to allow infinite object nesting (just a relevant chunk of my schema):

"animation": {
        "type": "object",

        "properties": {
            "properties": {
                "type": "object"
            },

            "duration": {
                "type": "integer"
            },

            "stepper": {
                "type": "string"
            },

            "then": {
                "$ref": "#/definitions/animation"
            }
        }
    }

Is there any way I can work around this or I have to find another solution?

[sciurius]

Please reopen.

[schaman]

The simplest workaround:

function resolveRefs(obj, defs)
{
  Object.keys(obj).forEach(function(prop, index, array){
    var def = obj[prop];

    if (def.$ref) {
      var ref = def.$ref.replace(/^#\/definitions\//, '');
      obj[prop] = defs[ref];
    } else if (typeof def === 'object') {
      resolveRefs(def, defs);
    }
  })
}

resolveRefs(schema, schema.definitions);

[sdetweil]

is there a definition of what the ref link should look like? I have some time

[jlopezr]

I have a schema defining a comments history and I got the same issue. Any progress?

[ulion]

Thx @schaman, I just implemented simple inline resolve according to your code in above mentioned commit in my dev branch.
And @igorpan now we have a working workaround version for your schema in my playground: http://ulion.github.io/jsonform/playground/?example=schema-inline-ref

[englercj]

Bump! Looking to use this in a new project, but we have a complex json schema accross many files using many $refs.

It would be great to add each schema object to jsonform then generate a form. For example, we have a common definitions file, and multiple schemas that ref eachother.

[Bluesoniq]

resolveRefs(data.schema, data.schema.definitions);
$('form').jsonForm(data);

Uncaught RangeError: Maximum call stack size exceeded
at String.replace ()
at escapeSelector (jsonform.js:101)
at formTree.buildFromLayout (jsonform.js:3108)
at formTree. (jsonform.js:3196)
at underscore.js:73

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[sciurius]

https://json-schema.org/understanding-json-schema/structuring.html

[sdetweil]

@sciurius thx.. is there a place to talk about this outside of this issue?

[sdetweil]

i know its been 7 years,
so this is a specific subset of the jsonform.org spec which allows all kinds of target refs (not just 'definitions')

I think this needs a hash of already resolved links, to prevent recursion, and probably have to make a resolved copy of the target
so you don't trapse into it every time. oops. resolved..

it is ok to stomp on the source definition?

function resolveRefs(obj, defs)
{
  Object.keys(obj).forEach(function(prop, index, array){
    var def = obj[prop];

    if (def.$ref) {
      var ref = def.$ref.replace(/^#\/definitions\//, '');
      obj[prop] = defs[ref];
    } else if (typeof def === 'object') {
      resolveRefs(def, defs);
    }
  })
}

and the uri resolution decoder.. , ~0, ~1 and %nn

external would never work for my use (unless it was a full URI), as the lib doesn't know where THIS doc came from as its loaded directly via javascript.

[tchapi]

External refs (/schemas) should not be in the scope of this feature, you're right.

For internal refs (/definitions), we should process the definitions property first, and then replace them where needed. I would implement this as a pre-processor, I think, and directly modify the JSON object that is fed to JSONForm

[sdetweil]

in general I agree. the example is recursive, as it uses the definition IN the definition. not sure how to update the object with this.

[tchapi]

In the spec, the loop is ok for the validation process, but in our case where we need to construct the form, it's slightly more complicated. I think we might need to stop at the first level. Maybe put a parameter for this, like levels: <integer> for instance ? Or a "global" parameter in the JSONForm object that could be overriden ? I'm not sure...

[sdetweil]

I was thinking stop at the 1st level.
the question is what do you put in the schema for any secondary?, or is that an error? then the example would fail.

thus rule : no refs in /definitions

[tchapi]

And no { "$ref": "#" } too.

I think that we should be able to display an error stating the problem

[sdetweil]

just fyi, I got jammed on another project suddenly.. so my 'free' time evaporated

[tchapi]

That's alright, don't worry :)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.