Skip to content

Commit 1460145

Browse files
author
Genevieve Nuebel
committed
CHANGELOGs add breaking changes/api version notes
1 parent 2414cb5 commit 1460145

2 files changed

Lines changed: 34 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,25 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [3.0.0] - 2026-01-29 (v20250224 API)
8+
## [3.0.0] - 2026-01-29
9+
10+
### ⚠️ BREAKING CHANGES
11+
12+
This is a major version bump because it targets a new API version. If you are currently using `mx-platform-node@^2`, this is a new API version (`v20250224`) with potentially significant changes. **See the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for detailed API breaking changes and migration instructions.**
13+
14+
### Added
15+
- Initial support for MX Platform API `v20250224`
16+
- Published as separate major version to support independent API versions
917

1018
### Changed
11-
- Updated v20250224 API specification to most current version. Please check full [API changelog](https://docs.mx.com/resources/changelog/platform) for any changes.
19+
- This is a completely new API version (`v20250224`). Refer to the [MX Platform API changelog](https://docs.mx.com/resources/changelog/platform) for detailed API specification changes from `v20111101`
20+
21+
### Migration
22+
For upgrading from `mx-platform-node@^2` (v20111101 API) to v3.x (v20250224 API):
23+
```bash
24+
npm install mx-platform-node@^3
25+
```
26+
Consult the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for API-level changes, deprecations and migration steps.
1227

1328
## [2.0.0] - 2026-01-07 (v20111101 API)
1429

v20250224/CHANGELOG.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,25 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [3.0.0] - 2026-01-29 (v20250224 API)
8+
## [3.0.0] - 2026-01-29
9+
10+
### ⚠️ BREAKING CHANGES
11+
12+
This is a major version bump because it targets a new API version. If you are currently using `mx-platform-node@^2`, this is a new API version (`v20250224`) with potentially significant changes. **See the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for detailed API breaking changes and migration instructions.**
13+
14+
### Added
15+
- Initial support for MX Platform API `v20250224`
16+
- Published as separate major version to support independent API versions
917

1018
### Changed
11-
- Updated v20250224 API specification to most current version. Please check full [API changelog](https://docs.mx.com/resources/changelog/platform) for any changes.
19+
- This is a completely new API version (`v20250224`). Refer to the [MX Platform API changelog](https://docs.mx.com/resources/changelog/platform) for detailed API specification changes from `v20111101`
20+
21+
### Migration
22+
For upgrading from `mx-platform-node@^2` (v20111101 API) to v3.x (v20250224 API):
23+
```bash
24+
npm install mx-platform-node@^3
25+
```
26+
Consult the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for API-level changes, deprecations and migration steps.
1227

1328
## [2.0.0] - 2026-01-07 (v20111101 API)
1429

0 commit comments

Comments
 (0)