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

Simplify yaml schema #264

Merged
merged 4 commits into from
Jun 25, 2024
Merged

Simplify yaml schema #264

merged 4 commits into from
Jun 25, 2024

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented May 30, 2024

Avoid repetitions in yaml schema.

@codecov-commenter
Copy link

codecov-commenter commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.33%. Comparing base (4179d03) to head (65c6304).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #264   +/-   ##
========================================
  Coverage    76.33%   76.33%           
========================================
  Files           36       36           
  Lines         3228     3228           
  Branches       783      783           
========================================
  Hits          2464     2464           
  Misses         559      559           
  Partials       205      205           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dweindl dweindl marked this pull request as ready for review June 25, 2024 08:47
@dweindl dweindl requested a review from a team as a code owner June 25, 2024 08:47
Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Top of this file: the URL https://json-schema.org/understanding-json-schema/index.html could be changed to https://json-schema.org/understanding-json-schema.

Also confusing to read this is a JSON schema, but it's in YAML. Does the JSON schema cover this YAML document explicitly? Or is it just that this document describes some dictionary that JSON schema is compatible with, but the YAML directly is not supported?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

json-schema has been developed for json, but it can be applied to Python objects. We are applying it to a dict. It does not check the yaml syntax itself (loading the yaml file will already fail before the validation in case of syntax errors), but only the data model.

@dweindl
Copy link
Member Author

dweindl commented Jun 25, 2024

  • the v1 schema should also be updated

@dweindl dweindl merged commit e488e56 into PEtab-dev:develop Jun 25, 2024
7 checks passed
@dweindl dweindl deleted the simplify_schema branch June 25, 2024 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants