Check schemas embedded in files
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
The issue names no files, tests, or entry points. Begin by clarifying supported file formats, fragment identification, schema selection, and CLI configuration. Done means embedded JSON fragments can be discovered and validated against explicit or default schemas.
Written by the indexing model from the issue text.
Description
There are multiple times when we (the JSON Schema team) would like to be able to validate JSON embedded in other files, such as markdown. (Specifically, JSON Schema examples in our docs and website.)
I imagine it would work by allowing the following:
- Specify what files should be inspected
- Identify which fragments of the files are JSON (This may need different approaches per format, potentially with a way to self declare the wish to be validated)
- Process such fragments which self-identify which Schema they should be validated with (such as a standard meta-schema)
- Optionally take an argument/s which specifies a default JSON Schema to be used for all fragments within a given file/glob of files
Please do reach out to me on Slack or @Julian. I likely won't see follow up comments here directly as I've declared GH notificaiton bankruptcy. Thanks.
- Dominant language
- Python
- Stars
- 345
- Forks
- 70
- Avg merge
- 12h 56m
- Merged PRs (30d)
- 6
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from python-jsonschema/check-jsonschema
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Explore skipping the metaschema check for vendored schemasPossibly taken @sirosen claimed this 12 days ago. Open
python-jsonschema/check-jsonschema#723 · 1 assignee ·
-
New vendored schemas: DatadogPossibly taken @lannuttia claimed this 66 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Feature Request: Support URL rewriteMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Support ETag for cache validation when Last-Modified is unavailablePossibly taken @sirosen claimed this 198 days ago. Openenhancement
python-jsonschema/check-jsonschema#668 · 9 comments · 1 assignee ·
All issues in python-jsonschema/check-jsonschema
Similar issues
-
area:space-accuracy good first issue track:data
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Sara-Managed-Projects/space-radar#904 ·
Maintainers usually reply within 1 day