Skip to content

feat: Update workflow JSON schema to v2 with comprehensive descriptions and annotations #4910

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vivekchavan14
Copy link
Contributor

@vivekchavan14 vivekchavan14 commented Aug 11, 2025

  • Updated schema version from 1 to 2 to reflect enhancements
  • Added detailed JSDoc-style descriptions throughout schema using .describe() method
  • Enhanced documentation for node IDs, slot indices, data types, and 2D vectors
  • Added comprehensive descriptions for AI model file metadata fields
  • Improved documentation for graph state tracking and ID generation system
  • Added clear descriptions for workflow configuration settings and flags
  • Enhanced documentation for node connections, reroutes, and floating links
  • Improved subgraph definitions documentation with input/output descriptions
  • Updated validation function to support both v1 and v2 schemas for backward compatibility

Addresses #4898 by providing better schema documentation and proper versioning. Generated JSON schemas now include comprehensive field descriptions for better developer experience and IDE support.

┆Issue is synchronized with this Notion page by Unito

…ns and annotations

- Updated schema version from 1 to 2 to reflect enhancements
- Added detailed JSDoc-style descriptions throughout schema using .describe() method
- Enhanced documentation for node IDs, slot indices, data types, and 2D vectors
- Added comprehensive descriptions for AI model file metadata fields
- Improved documentation for graph state tracking and ID generation system
- Added clear descriptions for workflow configuration settings and flags
- Enhanced documentation for node connections, reroutes, and floating links
- Improved subgraph definitions documentation with input/output descriptions
- Updated validation function to support both v1 and v2 schemas for backward compatibility

Addresses Comfy-Org#4898 by providing better schema documentation and proper versioning.
Generated JSON schemas now include comprehensive field descriptions for better
developer experience and IDE support.
@vivekchavan14 vivekchavan14 requested a review from a team as a code owner August 11, 2025 15:01
Copy link

github-actions bot commented Aug 11, 2025

⚠️ Warnings

⚠️ Warning: E2E Test Coverage Missing

If this PR modifies behavior that can be covered by browser-based E2E tests, those tests are required. PRs lacking applicable test coverage may not be reviewed until added. Please add or update browser tests to ensure code quality and prevent regressions.

⚠️ Warning: Visual Documentation Missing

If this PR changes user-facing behavior, visual proof (screen recording or screenshot) is required. PRs without applicable visual documentation may not be reviewed until provided.
You can add it by:

  • GitHub: Drag & drop media directly into the PR description

  • YouTube: Include a link to a short demo

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.

1 participant