Configuration JSON schema

[laudibert]

Feature asked in #73.

Not sure if the schema should have "additionalProperties": false to help users realize when a field name was mistyped or if it's too constraining for when the schema might not be up to date with the code.

[laudibert]

Also, I automatically filled the "description" of each field with whatever was on the README.md but I realized only afterwards that it might be a pain to maintain these pieces of documentation in both the README.md and the schema. Ideally though, the schema should have them though I guess.

[dsternlicht]

• will be

[dsternlicht]

Feature asked in #73.

Not sure if the schema should have "additionalProperties": false to help users realize when a field name was mistyped or if it's too constraining for when the schema might not be up to date with the code.

I think it's definitely should be part of the schema.

[dsternlicht]

Also, I automatically filled the "description" of each field with whatever was on the README.md but I realized only afterwards that it might be a pain to maintain these pieces of documentation in both the README.md and the schema. Ideally though, the schema should have them though I guess.

You did right. It's a bit pain, but very important.

[dsternlicht]

@laudibert That's an awesome PR for an extremely important feature! Kudos!
Let me know if it's ready to be merged.

[laudibert]

@dsternlicht, it should be ok now. The only problem that I encountered without any solution is that the "additionalProperties": false does not work with the keyword "allOf"that I used to manage inheritance for methods schema definitions. Therefore it is not set to false for the methods.

[dsternlicht]

I'm sorry to ask, but what's the meaning of "additionalProperties": false? It's not to allow other properties than the one you defined in the schema?

What's the "allOff" keyword?

[laudibert]

I'm sorry to ask, but what's the meaning of "additionalProperties": false? It's not to allow other properties than the one you defined in the schema?

Yes but it works only one level at a time. Therefore it has to be defines for any object throughout the configuration. Not just at the root.

What's the "allOff" keyword?

It allows to combine schemas for one schema definition. See here for a good explanation. In the RESTool case, it allowed me to define the common properties of all methods in one place and then combine it with the specific of each method.

[dsternlicht]

Got it. Does schemas support inheritance from another file as well?

[laudibert]

Yes, definitions can come from other files all loaded at the start of the app. I did not choose to do this though as I thought it might not be practical for people that are asking for the full schema.

I could change it though.

[dsternlicht]

@laudibert no need, just ask for my own general knowledge :)