Question
OpenAPI Spec ↔ Swagger UI: What rules should govern alert generation to avoid noise?
Tasadduq BurneyownerOwner · Founder
28K reputation · 14 Feb 2023, 19:19 UTC
69.6K views0
Goal
We want to generate alerts only for meaningful changes in an OpenAPI 3.1 spec while keeping Swagger UI documentation in sync, without drowning developers in noise.
Constraints & Uncertainty
- Diff engines often flag non‑breaking edits such as reordered parameters, description changes, or added optional fields.
- Vendor extensions (x‑*) lack a formal breaking‑vs‑non‑breaking hierarchy in the spec, leading to inconsistent tooling behavior.
- Tooling support for the newest JSON Schema features in OpenAPI 3.1 is still evolving.
Unresolved Questions
- Which change types involving vendor extensions should be treated as breaking to trigger alerts?
- How can we configure a rule set (e.g., Spectral, OpenAPI‑Diff) to suppress non‑breaking changes while still catching real contract breaks?
- What policy format can teams agree on to maintain consistency across multiple repositories and CI pipelines?