Meta Data Vocabulary Official Included By Default

A vocabulary to defines general-purpose annotation keywords that provide commonly used information for documentation and user interface display purposes.

Dialect 2020-12
URI https://json-schema.org/draft/2020-12/vocab/meta-data
Specification https://json-schema.org/draft/2020-12/json-schema-validation.html#section-9
Authors
Metaschema https://json-schema.org/draft/2020-12/meta/meta-data
Also see

Using this vocabulary

To make use of this vocabulary, modify your metaschema to declare the use of this vocabulary using the $vocabulary keyword and evaluate its metaschema.

If the vocabulary must be present for an implementation to proceed:

{
  ...
  "$vocabulary": {
    ...
    "https://json-schema.org/draft/2020-12/vocab/meta-data": true
  },
  "allOf": [
    { "$ref": "https://json-schema.org/draft/2020-12/meta/meta-data" }
  ]
}

If it is optional for implementations to understand this vocabulary to proceed:

{
  ...
  "$vocabulary": {
    ...
    "https://json-schema.org/draft/2020-12/vocab/meta-data": false
  },
  "allOf": [
    { "$ref": "https://json-schema.org/draft/2020-12/meta/meta-data" }
  ]
}

Keywords

Keyword Kind Instance Summary
title Annotation Any A preferably short description about the purpose of the instance described by the schema.
description Annotation Any An explanation about the purpose of the instance described by the schema.
default Annotation Any This keyword can be used to supply a default JSON value associated with a particular schema.
deprecated Annotation Any This keyword indicates that applications should refrain from using the declared property.
examples Annotation Any This keyword is used to provide sample JSON values associated with a particular schema, for the purpose of illustrating usage.
readOnly Annotation Any This keyword indicates that the value of the instance is managed exclusively by the owning authority, and attempts by an application to modify the value of this property are expected to be ignored or rejected by that owning authority.
writeOnly Annotation Any This keyword indicates that the value is never present when the instance is retrieved from the owning authority.