Skip to main content

Deprecating queries

Added in eventcatalog@2.33.10

Any resource in EventCatalog can be deprecated or marked as deprecated.

This will show a banner on the page indicating that the resource is deprecated.

Deprecating queries using frontmatter​

To deprecate a query you need to add the deprecated field to the query frontmatter API.

This accepts a boolean or an object with the following properties:

  • date: Date the query will be or was deprecated (YYYY-MM-DD)
  • message: Reason the query is deprecated, supports markdown (optional)
/queries/GetInventory/index.mdx (example)
---
id: GetInventory
... # other query frontmatter

# deprecated as an object (Recommended)
deprecated:
  # Date the query will be or was deprecated (YYYY-MM-DD)
  date: 2025-01-01
  # Reason the query is deprecated, supports markdown (optional)
  message: | 
    This query has been deprecated and replaced by the new query **GetInventoryV2**.
    Please contact the [team for more information](mailto:inventory-team@example.com) or visit our [website](https://eventcatalog.dev).

# deprecated as a boolean 
deprecated: true
---

Configuration:

  • deprecated: boolean or object

Deprecated as an object is recommended, as it gives your users more information to why the resource is deprecated and a date in the past or future.

  • deprecated.date: Date the query will be or was deprecated (YYYY-MM-DD)
  • deprecated.message: Reason the query is deprecated, supports markdown (optional)

Rendered output​

Example of resource that will be deprecated:

Deprecating queries

Example of resource that is deprecated:

Deprecating queries

Demo​

You can see a demo of deprecating resources in the EventCatalog demo site.