Skip to main content

Domain frontmatter API

Overview​

Domains are just markdown files, with this comes the use of Content, MDX components and also front-matter.

Here is an example of the domain frontmatter you will find in your domain files.

/domains/Orders/index.md (example)
---
# id of your domain, used for slugs and references in EventCatalog.
id: Orders

# Display name of the domain, rendered in EventCatalog
name: Orders

# Version of the domain
version: 0.0.1

# Short summary of your domain
summary: |
  Domain that contains order related information

# Optional owners, references teams or users
owners:
    - dboyne

# Optional services. Groups services into this domain.
services:
    - id: PaymentService
      version: 0.0.1

# Optional badges, rendered to UI by EventCatalog
badges:
    - content: New domain
      backgroundColor: blue
      textColor: blue
---

## Overview

Domain that contains all services that are related to the orders domain within FakeCompany.

<NodeGraph />

Required fields​

id​

  • Type: string

Unqiue id of the domain. EventCatalog uses this for references and slugs.

Example
---
  id: Orders
---

name​

  • Type: string

Name of the domain this is used to display the name on the UI.

Example
---
  name: My orders domain
---

version​

  • Type: string

Version of the domain.

Example
---
  version: 0.0.1
---

Optional fields​

summary​

Short summary of your domain, shown on domain summary pages.

Example
---
  summary: |
    Domain that contains everything about orders
---

owners​

An array of user ids that own the domain.

Example
---
  owners:
    - dboyne
    - mSmith
---

services​

An array of services ids that belong to the this domain. Which services belong to this domains bounded context.

Example
---
  services:
    - InventoryService
    - OrderService
---

badges​

An array of badges that get rendered on the page.

Example
---
  badges:
    - content: My badge
      backgroundColor: blue
      textColor: blue
---

specifications​

Added in eventcatalog@2.6.0

Specifications to include on the page

Current supports AsyncAPI and OpenAPI files. When including the specifications the page will render badges and buttons for the specifications.

Example
---
  specifications:
    asyncapiPath: order-service-asyncapi.yaml
    openapiPath: openapi.yml
---