How datacontract/datacontract-specification works
Main Components
a) Core Components:
• Data Contract Specification Engine
• Schema Validation Layer
• Data Contract Parser
• Server Type Handlers
• Quality Validation Engine
• Service Level Agreement (SLA) Monitor
b) Integration Components:
• CLI Interface
• JSON Schema Validator
• External Tool Integrations (Soda, Great Expectations)
• Version Management System
Relationships and Data Flow
• Input flow of YAML data contracts
• Schema validation process
• Server type resolution
• Quality checks execution
• Service level monitoring
• Integration with external tools
Architectural Pattern
Use a layered architecture pattern with:
• Interface Layer (CLI, API)
• Core Specification Layer
• Validation Layer
• Integration Layer
• Storage Layer
• Interface Layer |
• CLI Tool | | Web Editor | | GPT Interface | | Schema Store | |
• Core Specification Layer |
• Contract Parser | | Schema Validator | | Version Manager| | Extension Handler| |
• Validation Layer |
• Quality Checker | | SLA Monitor | | Data Validator | | Lineage Tracker | |
• Integration Layer |
• Soda Engine | | Great Expect. | | Custom Engines | | Server Adapters | |
• Storage Layer |
• Version Store | | Contract Repo | | Example Store | | Schema Registry | |
Additional Elements
• Version management indicators
• External tool integration points
• Validation checkpoints
• Extension points for custom implementations
Important Details to Capture
• Support for multiple server types (BigQuery, S3, etc.)
• Quality validation mechanisms
• Service level monitoring points
• Schema validation process
• Version management system
• Extension mechanisms