Skip to main content

Adding attachments to data stores

Added in eventcatalog@2.59.0

If you have any external resources, diagrams, or documentation that you want to link to your data store, you can add them using the attachments property.

This will render a new section on your data store page with the attachments.

Adding attachments to data stores​

To add attachments to a data store you need to add them to the attachments array in the data store's markdown file.

Attachments can be a url (string) or an object with additional properties.

/services/PaymentService/containers/PaymentDatabase/index.mdx
id: PaymentDatabase
name: Payment Database
attachments:
  - url: https://example.com/erd/payment-database.png
    title: ERD of the Payment Database
    description: Learn more about the schema of the Payment Database.
    type: 'diagrams'
    icon: FileTextIcon

Grouping attachments​

You can group attachments by using the type property in your attachments.

Any attachment with the same type will be grouped together in the UI.

Picking your icon​

You can pick your icon from the lucide icons library.

You can find a list of them here.