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

Convert YAML configuration to standard schema #506

Open
carlhiggs opened this issue Jan 23, 2025 · 1 comment
Open

Convert YAML configuration to standard schema #506

carlhiggs opened this issue Jan 23, 2025 · 1 comment
Assignees

Comments

@carlhiggs
Copy link
Collaborator

carlhiggs commented Jan 23, 2025

Current configuration approach is complicated for users because of syntax, but also for developers because it is somewhat ad hoc and lacks some consistency/clarity about requirements.

For users the configuration should be abstracted (potentially, there are different options for configuring input); for developers the configuration should standardised with requirements clearly specified (allowing for interchange between formats, including as a GUI for users).

@gboeing and @rschifan recommend JSON Schema.

@ghsci-architecture-and-ux-working-group discussed that @carlhiggs will make a draft in coming weeks and we will discuss at our next software group meeting.

@carlhiggs carlhiggs self-assigned this Jan 23, 2025
@carlhiggs
Copy link
Collaborator Author

this relates to #472

@carlhiggs carlhiggs changed the title Convert YAML configuration to standard schema (JSON Schema) Convert YAML configuration to standard schema Feb 3, 2025
carlhiggs added a commit that referenced this issue Mar 18, 2025
…ed schema against the reference standard, and the example configuration against the updated version successfully using jsonschema) towards #506
carlhiggs added a commit that referenced this issue Mar 18, 2025
…g schema, towards #506; example configuration now validates (although, it is pending improvement and standardisation, eg of dates --- but that will involve breaking changes, so is a separate bigger task
carlhiggs added a commit that referenced this issue Mar 18, 2025
…ions (i.e. that null is correct value, not 0); towards #506
carlhiggs added a commit that referenced this issue Mar 18, 2025
…Test workflow appears to pass now, without unintended downstream consequences of modifying pyyaml constructors.
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

No branches or pull requests

1 participant