$ref in generated JSON

[azzazzel]

Hello folks,

I have a simple model like this

const Info(String name, String[] lines);

and an endpoint

@Get("infos")
Info[] getInfos() {
   ...  
}

The endpoint returns an array containing few entries, each with a name and empty lines, and when I access the endpoint, I get

[{
    "name": "name 1",
    "lines": []
}, {
    "name": "name 2",
    "lines": {
        "$ref": "/0/lines"
    }
}, {
    "name": "name 3",
    "lines": {
        "$ref": "/0/lines"
    }
}]

Now, I know that, strictly speaking, this is a correct JSON, but it's a pain to resolve the $ref on the client side. And in this particular case, it's not really an optimization, is it? Is there any way to disable the usage of $ref? I'm new to the language and the platform and I couldn't find a way in the limited time I have to explore it.

[cpurdy]

Yes, it's easy to get rid of the $ref's ... see Schema.x in lib_json. The constructor has a bunch of options, including enablePointers, which is what causes the $ref's to be added.

@ggleyzer How would he change the default options on the Schema that is used in his web app?

[ggleyzer]

The way it's done today, you would have to create a new schema instead of using the DEFAULT, for example:

  Schema mySchema = new Schema(
        enableReflection = True,
        enableMetadata   = True,
        enablePointers   = False,
        randomAccess     = True);

[cpurdy]

And how does the web-app pick up the schema? Does it reference DEFAULT directly, for example? How would we override it on an app by app basis?

[ggleyzer]

Since MyApp is WebApp,

MyApp.registry.jsonSchema = mySchema;

[azzazzel]

Nice! Thank you!

It didn't work at first but after some digging, I figured it's actually called registry_ (with an underscore at the end).

As I'm playing around with the platform, I added

        this.registry_.jsonSchema = new Schema(
                enableReflection = True,
                enableMetadata   = True,
                enablePointers   = False,
                randomAccess     = True);

at the end of the configure method of the platformUI.x (here).
I'm not sure if that's the right way to do it but it worked ;)

[azzazzel]

Just to clarify, my intention wasn't to change the settings for all applications but to change the settings for the platformUI itself. Following our discussion at JCrete, I'm playing around with a new UI for it, and I needed to add some endpoints to it.

Are you saying that all deployed applications inherit the registry and thus, my change will be applied to all? I'm sorry if my questions don't make sense. I'm still wrapping my head around this.

[cpurdy]

Your question makes perfect sense! Each application would have its own "registry", specific to that application.

[ggleyzer]

Oh.. you're right, it will not affect any other apps. I misunderstood your intent.

[cpurdy]

@azzazzel Any chance we can do a zoom call with you to see the approach you're taking and get feedback from you on what we can be improving?

[azzazzel]

Sure thing, @cpurdy!
Actually, that was kind of my plan from the start - learn by making an MVPoC and then show it to you to see what you think.
Let's plan something for next week if that work for you. Hopefully, by that time, I'll have something to show.