Overview
- Bug Type:
- Stale OpenAPI/TypeScript declarations
- Category:
- Interface & Contract
Definition
API/type declarations are out of sync with implementation, leading to integration failures.
How to fix Stale OpenAPI/TypeScript declarations?
Automate spec-to-code generation; add contract tests; run schema diff in CI; version APIs; communicate breaking changes with deprecation windows
Symptoms
Observable signs that may indicate Stale OpenAPI/TypeScript declarations:
- Client fails parsing responses due to missing/renamed fields.
- Builds succeed but integration tests fail after API rollout.
- Contract tests or schema diffs show breaking changes.
Example Errors:
- Unknown field 'foo' in response
- HTTP 400: required parameter missing
- TS2339: Property 'bar' does not exist on type 'Baz'