OpenAPI Breaking Change Monitor

Monitor public OpenAPI JSON or YAML specs for removed paths, removed operations, removed operation IDs, removed security schemes, and high-risk schema-surface drift.

This Actor is intentionally narrow. It is for developer-platform, API, SDK, customer-success, and agency teams that need scheduled breaking-change alerts for public API specs without building their own OpenAPI diff watcher.

Breaking rows include breakingSeverity, breakingTypes, breakingRiskScore, and changeSummary, so users can quickly see whether the alert is about removed paths, methods, operation IDs, security schemes, or multiple breaking surfaces.

Quick-start presets

Copy one of these small first-run inputs from examples/presets/:

• single-api-baseline-watch.json: create the first scheduled baseline for one public OpenAPI spec.
• competitor-api-drift-watch.json: monitor a small set of competitor or partner API specs for removed public surfaces.
• stripe-style-api-watch.json: monitor a vendor API compatibility surface before SDK, integration, or customer-success impact.

Each preset keeps maxSpecs at 3 or less and saves a snapshot so the next scheduled run can detect breaking drift without large first-run cost.

See MARKET_POSITIONING_2026-07-03.md for the current Store-research rationale: lead with low-support B2B API compatibility alerts rather than generic Swagger scraping.

Output

• Dataset rows: one row per checked OpenAPI spec.
• SUMMARY: checked specs, errors, alerts, severity counts, breaking alerts, and paid-event candidates.
• ALERTS: baseline and breaking rows.
• SURFACES: normalized current surface snapshots for future scheduled diffs.
• REPORT: Markdown digest focused on removed OpenAPI surfaces.

Monetization Notes

Keep the first release free or usage-cost-only. If organic scheduled usage appears, the cleanest PPE candidate is openapi-breaking-change-diff: charge only when a prior snapshot exists and the run detects removed paths, operations, operation IDs, or security schemes with buyer-visible severity and summary metadata.

Never charge for the first baseline snapshot, unchanged specs, invalid URLs, fetch errors, cosmetic metadata changes, or report generation alone.