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
Kind	Annotation
Applies To	Any
Base Dialect	2019-09
Changed In	None
Introduced In	Draft 1
Vocabulary	Meta Data
Specification	https://json-schema.org/draft/2019-09/draft-handrews-json-schema-validation-02#rfc.section.9.1
Metaschema	https://json-schema.org/draft/2019-09/meta/meta-data
Official Tests	None
Default	None
Annotation	String The description set by this keyword
Affected By	None
Affects	None
Also See	title (Vocabulary: Meta-Data) examples (Vocabulary: Meta-Data) default (Vocabulary: Meta-Data) readOnly (Vocabulary: Meta-Data) writeOnly (Vocabulary: Meta-Data) deprecated (Vocabulary: Meta-Data)

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.

Need help? Have questions?

Learning JSON Schema is often confusing, we all went through that. But don't worry, we are here to help! You can start a thread on GitHub Discussions, chat with us on Slack, or come talk to us at our live Office Hours. We are friendly! :)

Hint: Your question might have been already answered before in GitHub Discussions. Might be worth double-checking before submitting a new one.