python-jsonschema / python-jsonschema/jsonschema
Support hiding annotation keywords when reporting errors
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5k
- Forks
- 671
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 10
Description
Sometimes a schema contains annotation-only keywords (particularly e.g. description or $comment) which effectively serve no purpose when reporting validation errors and essentially make the output longer / harder to read through.
While it would be nice if we had some even more fancy way of indicating what parts of the schema are relevant (e.g. via syntax highlighting and/or direct "arrow" pointing), a nice "cheaper" option would be to be able to render schemas without their annotation keywords (configurably).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by locating the schema-rendering path used in validation error reporting, then define how configurable omission of annotation-only keywords such as description and $comment should work; done means schemas can be rendered without those keywords while errors remain readable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100