{"uid":"cap_7QWFoUyzzU-1wBZjnH18O","slug":"openapi-compatibility-audit-e7cf7ce6","name":"OpenAPI Compatibility Audit","description":"Public static preview plus paid token controls, risk consensus, AI security, webhook reliability, developer security, schedule risk, decision analysis, API release compatibility, accounts-payable reconciliation, e-commerce return eligibility, SaaS subscription-proration, sales-commission reconciliation, parcel-charge reconciliation, SLA service-credit reconciliation, advertising spend-and-fee audit, contract-renewal audit, workforce timecard reconciliation, hotel booking-commission reconciliation, and warehouse cycle-count adjustment reconciliation products for autonomous agents.","url":"https://rooke-token-risk-pilot.rookepoole.workers.dev/v1/x402/openapi-compatibility-audit?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","properties":{"previousSpec":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"proposedSpec":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}},"responseSchema":{"type":"json","example":{"changes":[{"ruleId":"PARAMETER_BECAME_REQUIRED","message":"Parameter header:x-client became required.","location":"/paths/~1orders/post/parameters/header:x-client","severity":"BREAKING"}],"summary":{"breaking":1,"truncated":false,"nonBreaking":0,"returnedChanges":1,"potentiallyBreaking":0},"verdict":"BREAKING_CHANGES_DETECTED","reportHash":"sha256-hex","evidenceGaps":["CALLBACKS_LINKS_WEBHOOKS_AND_ADVANCED_SCHEMA_COMPOSITION_NOT_EXHAUSTIVELY_ANALYZED"],"claimBoundary":{"referencesResolved":false,"deploymentPerformed":false,"upstreamRequestsMade":false,"sourceDocumentsModified":false,"runtimeClientCompatibilityGuaranteed":false,"deterministicStaticDocumentComparison":true},"schemaVersion":"OPENAPI_COMPATIBILITY_AUDIT_V1","recommendedVersionBump":"MAJOR"}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"3","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":"$3/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"3","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"3","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_Gt5l5Sjdex6Tk7zQE16bk","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"3","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Compares two OpenAPI specifications (previous vs proposed) and detects breaking, non-breaking, and potentially breaking changes with a severity verdict and recommended version bump.","exampleAgentPrompt":"Compare my current OpenAPI spec with the new proposed version and tell me if there are any breaking changes — I need to know if this requires a major version bump before I ship it.","exampleUseCases":[{"title":"Pre-release API breaking change check","prompt":"I'm about to release a new version of our REST API — can you compare the old spec and the new draft spec and tell me if anything is breaking for existing clients, and whether we need to bump to a major version?"},{"title":"CI gate for API compatibility","prompt":"As part of our CI pipeline, I need to check whether the proposed OpenAPI spec introduces any breaking changes compared to the current production spec — give me a verdict and a list of what changed."},{"title":"Audit API parameter changes for client teams","prompt":"Our backend team just updated the API spec and I need to know exactly which parameters became required or were removed compared to last month's spec, so I can warn the client teams before we deploy."}],"resultDescription":"Returns a list of detected changes with rule IDs, messages, affected locations, and severity levels; a summary with counts of breaking, non-breaking, and potentially breaking changes; an overall verdict (e.g. BREAKING_CHANGES_DETECTED); a recommended version bump (MAJOR, MINOR, or PATCH); a report hash for auditability; evidence gaps noting analysis limitations; and a claim boundary clarifying what the static analysis does and does not guarantee.","failureModes":["Malformed or invalid OpenAPI spec objects may cause parsing errors","Specs with unresolved $ref pointers may yield incomplete analysis (referencesResolved: false in claimBoundary)","Advanced schema composition, callbacks, links, and webhooks are not exhaustively analyzed (noted in evidenceGaps)","Missing or empty previousSpec/proposedSpec fields may return an error or empty diff","Runtime client compatibility is not guaranteed — only static document comparison is performed"],"whenToPreferThis":"Choose this endpoint when you need a deterministic, static diff of two OpenAPI specification documents to detect breaking changes before a release. It is ideal for CI/CD pipelines, pre-deployment audits, or any workflow where you need a machine-readable compatibility verdict and semver recommendation. Prefer it over manual diffing or generic JSON diff tools because it understands OpenAPI semantics (e.g. parameter requiredness, path changes) and categorizes changes by severity.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-12T18:38:19.057Z","isFirstParty":false,"canonicalSlug":"openapi-compatibility-audit-e7cf7ce6"}