Release Notes

A ReleaseNotes property references the versioned narrative account of what changed in each API release — what was added, what was fixed, and what developers need to know to upgrade. Release notes are distinct from a change log in that they are typically written for a human audience, focused on a specific version, and explain the why behind changes. Both are valuable for API consumers maintaining long-lived integrations.

Example

release-notes.yaml
- type: ReleaseNotes
  url: https://developers.example.com/releases

Tags

All Properties