Skip to content

Add JSON schema for lineage data model v1beta1#7157

Closed
pditommaso wants to merge 1 commit into
masterfrom
lineage-v1beta1-json-schema
Closed

Add JSON schema for lineage data model v1beta1#7157
pditommaso wants to merge 1 commit into
masterfrom
lineage-v1beta1-json-schema

Conversation

@pditommaso
Copy link
Copy Markdown
Member

Summary

  • Adds a JSON Schema (Draft 2020-12) for the lineage data model in package nextflow.lineage.model.v1beta1
  • Covers all LinSerializable root types (FileOutput, TaskOutput, TaskRun, Workflow, WorkflowOutput, WorkflowRun) plus the shared Checksum, DataPath and Parameter types under $defs
  • Located at modules/nf-lineage/src/main/resources/schema/lineage-v1beta1.json so it ships with the nf-lineage module

Notes

  • OffsetDateTime fields are modelled as string with format: date-time
  • Untyped Map fields (globalVars, config, metadata) are modelled as open objects (additionalProperties: true)
  • Parameter.value accepts any JSON-representable type
  • All fields are optional (no required lists) to match the Groovy @Canonical classes which have no nullability constraints

Test plan

  • python3 -m json.tool modules/nf-lineage/src/main/resources/schema/lineage-v1beta1.json parses successfully
  • Validate the schema with a JSON Schema 2020-12 validator (e.g. ajv) against an example lineage record

🤖 Generated with Claude Code

Add a JSON Schema (Draft 2020-12) describing the lineage data model in
package `nextflow.lineage.model.v1beta1`. The schema covers all
LinSerializable types (FileOutput, TaskOutput, TaskRun, Workflow,
WorkflowOutput, WorkflowRun) and the reusable types Checksum, DataPath
and Parameter.

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 19, 2026

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 596865e
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/6a0c74159f42790008294bcc

@jorgee
Copy link
Copy Markdown
Contributor

jorgee commented May 20, 2026

Closing. I tried to validate generated files with this schema and it is failing because it is not considering the envelop (version, type, spec) and not accepting null values.
Working schema in nextflow-io/schemas#18

@jorgee jorgee closed this May 20, 2026
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