Skip to content

vex file schema #3

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions vex.schema.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
$schema: "http://json-schema.org/draft-06/schema#"
type: object
properties:
description:
type: string
cases:
type: array
items:
type: object
properties:
directive:
description:
The language in the specification indicating that the listed `schemas` are nonconformant.

This language should have the same meaning across referenced `specifications` to which the case applies.
Minor rewording across specifications shouldn't necessitate a new case.
type: string
specifications:
description: List of specifications to which this case applies, containing the language of (or the same meaning as) `directive`.
type: array
items:
type: object
properties:
$schema:
type: string
format: uri
description:
An identifier corresponding to the metaschema dialect whose specification contains the directive.

This is to be used by implementations to indicate what specification implementations to test
against, comparable to the directory names JSON-Schema-Test-Suite uses.
ref:
type: string
description: A human-readable reference to the location of the directive in the specification.
schemas:
type: object
propertyNames:
description: >
An identifier
- unique across this suite
- consisting of words separated by '.'
- indicating the problem with the schema in a hierarchical way, by which implementations
may group cases with as much granularity as needed
pattern: "([^\\.]+)(\\.[^\\.]+)*"
additionalProperties:
description:
A schema which does not conform to each specification listed in `specifications`,
for the reason indicated by `directive`.