Skip to content

ci(openapi): add comprehensive OpenAPI contract testing and coverage checks#353

Merged
Pvsaint merged 1 commit intoMetroLogic:mainfrom
GideonBature:openapi
Mar 30, 2026
Merged

ci(openapi): add comprehensive OpenAPI contract testing and coverage checks#353
Pvsaint merged 1 commit intoMetroLogic:mainfrom
GideonBature:openapi

Conversation

@GideonBature
Copy link
Copy Markdown
Contributor

This PR:

  • Add OpenAPI spec validation script and integrate it into CI workflow
  • Add route documentation coverage checker to identify undocumented endpoints
  • Implement contract tests to validate API responses against OpenAPI schemas
  • Add breaking change detection script to detect incompatible changes
  • Update GitHub Actions workflow to include OpenAPI validation, coverage, contract tests
  • Add new npm scripts: validate:openapi, check:route-coverage, test:contract, detect-breaking-changes
  • Add dependencies: openapi-response-validator, openapi-types, @apidevtools/swagger-parser
  • Create detailed OpenAPI contract testing documentation and implementation summary
  • Ensure CI fails on OpenAPI issues, undocumented routes, contract test failures, breaking changes

Closes #315

…checks

- Add OpenAPI spec validation script and integrate it into CI workflow
- Add route documentation coverage checker to identify undocumented endpoints
- Implement contract tests to validate API responses against OpenAPI schemas
- Add breaking change detection script to detect incompatible changes
- Update GitHub Actions workflow to include OpenAPI validation, coverage, contract tests
- Add new npm scripts: validate:openapi, check:route-coverage, test:contract, detect-breaking-changes
- Add dependencies: openapi-response-validator, openapi-types, @apidevtools/swagger-parser
- Create detailed OpenAPI contract testing documentation and implementation summary
- Ensure CI fails on OpenAPI issues, undocumented routes, contract test failures, breaking changes
@drips-wave
Copy link
Copy Markdown

drips-wave bot commented Mar 30, 2026

@GideonBature Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Pvsaint Pvsaint merged commit 9f70931 into MetroLogic:main Mar 30, 2026
2 of 5 checks passed
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.

[Backend] Testing: OpenAPI contract tests (optional)

2 participants