Skip to content

Add OpenAPI changelog tracking API evolution across releases #79

Description

@nanaf6203-bit

Area: API Documentation
Priority: P3 — Low

Description

API consumers need to understand what changed between releases. Without a changelog, breaking changes are discovered only after a production failure. Track OpenAPI deltas per release.

Acceptance Criteria

  • Generate docs/API_CHANGELOG.md from OpenAPI diffs between consecutive releases
  • Each release entry has Added / Changed / Deprecated / Removed / Fixed sections
  • Linked from Swagger UI banner when version != latest
  • Hooked into release-please workflow (auto-updated on each release)
  • First entry seeded manually for v0.1.0 documenting current state
  • CI job api-diff verifies non-backward-compatible changes are intentionally tagged

Technical Notes

  • Use openapi-diff to compute deltas
  • Each breaking change needs explicit confirmation in PR template

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaignP3Critical prioritydocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions