Liquid XML Studio 2019
Comment
JSON Schema Editor > Properties > Comment
Draft 04 Draft 06 Draft 07

A comment for those using and maintaining the schemas.

This keyword is reserved for comments from schema authors to readers or maintainers of the schema.

The value of this keyword MUST be a string.

Implementations MUST NOT present this string to end users. Tools for editing schemas SHOULD support displaying and editing this keyword. The value of this keyword MAY be used in debug or error output which is intended for developers making use of schemas. Schema vocabularies SHOULD allow "$comment" within any object containing vocabulary keywords. Implementations MAY assume "$comment" is allowed unless the vocabulary specifically forbids it. Vocabularies MUST NOT specify any effect of "$comment" beyond what is described in this specification. Tools that translate other media types or programming languages to and from application/schema+json MAY choose to convert that media type or programming language's native comments to or from "$comment" values. The behavior of such translation when both native comments and "$comment" properties are present is implementation-dependent. Implementations SHOULD treat "$comment" identically to an unknown extension keyword. They MAY strip "$comment" values at any point during processing. In particular, this allows for shortening schemas when the size of deployed schemas is a concern. Implementations MUST NOT take any other action based on the presence, absence, or contents of "$comment" properties.

 

Example
Copy Code
{
    "$comment": "TODO: This section needs work, missing description of widget",
    "type": "object"
}

See Also