Data contracts between producers and consumers template

Components in this data flow diagram

• Producer team changes schema
• Update contract YAML
• CI: compatibility check
• Breaking change?
• Merge & publish new version
• Notify registered consumers
• Consumers ready?
• Publish v2 alongside v1
• Deprecation window
• Schema registry
• Runtime validation in pipeline
• Record violates contract?
• Dead letter & alert producer
• Delivered to consumers

How to use this data flow diagram template

1. Click Open in the editor. The data flow diagram opens on a new page in FlowDiagram — nothing is uploaded and there is no sign-up.
2. Rename, add or delete shapes and drag them where you want; connectors stay attached as things move.
3. Drop in vendor logos from the library — 1,160 of them, including every AWS, Azure and Google Cloud service icon — or restyle it with the colour and theme controls.
4. Prefer text? Edit the Mermaid source below and paste it in through ☰ → Import diagram (see the Mermaid editor); it imports as an editable diagram.
5. Export to PNG, SVG or PDF, or press Ctrl+L for a link that carries the whole diagram.

Mermaid source

The whole template is the text below. Paste it into FlowDiagram, keep it in Git next to the code it describes, or hand it to an AI assistant to extend.

flowchart TD
  A((Producer team changes schema)) --> B[Update contract YAML]
  B --> C[CI: compatibility check]
  C --> D{Breaking change?}
  D -->|No| E[Merge & publish new version]
  D -->|Yes| F[Notify registered consumers]
  F --> G{Consumers ready?}
  G -->|No| H[Publish v2 alongside v1]
  H --> I[Deprecation window]
  I --> E
  G -->|Yes| E
  E --> J[Schema registry]
  J --> K[Runtime validation in pipeline]
  K --> L{Record violates contract?}
  L -->|Yes| M[(Dead letter & alert producer)]
  L -->|No| N((Delivered to consumers))

Related: Data pipeline diagram tool · Mermaid editor · All data pipelines & etl templates · All 521 templates