API versioning & deprecation template

Components in this architecture diagram

• Breaking change needed
• Design v2 endpoint
• Ship v2 alongside v1
• Docs & migration guide
• Deprecation & Sunset headers on v1
• Email API consumers
• Track v1 traffic by client
• v1 usage below 1%?
• Direct outreach to top callers
• Brownout: v1 off for 1 hour
• Complaints?
• Remove v1
• Changelog published

How to use this architecture diagram template

1. Click Open in the editor. The architecture 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 LR
  A((Breaking change needed)) --> B[Design v2 endpoint]
  B --> C[Ship v2 alongside v1]
  C --> D[Docs & migration guide]
  D --> E[Deprecation & Sunset headers on v1]
  E --> F[Email API consumers]
  F --> G[Track v1 traffic by client]
  G --> H{v1 usage below 1%?}
  H -->|No| I[Direct outreach to top callers]
  I --> G
  H -->|Yes| J[Brownout: v1 off for 1 hour]
  J --> K{Complaints?}
  K -->|Yes| I
  K -->|No| L[Remove v1]
  L --> M((Changelog published))

Related: System architecture diagram tool · Mermaid editor · All software engineering & state machines templates · All 521 templates