Skip to main content

Adding entities to services

What are entities?

Entities are a "optional" resource in EventCatalog. You can learn more reading our entities guide.

Once you have created your entities you can add them to your services.

To add an entity to a service you need to add the entity to the entities array in the service's markdown file.

/services/PaymentService/index.mdx

---
id: PaymentService
name: PaymentService
version: 1.0.0
# This assumes you have an entity called Payment
entities:
- id: Payment
# Optional, if not provided the latest version will be used
version: 1.0.0
---

Your service markdown...