sourcemeta/learnjsonschema.com

Document `description`

Closed this issue · 2 comments

Document `description`

We should:

  • Highlight that this keyword doesn't affect validation at all. Its just informative
  • Simple example of a schema without subschemas that declares it at the top level
  • Slightly more complicated example of producing this annotation in conjunction with logical operators. For example, if, then, else, where the annotation is different, explaining how annotations can often not be determined at runtime
  • Another more complicated example of a schema producing the same annotation for the same instance location more than once. For example, a schema declares the annotation, but references another schema that also declares the same annotation

This task was addressed in #158.