{"uid":"cap_R86nJobMzmRoO03WpcBjE","slug":"forest-web-openapi-breaking-change-detector-1b2ce218","name":"Forest Web: OpenAPI Breaking Change Detector","description":"Compare two public OpenAPI or Swagger contracts and determine whether the API update contains directly observable breaking compatibility changes. Detects removed operations, newly required request inputs, narrowed inline enums, removed content types or successful responses and tightened authentication; unsupported compatibility questions remain unknown. No API operation is executed. Base mainnet USDC","url":"https://http--forest-gas-station-mainnet--lcjl27p8lmjs.code.run/openapi/breaking-change?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","properties":{"after_url":{"type":"string","pattern":"^https?://","maxLength":2048,"minLength":1,"description":"Public after url value used to scope this lookup."},"before_url":{"type":"string","pattern":"^https?://","maxLength":2048,"minLength":1,"description":"Public before url value used to scope this lookup."}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.004","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.004/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.004","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.004","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_iU02UrnVLjZbGNHmc_FMH","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.004","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Compares two public OpenAPI/Swagger contracts (before and after URLs) to detect directly observable breaking compatibility changes such as removed operations, newly required fields, narrowed enums, removed content types, and tightened authentication.","exampleAgentPrompt":"Can you check whether the API update between https://api.example.com/v1/openapi.json (the old spec) and https://api.example.com/v2/openapi.json (the new spec) introduces any breaking changes for existing clients?","exampleUseCases":[{"title":"Pre-deployment API version safety check","prompt":"Before we roll out the new version of our payments API, can you compare https://pay.mycompany.com/v1/openapi.yaml (before) with https://pay.mycompany.com/v2/openapi.yaml (after) and tell me if any breaking changes would affect current integrations?"},{"title":"Third-party API upgrade risk assessment","prompt":"We depend on Stripe's API and they just released a new version — can you compare https://stripe.com/openapi/v1/spec.json with https://stripe.com/openapi/v2/spec.json and flag any breaking changes like removed endpoints or new required fields?"},{"title":"CI pipeline API contract regression check","prompt":"Our CI detected a change in the API spec — please compare https://staging.api.acme.com/old-spec.json against https://staging.api.acme.com/new-spec.json and check if there are any breaking changes such as removed operations, narrowed enums, or new required parameters."}],"resultDescription":"A structured report indicating whether breaking compatibility changes were detected between the two OpenAPI/Swagger contracts. Results include specific categories of breaking changes found: removed operations, newly required request inputs, narrowed inline enums, removed content types or successful responses, and tightened authentication requirements. Unsupported compatibility questions are reported as unknown rather than false negatives.","failureModes":["Unreachable or invalid URL for before_url or after_url returns an error","Non-OpenAPI/Swagger documents at the provided URLs result in a parse failure","Compatibility changes that are not directly observable in the contract (e.g. semantic behavior changes) are reported as unknown rather than detected","Private or auth-protected spec URLs cannot be fetched and will fail","Malformed JSON/YAML in the spec files causes a parsing error"],"whenToPreferThis":"Choose this endpoint when you need a fast, deterministic, read-only check for breaking changes between two publicly accessible OpenAPI or Swagger contract versions — especially in CI/CD pipelines, pre-deployment gates, or dependency upgrade workflows. It is ideal when you need to check specific observable breaking change categories (removed operations, newly required fields, narrowed enums, removed response types, tightened auth) without executing any actual API calls. Prefer this over manual diffs or general-purpose LLM analysis when you want structured, reliable detection of contract-level breaking changes at low cost.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-12T18:45:12.135Z","isFirstParty":false,"canonicalSlug":"forest-web-openapi-breaking-change-detector-1b2ce218"}