python-jsonschema / python-jsonschema/check-jsonschema

Check schemas embedded in files

Open
#143 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
341
Forks
71
Avg merge
15d 20h
Merged PRs (30d)
4

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.