Skip to content

Add $schema ref to generated module spec#7056

Merged
bentsherman merged 1 commit intomasterfrom
module-schema-version
Apr 22, 2026
Merged

Add $schema ref to generated module spec#7056
bentsherman merged 1 commit intomasterfrom
module-schema-version

Conversation

@bentsherman
Copy link
Copy Markdown
Member

This PR adds a $schema property to the module spec which denotes the module schema

The generated module spec always uses the new schema: https://github.com/nextflow-io/schemas/blob/main/module/v1/schema.json

So if the $schema isn't specified, you can assume it is the nf-core schema:
https://github.com/nf-core/modules/blob/master/modules/meta-schema.json

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 20, 2026

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit ca9b671
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/69e8cfc8f4c7a70008e8cb43

@bentsherman bentsherman force-pushed the module-schema-version branch from a6a9b4a to fbec79d Compare April 21, 2026 16:14
Copy link
Copy Markdown
Member

@pditommaso pditommaso left a comment

Choose a reason for hiding this comment

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

Just realised, there's an implicit version on the path however the schema version is not defined explicitly anywhere

@bentsherman
Copy link
Copy Markdown
Member Author

It's part of the $id property in the schema:

https://github.com/nextflow-io/schemas/blob/d0d2e56863327e430008693e2ce7bea9ad1d1466/module/v1/schema.json#L3

I don't think there is a separate version property in JSON schema

Copy link
Copy Markdown
Member

@pditommaso pditommaso left a comment

Choose a reason for hiding this comment

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

Fair enough

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman bentsherman force-pushed the module-schema-version branch from fbec79d to ca9b671 Compare April 22, 2026 13:40
@bentsherman bentsherman merged commit c40d742 into master Apr 22, 2026
24 checks passed
@bentsherman bentsherman deleted the module-schema-version branch April 22, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants