json-schema-org / json-schema-org/JSON-Schema-Test-Suite

Document the metaschema URI used for draft-next tests for authors of new tests and implementers wanting to run them

Open
#554 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
750
Forks
307
Avg merge
3d 17h
Merged PRs (30d)
24

Description

The draft-next folder contains tests for in-development next versions of the specification.

It allows us to get ahead of testing before the spec is complete.

At the minute in order to run these tests there's at least one notable extra step:

Tests like this one are how we represent validating schemas against metaschemas. But the URL used there for draft-next is a 404. Of course someone wanting to run that test can inject a metaschema for that URL to their implementation's schema store. But ideally, if we do already publish metaschemas iteratively for the next version of the spec, we should use the URL those are published under, and somehow remember to update it when "freezing" the draft-next folder on release.

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

Start with tests/draft-next/defs.json and inspect the metaschema URL used there. Determine whether an iterative draft-next metaschema is published and identify the URI that authors and implementers should use. Done means documenting that URI and recording how it should be updated when draft-next is frozen for a release.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.