Schema Reference

JSON schema definitions and configuration validation for the platform workflow and inventory files.

What You’ll Find Here

This subsection covers:

  • JSON Schema - Schema definitions for workflow and inventory YAML files

  • Configuration Validation - Validating your configurations before running

  • Schema Documentation - Auto-generated schema reference

  • Type Definitions - Complete type specifications

Using Schema Validation

The platform provides built-in schema validation to catch configuration errors early.

Validate Configuration

Use the validate-config command:

tdk validate-config --config-file workflow.yaml

Print JSON Schema

View the complete JSON schema:

tdk json-schema > workflow-schema.json

Use this schema with your IDE for autocomplete and validation.

Where to Start

Related Topics