summaryrefslogtreecommitdiff
path: root/docs/faq.rst
Commit message (Collapse)AuthorAgeFilesLines
* Add some prose documentation on the new referencing API.Julian Berman2023-02-221-51/+1
|
* Deprecate jsonschema.RefResolver from both places it is importable.Julian Berman2023-02-211-6/+3
| | | | | | Internal uses of it will be removed, replaced with referencing's resolution APIs, though RefResolver will continue to function during its deprecation period.
* Another RTD-only failed ref.Julian Berman2022-08-291-1/+1
|
* And now yet again some new failures...Julian Berman2022-08-291-1/+1
|
* Wouldn't be complete without refs which fail now only in ReadTheDocs. :/Julian Berman2022-08-291-3/+3
|
* Remove backticks from section headings.Julian Berman2022-08-281-6/+6
| | | | | Sphinx/intersphinx generates really weird or unreferenceable labels when these are here.
* Document slightly more clearly how this library interacts with non-JSON.Julian Berman2022-08-231-3/+28
| | | | Closes: #788
* Prefer 'keyword' over 'validator' in docs.Julian Berman2022-08-161-17/+17
| | | | | | | | | | | | | | In newer JSON Schema specifications we've standardized more on this language rather than calling things validators (and such a thing already has plenty of overloaded meaning here). This commit doesn't do any deprecation, so there's still some awkwardness in that ValidationError.validator is the keyword which failed validation, and Validator.VALIDATORS is a mapping of keywords to callables. We may choose to do so later, but for now will save some API churn in case something else changes.
* Update doc examples to use newer drafts' validators.Julian Berman2022-08-021-7/+7
| | | | | Obviously what was here works fine, but better to show the examples with a more recent spec.
* (Re-)enable more doctests.Julian Berman2022-08-021-3/+3
| | | | | It is way too easy to silently pass these :( -- specifically, the doctest directive only works for things with >>> prompts.
* Add a FAQ entry for remembering trailing slashes in base URIs.Julian Berman2022-07-281-0/+54
| | | | Refs: #601, #274
* Apply suggestions from code reviewStephen Rosen2021-12-131-1/+1
| | | | | | Primarily, rewrite `IValidator` to `Validator` Co-authored-by: Julian Berman <Julian@GrayVines.com>
* Add `jsonschema.protocols.IValidator`Stephen Rosen2021-12-131-2/+2
| | | | | | | | | | | | | | | | This is a Protocol implementation for type checking under mypy and other static analyzers. It uses the protocol class defined in py3.8+ and uses typing_extensions as a backport for py3.7 The documentation-only validator class has been replaced with the protocol, and docs are now driven via autoclass on the protocol. Importantly, several documented methods of the class have been removed, as they were marked deprecated under jsonschema v3.0 and are no longer provided by the builtin validators. Minor adjustments to the docs are made to repoint references at the new class definition.
* Bump doc requirements.Julian Berman2021-08-171-1/+1
|
* Remove the reference to jsonschema.compat in the compatibility policy.Julian Berman2020-08-061-3/+0
|
* Document that non-zero error codes are also not public.Julian Berman2020-03-221-0/+3
|
* Clarify what parts of the CLI output are public.Julian Berman2020-03-211-0/+4
|
* Add the upstream link here too.Julian Berman2020-03-211-0/+5
|
* Add/update some info on why format works the way it does.Julian Berman2020-03-211-0/+66
| | | | Closes: #653
* Tighten up the wording here.Julian Berman2020-01-081-5/+6
|
* Explicitly mention that benchmarks are not public.Julian Berman2019-09-041-1/+4
|
* Hopefully unnecessarily remind that tests are not public API.Julian Berman2019-08-161-33/+41
|
* Minor style.Julian Berman2019-06-091-6/+8
|
* iteritems -> itemsJulian Berman2019-06-081-1/+1
|
* First step on Draft7 support.Julian Berman2018-09-301-7/+7
| | | | | Add everything that's the same in Draft6, which appears to just leave out if/then/else.
* HTTPS (almost) everywhere.Julian Berman2018-09-291-1/+1
|
* Draft 6 for docs.Julian Berman2018-05-031-7/+7
|
* :mod: / :exc: / :meth:Julian Berman2017-12-241-2/+2
|
* :doc:Julian Berman2017-12-241-7/+6
|
* :class:esJulian Berman2017-12-241-3/+3
|
* StyleJulian Berman2017-12-241-5/+5
|
* And now fix all the broken refs.Julian Berman2017-12-241-7/+9
| | | | I have no idea how these were broken.
* docs: faq: Updates to extend_with_default() example:Stuart Berg2015-10-271-9/+51
| | | | | - Slight tweak to the code to enable validation (and recursive default population) of default properties. - Provided a hint regarding recursive population of default object properties.
* Try to be as explicit as possible on the million different uses of 'validator'.Julian Berman2014-12-071-4/+4
| | | | Closes #175.
* compat.py is not public API either.Julian Berman2014-10-051-1/+3
|
* Update FAQ with example of using defaulting validator.Anthony Sottile2014-03-311-1/+10
| | | | The faq example was useful but when used directly with the `validate` method it failed. I felt the little tidbit about that would be useful to pass along.
* Fight with reSTJulian Berman2013-07-281-7/+8
|
* Add a note about versioning.Julian Berman2013-07-281-2/+39
|
* Fix default example.Julian Berman2013-06-141-9/+17
|
* Remove embedded markupJulian Berman2013-05-281-1/+1
|
* Add a FAQ with info on default.Julian Berman2013-05-261-0/+48