Skip to main content

Diagrams reference

View as Markdown

This page lists the fields, paths, and routes supported by diagrams.

Paths​

Diagrams can be created in any diagrams folder:

/diagrams/{Diagram Name}/index.mdx
/domains/{Domain Name}/diagrams/{Diagram Name}/index.mdx
/systems/{System Name}/diagrams/{Diagram Name}/index.mdx

Versioned diagrams use:

/diagrams/{Diagram Name}/versioned/{version}/index.mdx

Routes​

RouteDescription
/docs/diagrams/{diagram-id}/{version}Diagram documentation page.

Required fields​

id​

  • Type: string

Unique id of the diagram. EventCatalog uses this for URLs and resource references.

Example
---
id: checkout-sequence
---

name​

  • Type: string

Display name of the diagram.

Example
---
name: Checkout Sequence
---

version​

  • Type: string

Version of the diagram documentation.

Example
---
version: 1.0.0
---

Optional fields​

summary​

  • Type: string

Short description of the diagram.

Example
---
summary: Sequence diagram for checkout orchestration.
---

owners​

  • Type: array

An array of team or user ids that own the diagram.

Example
---
owners:
  - checkout-platform
---

badges​

  • Type: array

Badges rendered on the diagram page.

Example
---
badges:
  - content: Mermaid
    backgroundColor: blue
    textColor: blue
---

repository​

  • Type: object

Repository metadata for the diagram.

Example
---
repository:
  url: https://github.com/acme/architecture
---

attachments​

  • Type: array

External links or supporting documents attached to the diagram.

Example
---
attachments:
  - title: Source diagram
    url: https://miro.com/app/board/example
    type: miro
---

Content​

Diagram pages can contain any MDX supported by EventCatalog, including Mermaid, PlantUML, Miro, IcePanel, Lucid, Draw.io, FigJam, images, and normal markdown.