Templates / sequenceDiagram

API deprecation notice

Publishing a deprecation notice and Sunset header, then guiding a consumer through migration.

Open in studio

Preview

Mermaid 11 renderer

Rendering preview...

Mermaid source

sequenceDiagram

sequenceDiagram
    participant Team as API team
    participant Docs as Changelog
    participant Consumer as API consumer
    participant Gateway

    Team->>Docs: Publish deprecation notice
    Team->>Gateway: Add Sunset header to responses
    Gateway-->>Consumer: Response with Sunset header
    Consumer->>Team: Ask about migration path
    Team-->>Consumer: Share migration guide
    Consumer->>Gateway: Switch to new endpoint

More templates

flowchartArchitecture

Microservices architecture

A service map with an API gateway, core services, and shared infrastructure. A solid starting point for README architecture sections.

sequenceDiagramProcess

User login sequence

A login flow with token issuance and a failure branch. Useful for documenting auth endpoints and session behavior.

stateDiagram-v2Process

Order state machine

Lifecycle states for an e-commerce order, from creation to fulfillment, with cancellation and refund paths.