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

Define a YAML schema if possible #45

Open
StevenMaude opened this issue Jun 26, 2021 · 1 comment
Open

Define a YAML schema if possible #45

StevenMaude opened this issue Jun 26, 2021 · 1 comment

Comments

@StevenMaude
Copy link
Contributor

StevenMaude commented Jun 26, 2021

It feels like this repository is the best place to open this issue, as actions are checked here. But feel free to close and tell me where to open it if more appropriate.

A user asked a question, that I think should be resolved by fixing the indentation of their project.yaml. But opensafely doesn't complain about the configuration; it is valid YAML and the describe top-level key in that example is just silently ignored.

If we had schema validation, then we could add this to the Gitpod configuration for the research template for Gitpod. This might alert users if something is wrong with the configuration.

@ghickman ghickman transferred this issue from opensafely-core/opensafely-cli May 27, 2022
@ghickman
Copy link
Contributor

I think we might be able to generate a schema now that pydantic is validating the configuration, or at the very least use this library as a validator.

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

2 participants