description : String
description
StringAn 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 7 |
| Changed In | None |
| Introduced In | Draft 1 |
| Vocabulary | Validation |
| Specification | https://json-schema.org/draft-07/draft-handrews-json-schema-validation-01#rfc.section.10.1 |
| Metaschema | http://json-schema.org/draft-07/schema# |
| Official Tests | None |
| Default | None |
| Annotation | None |
| Affected By | None |
| Affects | None |
| Also See |
|
The description keyword is a
placeholder for a longer human-readable string summary of what a schema or any
of its subschemas are about. This keyword is merely descriptive and does not
affect validation.
Best Practice
We heavily recommend to declare this keyword at the top level of every schema,
as a human-readable longer description of what the schema is about.
Note that this keyword is meant to be to be used in conjunction with the
title keyword. The idea is to
augment the short summary with a longer description, and not to avoid the
concise summary altogether.
Common Pitfall
Tooling makers must be careful when statically traversing schemas in search of occurrences of this keyword. It is possible for schemas to make use of this keyword behind conditional operators, references, or any other type of keyword that makes it hard or even impossible to correctly locate these values in all cases.
Examples
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Even Number",
"description": "This schema describes an even number",
"type": "number",
"multipleOf": 2
}107{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Number",
"type": "number",
"if": { "multipleOf": 2 },
"then": { "description": "This is an even number" },
"else": { "description": "This is an odd number" }
}107"Hello World"