Skip to content

Commit

Permalink
Improving 'id' schema documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Vidit Maheshwari <[email protected]>
  • Loading branch information
vidit-maheshwari committed Mar 31, 2024
1 parent 54a770c commit 941ebb8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/tutorial/schemas.rst
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

0 comments on commit 941ebb8

Please sign in to comment.