The full changelog for the API is available in the Changelog section. This document outlines the conventions used in the changelogs.

​
Versioning

The API follows Semantic Versioning principles. Each version number consists of three parts: MAJOR.MINOR.PATCH.

  • MAJOR: Incremented for incompatible API changes.
  • MINOR: Incremented for new features that are backward-compatible.
  • PATCH: Incremented for backward-compatible bug fixes.
  • Pre-release versions: Indicated by appending a hyphen and an identifier (e.g., 1.0.0-alpha).

Note: Pre-release versions are made available for testing in the Sandbox environment only and will be removed from the changelog once the final release versions are published.

​
Changelog Format

Each entry in the changelog follows a consistent format:

  • Version: The version number of the API.
  • Date: The release date of the version.
  • Breaking Changes: Changes that may require modifications to existing implementations.
  • Added: New features or enhancements.
  • Changed: Modifications to existing features or behavior.
  • Fixed: Bug fixes and improvements.
  • Security: Vulnerabilities that have been addressed.
  • Deprecated: Features that are no longer recommended for use and may be removed in future versions.
  • Removed: Features that have been removed from the API.
  • Note: Important information or clarifications related to the changes.