Skip to main content

Data products reference

View as Markdown

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

Paths​

Data products can be created in any data-products folder:

/data-products/{Data Product Name}/index.mdx
/domains/{Domain Name}/data-products/{Data Product Name}/index.mdx

Versioned data products use:

/data-products/{Data Product Name}/versioned/{version}/index.mdx

Routes​

RouteDescription
/docs/data-products/{data-product-id}/{version}Data product documentation page.
/visualiser/data-products/{data-product-id}/{version}Data product resource diagram.

Required fields​

id​

  • Type: string

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

Example
---
id: customer-analytics
---

name​

  • Type: string

Display name of the data product.

Example
---
name: Customer Analytics
---

version​

  • Type: string

Version of the data product documentation.

Example
---
version: 1.0.0
---

Optional fields​

summary​

  • Type: string

Short description of the data product.

Example
---
summary: Curated customer analytics dataset for reporting and segmentation.
---

owners​

  • Type: array

An array of team or user ids that own the data product.

Example
---
owners:
  - data-platform
---

inputs​

  • Type: array

Resources used as inputs to the data product.

Example
---
inputs:
  - id: customer-database
    type: container
---

outputs​

  • Type: array

Outputs produced by the data product.

Example
---
outputs:
  - id: customer-analytics
    contract:
      path: contracts/customer-analytics.avro
      name: Customer analytics contract
      type: avro
---

badges​

  • Type: array

Badges rendered on the data product page.

Example
---
badges:
  - content: Certified
    backgroundColor: green
    textColor: green
---

repository​

  • Type: object

Repository metadata for the data product.

Example
---
repository:
  language: SQL
  url: https://github.com/acme/customer-analytics
---

diagrams​

  • Type: array

Diagrams associated with the data product.

Example
---
diagrams:
  - id: customer-analytics-lineage
    version: 1.0.0
---

attachments​

  • Type: array

External links or supporting documents attached to the data product.

Example
---
attachments:
  - title: Data contract review
    url: https://docs.example.com/customer-analytics
    type: document
---

Output contracts​

Outputs can include a contract that describes the data product output.

---
outputs:
  - id: customer-analytics
    contract:
      path: contracts/customer-analytics.avro
      name: Customer analytics contract
      type: avro
---

Custom properties​

You can add organization-specific metadata to this resource using frontmatter fields prefixed with x-. Learn how to define, render, and reference them in Custom properties on resources.