Skip to content

Add JSON schema#81

Merged
sreichl merged 9 commits intomainfrom
add-json-schema
Mar 23, 2026
Merged

Add JSON schema#81
sreichl merged 9 commits intomainfrom
add-json-schema

Conversation

@hoferand
Copy link
Copy Markdown
Collaborator

No description provided.

@hoferand hoferand requested a review from sreichl March 20, 2026 15:21
Copy link
Copy Markdown
Collaborator

@sreichl sreichl left a comment

Choose a reason for hiding this comment

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

Please address the comments and also run a test if it works (once with correct and once with not correctly filled config/annotation).

@hoferand
Copy link
Copy Markdown
Collaborator Author

incorporated feedback, tested, and still works

@hoferand
Copy link
Copy Markdown
Collaborator Author

really nice finding, I moved them and it still works 🎉 Thanks!

@sreichl
Copy link
Copy Markdown
Collaborator

sreichl commented Mar 22, 2026

ready to merge?

@hoferand
Copy link
Copy Markdown
Collaborator Author

yes

@sreichl sreichl merged commit 0f01212 into main Mar 23, 2026
4 checks passed
@sreichl
Copy link
Copy Markdown
Collaborator

sreichl commented Mar 23, 2026

@hoferand similarly to the formatting and linting, can you provide clear instructions and resources for setting up the validation scheme, including also but not limited to potential AI prompts that worked well? Thanks.

@hoferand
Copy link
Copy Markdown
Collaborator Author

Sure!

  • Config Schemas
    • Create and use a schema for each config and annotation file, following the approach described in the Snakemake docs.
    • Place all schema files in workflow/schemas/ so they are easy to reference from the Snakefile.
    • Prompt used to generate the schemas (tested with Codex):
      Inspect the Snakemake workflow and identify every config or annotation field that is actually used. Create JSON Schema documents in YAML format under `workflow/schemas/` to match the real contract enforced by the workflow, not just the docs. Keep the schemas strict but simple, and prefer validator-compatible keywords. Update nearby documentation only if it helps future maintainers understand the validation setup. Use `https://json-schema.org/draft/2020-12/schema` for `$schema`.
      

@sreichl sreichl deleted the add-json-schema branch March 24, 2026 11:06
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.

2 participants