# Changelogs reference

Copy as Markdown[View as Markdown](/docs/development/guides/changelogs/reference.md)

***

This page lists the fields and paths supported by changelogs.

## Paths[​](#paths "Direct link to Paths")

Changelogs can be created for versioned resources using `changelog.md` or `changelog.mdx`.

```
/{collection}/{Resource Name}/versioned/{version}/changelog.mdx
```

For example:

```
/services/PaymentService/versioned/1.0.0/changelog.mdx
/domains/Payments/versioned/1.0.0/changelog.mdx
```

## Optional fields[​](#optional-fields "Direct link to Optional fields")

### `createdAt`[​](#createdAt "Direct link to createdAt")

* Type: `date`

Date the changelog entry was created.

Example

```
---
createdAt: 2026-05-26
---
```

### `badges`[​](#badges "Direct link to badges")

* Type: `array`

Badge metadata for the changelog entry.

Example

```
---
badges:
  - content: Breaking change
    backgroundColor: red
    textColor: red
---
```

## Badge fields[​](#badge-fields "Direct link to Badge fields")

| Field             | Type     | Description             |
| ----------------- | -------- | ----------------------- |
| `content`         | `string` | Badge text.             |
| `backgroundColor` | `string` | Badge background color. |
| `textColor`       | `string` | Badge text color.       |
| `icon`            | `string` | Optional icon.          |

## Example[​](#example "Direct link to Example")

```
---
createdAt: 2026-05-26
badges:
  - content: Breaking change
    backgroundColor: red
    textColor: red
---

Updated the payment authorization event contract.
```