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

"$schema", "$id", and "description" #55

Open
jnareb opened this issue Oct 14, 2024 · 1 comment
Open

"$schema", "$id", and "description" #55

jnareb opened this issue Oct 14, 2024 · 1 comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jnareb
Copy link

jnareb commented Oct 14, 2024

Shouldn't fully featured JSON Schema file include also the following top-level fields:

  • $schema: specifies which draft of the JSON Schema standard the schema adheres to

    (e.g. https://json-schema.org/draft/2020-12/schema)
  • $id: sets a URI for the schema

    (e.g. https://github.com/iterative/dvcyaml-schema or https://raw.githubusercontent.com/iterative/dvcyaml-schema/master/schema.json)
  • description: state the intent of the schema

    (e.g. Definition of DVC pipeline, or something like that)

Taken from https://json-schema.org/learn/getting-started-step-by-step#create-a-schema-definition

@shcheklein
Copy link
Member

I'm not an expert but it looks you are right. Please feel free to create a PR with these changes, @jnareb !

@shcheklein shcheklein added good first issue Good for newcomers help wanted Extra attention is needed labels Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants