DocsOverview
What is JSON Schema?Getting Started
Creating your first schemaExamples
Miscellaneous examplesModelling a file systemOther examplesReference
JSON Schema GlossaryLearn JSON SchemaUnderstanding JSON SchemaConventions used in this bookWhat is a schema?
The basics
Hello, World!The type keywordDeclaring a JSON SchemaDeclaring a unique identifierJSON Schema Reference
Type-specific keywordsstringregular expressionsnumeric typesobjectarraybooleannullGeneric keywordsMedia: string-encoding non-JSON dataSchema CompositionApplying Subschemas ConditionallyDeclaring a DialectJSON Schema Reference
enumerated valuesannotationsconstant valuescommentsStructuring a complex schema
Schema IdentificationBase URI$ref$defsRecursionExtending Recursive SchemasBundlingSpecification
OverviewSpecificationComments¶
New in draft 7The $comment keyword is strictly intended for adding comments to a
schema. Its value must always be a string. Unlike the annotations
title, description, and examples, JSON schema implementations
aren't allowed to attach any meaning or behavior to it whatsoever, and
may even strip them at any time. Therefore, they are useful for leaving
notes to future editors of a JSON schema, but should not be used to
communicate to users of the schema.
