sds-yaml

What problem does it solve?

SDS YAML authoring for SEA-DSL enables machine-readable service design specs and smooth transition to code generation by standardizing the SDS structure and validation workflow.

Core Features & Use Cases

• Schema-aligned SDS authoring: Create SDS YAML files that map to SEA-DSL flows for domain models, CQRS operations, ports, and runtime configuration.
• Validation-ready templates: Includes guidance to validate against the SDS schema and ensure CQRS completeness and SEA-DSL alignment.
• Use Case: Designers define a service's contracts once, then generate consistent implementation scaffolds and documentation.

Quick Start

1. Create a file named service.sds.yaml using the SDS template.
2. Fill required fields under sds: id, bounded_context, version, and status, and provide domain, cqrs, events, ports, and runtime as needed.
3. Run the validator to ensure schema conformity: tools/validate_sds.py path/to/service.sds.yaml and then verify SEA-DSL alignment with your flows.