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

Add programmatic configuration schemas #84

Open
maxfischer2781 opened this issue Feb 19, 2021 · 0 comments
Open

Add programmatic configuration schemas #84

maxfischer2781 opened this issue Feb 19, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed usability

Comments

@maxfischer2781
Copy link
Member

The configuration is currently treated as a blob of raw YAML/JSON equivalent data. This makes validation and error reporting difficult, as keys/values are checked on usage.

cobald should provide means to define expected schemas for configuration. This would allow to efficiently detect and report errors. Schemas would also allow to generated documentation; this is not required for the base functionality.
Schemas perhaps should (allow to) be automatically generated from the objects taking the configuration.

Related issues:

External packages:

  • The pydantic package for validating runtime types based on annotations.
@maxfischer2781 maxfischer2781 added enhancement New feature or request help wanted Extra attention is needed usability labels Feb 19, 2021
@maxfischer2781 maxfischer2781 self-assigned this Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed usability
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant