python-jsonschema / python-jsonschema/referencing

Implement a resource bundler

Open
#27 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
53
Forks
27
Avg merge
1d 8h
Merged PRs (30d)
8

Description

We should offer a resource bundler which implements the "official JSON Schema bundling process". Doing so shouldn't be too difficult on top of what's already here.

Here's one from json-schema-ref-parser, and another from @jderosiers.

It's probably a judgement call whether to do this here in this repository or in a separate one which is JSON Schema specific (even though here we have referencing.jsonschema, a module for JSON Schema-specific functionality). But this kind of functionality relies on functionality which is less likely to be cross-spec applicable -- or maybe not and it can be (would probably involve adding some methods to Specification regardless which specify how to perform the bundling). Thinking required. If it does live here, it's probably something that can be a method on Registry, and may tangentially relate to #16.

Contributor guide

No contributing guide indexed for this repository

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

Start by reading the official JSON Schema bundling process and the linked json-schema-ref-parser and @jderosiers implementations. Then inspect the Registry, Specification, and referencing.jsonschema entry points, alongside issue #16, to decide the repository boundary. Done requires an agreed design and a compatible resource-bundling implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
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.