You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.rst
+37
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,43 @@ An implementation-agnostic implementation of JSON reference resolution.
2
2
3
3
In other words, a way for e.g. JSON Schema tooling to resolve the ``$ref`` keyword across all drafts without needing to implement support themselves.
4
4
5
+
This library is meant for use both by implementers of JSON referencing-related tooling -- like JSON Schema implementations supporting the :kw:`$ref` keyword -- as well as by end-users using said implementations who wish to then configure sets of resources (like schemas) for use at runtime.
6
+
7
+
The simplest example of populating a registry (typically done by end-users) and then looking up a resource from it (typically done by something like a JSON Schema implementation) is:
8
+
9
+
.. testcode::
10
+
11
+
from referencing import Registry, Resource
12
+
import referencing.jsonschema
13
+
14
+
schema = Resource.from_contents( # Parse some contents into a 2020-12 JSON Schema
0 commit comments