Skip to content

Expose workflow metadata as a Pydantic model #900

Description

@jeremyjordan

Priority Level

Medium (Nice to have)

Is your feature request related to a problem? Please describe.

Workflow metadata is persisted as JSON but does not currently have a public, typed representation. This makes it harder for users and external tools to reliably inspect workflow status, stage configuration, outputs, and provenance.

Describe the solution you'd like

Add and publicly export a Pydantic WorkflowMetadata model, including an appropriate model for stage-level metadata.

The model should:

  • Represent the existing workflow metadata format.
  • Support metadata from running, failed, completed, completed-empty, and skipped stages.
  • Provide consistent validation and JSON serialization.
  • Preserve compatibility with existing workflow metadata files.
  • Be importable from the public Data Designer interface.

This would establish a clear programmatic contract for workflow observability and integrations while keeping the workflow metadata format machine-readable and self-describing.

Describe alternatives you've considered

No response

Agent Investigation

No response

Additional context

No response

Checklist

  • I've reviewed existing issues and the documentation
  • This is a design proposal, not a "please build this" request

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions