Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Julian opened this issue Jun 15, 2022 · 2 comments
Labels
documentation A request for new or updated documentation for the suite enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test).

Comments

@Julian
Copy link
Member

Julian commented Jun 15, 2022

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.

@Julian Julian added the enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test). label Jun 15, 2022
@Julian Julian changed the title draft-next tests which want to reference a metaschema aren't runnable draft-next tests which want to reference a metaschema use a non-existent URL Jun 15, 2022
@karenetheridge
Copy link
Member

But the URL used there for draft-next is a 404.

Why is this a problem? We don't require implementations to download schema resources from the network.
I believe the draft-next schemas live in the draft-next branch of the json-schema-spec repository. Possibly we could link them into remotes/ using a submodule/subtree, but my expectation was that implementations would have to have local copies of the schemas anyway. (We certainly want to encourage that practice, as we've seen vast numbers of downloads of the other specs from the website, which could start to get expensive.)

@Julian
Copy link
Member Author

Julian commented Jun 20, 2022

It's not a problem, mostly I filed this since it's not obvious that that expectation is present (which confused me as an author when writing a new test) -- so perfectly happy to consider this just a "hey let's document that we use some URI for that schema" issue, write down your suggestion about how implementations get access to that schema, and then yeah not a bug at all.

@Julian Julian added the documentation A request for new or updated documentation for the suite label Jun 22, 2022
@Julian Julian changed the title draft-next tests which want to reference a metaschema use a non-existent URL Document the metaschema URI used for draft-next tests for authors of new tests and implementers wanting to run them Jul 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A request for new or updated documentation for the suite enhancement An enhancement to the tooling or structure of the suite (as opposed to a new test).
Projects
None yet
Development

No branches or pull requests

2 participants