{"uid":"cap_cemAJIs5Ij9Wkre18UZJx","slug":"migration-impact-d5d28500","name":"Migration Impact","description":"Decide whether a schema change is safe to ship, with evidence. Returns the compatibility verdict for your clients and, separately, how many of the real payloads you supply would newly be rejected, with the failing constraints ranked by how many payloads each costs. A breaking change nothing relies on is a different decision from one that rejects a tenth of your traffic.","url":"https://api.zfinia.com/x402/v1/json-schema-migration-impact?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","properties":{"role":{"enum":["producers","consumers","both"],"type":"string"},"after":{"type":"object"},"before":{"type":"object"},"documents":{"type":"array","items":{},"maxItems":500,"minItems":1}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.22","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.22/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.22","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.22","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_Zk0sJn_gv8xlgE03fgbU4","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.22","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Analyzes a JSON schema change and real payload samples to determine compatibility verdict and how many payloads would be rejected by the new schema, ranked by failing constraints.","exampleAgentPrompt":"I'm about to ship a JSON schema change — here's the before and after schema, plus 200 sample payloads from production traffic. Tell me if it's a breaking change for consumers and how many of those payloads would get rejected, ranked by which new constraint is causing the most failures.","exampleUseCases":[{"title":"Pre-deploy schema compatibility check","prompt":"We're adding three new required fields to our event schema. Here's the old schema, the new one, and 300 real event payloads from the past week — check if this is a breaking change for consumers and tell me how many of those payloads would be rejected and why."},{"title":"Ranking which constraint breaks the most traffic","prompt":"I made a schema change that tightens validation on our API — before I ship it, run it against these 500 sample payloads from our prod logs and tell me which specific constraints are rejecting the most payloads, ranked from worst to best."},{"title":"Evaluating a safe-looking schema tightening","prompt":"Our team wants to add an enum restriction to a field that currently accepts any string. Here's the before and after schema — can you check this change from both producer and consumer perspective and tell me how many of our actual payloads would fail with the new rule?"}],"resultDescription":"Returns a compatibility verdict indicating whether the schema change is breaking for producers, consumers, or both, along with a count of how many supplied sample payloads would be rejected under the new schema, and a ranked list of the specific failing constraints ordered by how many payloads each constraint rejects.","failureModes":["documents array empty or missing — requires at least 1 sample payload","before or after schema malformed — invalid JSON Schema object causes error","documents array exceeds 500 item limit — request rejected","role enum value not one of producers, consumers, both — validation error","schema objects reference external $refs that cannot be resolved — constraint analysis incomplete"],"whenToPreferThis":"Use this endpoint when you need evidence-based confidence before shipping a schema change — specifically when you have real payload samples and want to know both the compatibility verdict and the quantified impact on actual traffic. It goes beyond static schema diffing by running your real documents against the new schema, so it distinguishes a breaking change that affects zero current payloads from one that would reject 10% of your traffic. Prefer it over generic JSON Schema validators when migration risk quantification matters.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-11T18:37:54.963Z","isFirstParty":false,"canonicalSlug":"migration-impact-d5d28500"}