Skip to main content

Service Frontmatter Config

Overview​

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

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

---
name: Basket Service
summary: |
  CRUD based API to handle Basket interactions for users of the shopping website.
owners:
    - dboyne
repository:
  language: JavaScript
  url: https://github.com/boyney123/pretend-basket-service
---

Required fields​

name​

  • Type: string

Name of the service.

Example
---
  name: Basket Service
---

Optional fields​

summary​

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

Example
---
  summary: |
    CRUD based API to handle Basket interactions for users of the shopping website.
---

repository​

The repository for the service.

Example
---
  repository:
    language: JavaScript
    url: https://github.com/boyney123/pretend-basket-service
---

You can specify the language and url for your service repository and EventCatalog will render these out.

owners​

An array of user ids that own the service.

Example
---
  owners:
    - dboyne
    - mSmith
---
How to configure users

You can configure users in the eventcatalog.config.js file. Find out more reading the users configuration

List of URLs that can be used when people want to reference to external documentation for the service.

  • Type: Tag
    • label: value that gets rendered on the UI
    • href: URL for link
Example
---
  externalLinks: 
    - label: AsyncAPI Specification
      url: https://studio.asyncapi.com/#schema-lightMeasuredPayload
---