Annotating JSON Schemas

JSON Schema includes a few keywords, that aren't strictly used for validation, but are used to describe parts of a schema. None of these "annotation" keywords are required, but they are encouraged for good practice, and can make your schema "self-documenting".

Title and Description

The title and description keywords are used to provide a human-readable title and description of the schema.

These keywords are not used for validation, but can be used by tools and software to provide more information about the schema.

Here's an example of a schema with a title and description:

1{
2  "title": "Person",
3  "description": "A person in the system",
4  "type": "object",
5  "properties": {
6    "name": {"type": "string"},
7    "age": {"type": "integer"}
8  }
9}

Task

Add title and description to the schema given to you in the side editor. You can use any title and description you like.

Loading...
Output
Please click the button or use
Shift+Enter
to view the output