Skip to content

chore(api): add OpenAPI diff tooling, API_CHANGELOG and CI job#86

Open
nanaabdul1172 wants to merge 3 commits into
StellarTips:mainfrom
nanaabdul1172:API-evolution
Open

chore(api): add OpenAPI diff tooling, API_CHANGELOG and CI job#86
nanaabdul1172 wants to merge 3 commits into
StellarTips:mainfrom
nanaabdul1172:API-evolution

Conversation

@nanaabdul1172

@nanaabdul1172 nanaabdul1172 commented Jun 19, 2026

Copy link
Copy Markdown

Closes #79
Adds OpenAPI diff tooling (openapi-diff), generator and changelog updater scripts, seeds docs/API_CHANGELOG.md, CI job to verify API diffs, and PR guidance for breaking changes.

Copy link
Copy Markdown
Contributor

Hey — the new API diff check is failing on this very PR. Probably a missing baseline or an undocumented breaking change. Can you dig into the API Diff job logs and either refresh the baseline or document the change in the PR body? Want to land this, just need the check green.

Copy link
Copy Markdown
Contributor

Requesting changes @nanaabdul1172 — only the API Diff check is failing (Build/Lint/TS/Unit/E2E are green). For #79, please either refresh the OpenAPI baseline in this PR or add an entry to docs/API_CHANGELOG.md documenting the breaking change, then re-run the diff job. Once it passes we can merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add OpenAPI changelog tracking API evolution across releases

2 participants