description : String

description

String

An explanation about the purpose of the instance described by the schema.

Value	This keyword must be set to a string Hint: Use the `jsonschema metaschema` and `jsonschema lint` commands to catch keywords set to invalid values
Kind	Annotation
Applies To	Any
Base Dialect	Draft 3
Changed In	None
Introduced In	Draft 1
Vocabulary	Core
Specification	https://json-schema.org/draft-03/draft-zyp-json-schema-03.pdf#5.22
Metaschema	http://json-schema.org/draft-03/schema#
Official Tests	None
Default	None
Annotation	None
Affected By	None
Affects	None
Also See	title (Vocabulary: Core) default (Vocabulary: Core)

Want to learn even more JSON Schema?

The authors of this website wrote a book (Unifying Business, Data, and Code) that covers, for the first time in print, topics like:

Writing your own JSON Schema vocabularies
Understanding JSON Schema annotations
Hosting your own JSON Schema registries

More importantly, our book teaches you a methodology for effective data management that will transform how you think about data.

Read it online on O'Reilly, or buy it from Amazon and eBooks.com.

Feeling stuck? Need expert help?

Sourcemeta, the company behind this site, offers world-class consultancy services in the JSON Schema ecosystem. We have extensive experience designing large-scale JSON Schema ontologies and data models, and OpenAPI Governance initiatives across industries. Reach out to discuss more!

Hint: You can also get free community help in the JSON Schema Slack and JSON Schema GitHub Discussions forum.