-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for $comment in property definitions #459
Comments
What would be the target audience of comments? Maybe we can just put them to |
It would be for comments that are relevant to property definition "developers" rather than "end users". Another difference is that you can put it on any level in a nested definition to comment e.g. the motivation behind setting a limit like "maximum" to something. I stumbled on the desire to insert a comment when I realized I wanted somewhere to explain why On the other hand - writing this up makes me realize that we might want to specifically have a way to strip certain comments when we inline '$ref' references, since the comment I mention above would be nonsensical after inlining the definition. |
OK, this makes sense. |
Closed by #457 (I think) or a related PR |
JSON schema has in draft 7 added support to put comments in schemas via $comment: http://json-schema.org/understanding-json-schema/reference/generic.html#comments
When working on our property definitions in #445 I independently realized it would be useful to insert comments in the property definitions. So we should add this to the subset of JSON Schema that we allow.
The text was updated successfully, but these errors were encountered: