Skip to content

Conversation

@v1r3n
Copy link
Collaborator

@v1r3n v1r3n commented Oct 22, 2025

Pull Request type

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • WHOSUSING.md
  • Other (please describe):

Changes in this PR

Added important schemas that are useful for automations and LLMs

This PR introduces comprehensive JSON Schema definitions for Conductor's four core data models, enabling validation, documentation generation, IDE support, code generation, and AI/LLM integration.

The schemas for Workflow and Task will be useful for anyone wanting to build a validation system for Conductor as well as LLMs to understand the schemas for the critical models in Conductor for them to be able to generate and manage workflow.

Motivation

JSON Schemas provide a standardized, machine-readable way to describe Conductor's data models, enabling:

  • Validation: Validate workflow and task definitions before submitting them to Conductor, catching errors early
  • IDE Integration: Enable autocomplete, inline documentation, and real-time validation in VS Code, IntelliJ, and other IDEs
  • Code Generation: Generate strongly-typed client libraries in various programming languages
  • Documentation: Auto-generate API documentation from schemas
  • AI/LLM Integration: Allow AI systems to understand Conductor's data structures for workflow generation and management
  • Contract Testing: Ensure API responses conform to expected formats

Benefits for the Community

  1. Faster Development: Developers get instant feedback while writing workflows
  2. Fewer Errors: Catch configuration mistakes before runtime
  3. Better Documentation: Self-documenting schemas with descriptions for every field
  4. Tool Ecosystem: Enable building of validation tools, linters, formatters, and generators
  5. AI Integration: Make Conductor more accessible to AI-powered automation tools

Version Info

  • Schema version: 1.0
  • Based on: Conductor 3.x
  • Specification: JSON Schema Draft 07

@nthmost-orkes nthmost-orkes self-assigned this Oct 22, 2025
@nthmost-orkes nthmost-orkes self-requested a review October 22, 2025 03:50
@nthmost-orkes nthmost-orkes removed their assignment Oct 22, 2025
Copy link
Contributor

@nthmost-orkes nthmost-orkes left a comment

Choose a reason for hiding this comment

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

Can you give this a better description 😆

Since there's no associated issue describing what this PR is for, the PR should have more of a description of the motivation and utility of what's inside it.

If you don't mind.

(You can use Claude to do it, this is for humans and to set good examples here.)

@v1r3n
Copy link
Collaborator Author

v1r3n commented Oct 22, 2025

Can you give this a better description 😆

Since there's no associated issue describing what this PR is for, the PR should have more of a description of the motivation and utility of what's inside it.

If you don't mind.

(You can use Claude to do it, this is for humans and to set good examples here.)

Added more notes.

@nthmost-orkes nthmost-orkes self-requested a review October 22, 2025 16:50
@nthmost-orkes nthmost-orkes changed the title Schemas Add JSON Schema Definitions for Core Conductor Models Oct 22, 2025
Copy link
Contributor

@nthmost-orkes nthmost-orkes left a comment

Choose a reason for hiding this comment

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

Nice, this will be useful. thanks for updating the description.

@nthmost-orkes nthmost-orkes merged commit 0a26afe into main Oct 22, 2025
9 of 11 checks passed
@nthmost-orkes nthmost-orkes deleted the schemas branch October 23, 2025 21:10
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.

3 participants