Skip to content

Commit ac461ca

Browse files
Improving 'id' schema documentation
1 parent 54a770c commit ac461ca

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/tutorial/schemas.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ Schema format
5757
This dictionary describes the possible keys and types in the JSON object being
5858
validated, using the following reserved keys:
5959

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

0 commit comments

Comments
 (0)