summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2020-05-08 08:02:21 -0400
committerJulian Berman <Julian@GrayVines.com>2020-05-08 08:02:21 -0400
commit1f37cb81c141df6a99bacc117b1549cc6702fa79 (patch)
tree18c84a081e5fdff80b3be96f2699702578d699b7 /docs
parentf29d5f1257477be48eaefd7f4d5d1ca245c4d556 (diff)
parent2382f8dda6429adffbf8aef697a50436f39bdf20 (diff)
downloadjsonschema-1f37cb81c141df6a99bacc117b1549cc6702fa79.tar.gz
Merge remote-tracking branch 'M2Mobi/master'
* M2Mobi/master: add json_path error attribute
Diffstat (limited to 'docs')
-rw-r--r--docs/errors.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/errors.rst b/docs/errors.rst
index d382702..15f751b 100644
--- a/docs/errors.rst
+++ b/docs/errors.rst
@@ -16,7 +16,9 @@ raised or returned, depending on which method or function is used.
=============== ================= ========================
`message` `context` `instance`
- `cause` `path`
+ `cause` `json_path`
+
+ `path`
`schema`
@@ -79,6 +81,11 @@ raised or returned, depending on which method or function is used.
`instance`\). The deque can be empty if the error happened
at the root of the instance.
+ .. attribute:: json_path
+
+ A `JSON path <https://goessner.net/articles/JsonPath/index.html>`
+ to the offending element within the instance.
+
.. attribute:: path
Same as `relative_path`.