Skip to content

References docs example fix #178

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

Merged
p1c2u merged 1 commit into from
Apr 8, 2024
Merged

References docs example fix #178

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
14 changes: 11 additions & 3 deletions docs/references.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ You can resolve JSON Schema references by passing registry
],
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
"$ref": "urn:name-schema"
},
"age": {
"$ref": "#/components/schemas/Age"
"$ref": "urn:age-schema"
},
"birth-date": {
"$ref": "#/components/schemas/BirthDate"
"$ref": "urn:birth-date-schema"
}
},
"additionalProperties": False,
Expand Down Expand Up @@ -54,6 +54,14 @@ You can resolve JSON Schema references by passing registry
],
)

# If no exception is raised by validate(), the instance is valid.
validate({"name": "John", "age": 23}, schema, registry=registry)

# raises error
validate({"birth-date": "yesterday", "age": -1}, schema, registry=registry)

Traceback (most recent call last):
...
ValidationError: 'name' is a required property

For more information about resolving references see `JSON (Schema) Referencing <https://python-jsonschema.readthedocs.io/en/latest/referencing/>`__