python-jsonschema / python-jsonschema/referencing

Add a mechanism for evolving JSON Schema drafts to add keywords

Open
#24 0 comments 0 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 need some generic mechanism for saying "I have a new Specification, it's like DRAFT202012 but with a new keyword foo" and then allowing the new keyword foo to either have a schema value (a la additionalItems or whatever) or schema-containing values (properties) etc...

Obviously the most "generic" mechanism will be fully defining subresources_of (and now maybe_in_subresource) as a generic callable -- but a simple/fast interface which just allows adding the extra keyword will make things easier downstream.

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

The proposed entry points are Specification, DRAFT202012, subresources_of, and maybe_in_subresource; begin by tracing how keywords such as additionalItems and properties are handled. Done means a downstream user can derive a new Specification from DRAFT202012 and add foo with both schema-valued and schema-containing forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, python
Domain
api, backend-api-design
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.