From 24530018921450cf07100db7e4347cb178f11e91 Mon Sep 17 00:00:00 2001
From: p1c2u <maciag.artur@gmail.com>
Date: Tue, 19 Mar 2024 20:07:59 +0000
Subject: [PATCH] References docs example fix

---
 docs/references.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/docs/references.rst b/docs/references.rst
index 5d5b0d3..c6bc1f8 100644
--- a/docs/references.rst
+++ b/docs/references.rst
@@ -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,
@@ -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/>`__