{"uid":"cap_YP7fKShggQIfKajktkFJE","slug":"openapi-change-report-breaking-change-detector-69f83169","name":"OpenAPI Change Report – Breaking Change Detector","description":"Audit one public site or compare up to five domains across llms.txt, OpenAPI, robots, sitemap, x402 metadata, and the discovery surfaces autonomous buyers rely on.","url":"https://ai-data-marketplace-1042299154756.us-central1.run.app/api/v1/openapi_change_report","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET"],"type":"string"},"queryParams":{"type":"object","required":["before","after"],"properties":{"after":{"type":"object","description":"Proposed inline OpenAPI JSON object, up to 500 KB. Local # references are allowed; external references are rejected."},"before":{"type":"object","description":"Original inline OpenAPI JSON object, up to 500 KB. Local # references are allowed; external references are rejected."}},"additionalProperties":true}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object","required":["success","total_changes","breaking_changes","has_breaking_changes","changes"],"properties":{"changes":{"type":"array","items":{"type":"object","required":["breaking","changeText","property"],"properties":{"breaking":{"type":"boolean"},"property":{"type":"string"},"changeText":{"type":"string"}},"additionalProperties":true}},"success":{"type":"boolean"},"total_changes":{"type":"integer"},"breaking_changes":{"type":"integer"},"has_breaking_changes":{"type":"boolean"}},"additionalProperties":true}}}}},"responseSchema":{"type":"json","example":{"changes":[{"breaking":true,"property":"/users","changeText":"object_removed"}],"success":true,"total_changes":2,"breaking_changes":1,"has_breaking_changes":true}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.01","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.01/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_wEAomcutQYMjdJXrOoVuW","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.01","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 (before and after) and returns a structured diff highlighting breaking and non-breaking changes.","exampleAgentPrompt":"Compare these two OpenAPI specs and tell me which changes are breaking — here's the original spec and here's the updated one I'm about to deploy.","exampleUseCases":[{"title":"Pre-deployment breaking change check","prompt":"I'm about to deploy a new version of my API. Here's the current OpenAPI JSON and here's the proposed new one — can you compare them and flag any breaking changes before I push to production?"},{"title":"API versioning audit for client teams","prompt":"We updated our REST API and need to tell client teams what broke. Compare the old OpenAPI spec and the new one and give me a list of every breaking change with the property path and what changed."},{"title":"CI/CD gate for API compatibility","prompt":"I want to make sure this pull request doesn't introduce breaking API changes — can you diff the before and after OpenAPI specs and tell me if has_breaking_changes is true?"}],"resultDescription":"Returns a JSON object with a success boolean, total_changes integer, breaking_changes integer, has_breaking_changes boolean, and a changes array where each item includes the affected property path, a changeText describing what changed (e.g. 'object_removed'), and a breaking boolean indicating severity.","failureModes":["Invalid or non-parseable OpenAPI JSON in before or after fields returns an error","External $ref references in the OpenAPI spec are rejected — only local # references are allowed","OpenAPI objects exceeding 500 KB are rejected","Missing required before or after query parameters returns a validation error","Malformed JSON structure that doesn't conform to OpenAPI schema may produce incomplete diff results"],"whenToPreferThis":"Use this endpoint when you need a structured, machine-readable diff between two OpenAPI specification versions — especially to programmatically detect breaking changes in a CI/CD pipeline, pre-deployment review, or client communication workflow. Prefer this over manual diffing or generic JSON diff tools when you need breaking-change semantics (not just structural differences) and a per-property breakdown of what changed and why it matters.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-14T12:43:27.818Z","isFirstParty":false}