Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving 'id' schema documentation #350

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Improving 'id' schema documentation #350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/tutorial/schemas.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,10 @@ Schema format
This dictionary describes the possible keys and types in the JSON object being
validated, using the following reserved keys:

- ``id`` (or ``$id``): an URI identifing this schema. Change the last part of
the example URL to use your app's name.
- ``id`` (or ``$id``): an URI identifing this schema. This URI is used to
differentiate between different schema packages and should ideally remain
consistent within a specific schema package. Change the last part of the
example URL to use your app’s name.
- ``$schema``: an URI describing the validator to use, you can leave that one
as it is. It is only present at the root of the dictionary.
- ``description``: a fulltext description of the key.
Expand Down