Support: support@tinplate.dev · Zero-Retention Edge Security Support Trust Center DPA GitHub Issues
Developer Utilities Tier 3 All-Access

OpenAPI & JSON Schema Diff API — Catch Breaking API Changes in CI/CD

Diff two OpenAPI 3.x or JSON Schemas to catch breaking changes and recommend SemVer bumps. Compare two OpenAPI 3.x specs or JSON Schemas to detect breaking changes, removed endpoints, tightened required fields, and recommend a SemVer bump.

Interactive Sandbox · No API Key Required 200 OK · Ready
POST /v1/schema-diffinput
200 OK sample / live responsejson
{
  "ok": true,
  "data": {
    "compatible": false,
    "detected_mode": "json_schema",
    "breaking_count": 2,
    "non_breaking_count": 0,
    "changes": [
      {
        "path": "$.email",
        "kind": "required_field_added",
        "severity": "breaking",
        "message": "Field 'email' became required",
        "before": false,
        "after": true
      },
      {
        "path": "$.name",
        "kind": "property_removed",
        "severity": "breaking",
        "message": "Property 'name' was removed",
        "before": "name",
        "after": null
      }
    ]
  },
  "meta": {
    "request_id": "req_sd_01",
    "ms": 1
  }
}
OpenAPI 3.0.3 Get All-Access Key ($29/mo) No signup. No payload storage.
Quickstart Code Examples
curl -X POST "https://api.tinplate.dev/v1/schema-diff" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TINPLATE_KEY" \
  -d '{"mode":"json_schema","before":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"after":{"type":"object","required":["id","email"],"properties":{"id":{"type":"string"},"email":{"type":"string"}}}}'
import { TinplateClient } from "@tinplate/sdk";

const tinplate = new TinplateClient({
  apiKey: process.env.TINPLATE_API_KEY!,
});

const { data, meta } = await tinplate.call("/v1/schema-diff", {
  "mode": "json_schema",
  "before": {
    "type": "object",
    "required": [
      "id"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    }
  },
  "after": {
    "type": "object",
    "required": [
      "id",
      "email"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "email": {
        "type": "string"
      }
    }
  }
});
console.log(`[${meta.ms} ms]`, data);
import requests

response = requests.post(
    "https://api.tinplate.dev/v1/schema-diff",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer YOUR_TINPLATE_KEY",
    },
    json={
  "mode": "json_schema",
  "before": {
    "type": "object",
    "required": [
      "id"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    }
  },
  "after": {
    "type": "object",
    "required": [
      "id",
      "email"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "email": {
        "type": "string"
      }
    }
  }
}
)
print(response.json())
const response = await fetch("https://api.tinplate.dev/v1/schema-diff", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_TINPLATE_KEY",
  },
  body: JSON.stringify({
  "mode": "json_schema",
  "before": {
    "type": "object",
    "required": [
      "id"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    }
  },
  "after": {
    "type": "object",
    "required": [
      "id",
      "email"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "email": {
        "type": "string"
      }
    }
  }
}),
});
const result = await response.json();
console.log(result);
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tinplate_schema_diff",
    "arguments": {
      "mode": "json_schema",
      "before": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "after": {
        "type": "object",
        "required": [
          "id",
          "email"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      }
    }
  }
}
OpenAPI 3.0.3 Schema Contract

Request Parameters & Response Schema Reference

Request Body Parameters (POST /v1/schema-diff)

ParameterType & ConstraintsDescription
before required object Previous JSON Schema or OpenAPI 3.x document.
after required object New JSON Schema or OpenAPI 3.x document.
mode optional "auto" | "json_schema" | "openapi" Comparison mode (auto detects OpenAPI when 'paths' and 'openapi' are present).

Response data Object Fields (200 OK)

FieldTypeDescription
compatible boolean Field 'compatible'
detected_mode "json_schema" | "openapi" Field 'detected_mode'
breaking_count integer Field 'breaking_count'
non_breaking_count integer Field 'non_breaking_count'
changes object[] Field 'changes'

What OpenAPI & JSON Schema Breaking-Change Diff API Detects & Validates

  • Diffs both standalone JSON Schemas and full OpenAPI 3.0/3.1 specifications
  • Flags breaking request changes: newly required fields, narrowed enums, tightened min/max constraints
  • Flags breaking response/endpoint changes: removed paths, removed HTTP methods, removed response properties, type changes
  • Recommends exact SemVer bump (major, minor, patch, none) and generates a Markdown changelog snippet
Honest Engineering Boundaries

Known Limitations & Test Verification

Release: v1.0.39 · Verified: 16 November 2026 · Portfolio Median: 0.318 ms in-Worker V8 compute (add 15–65 ms HTTPS RTT) · See Full Portfolio Benchmarks →

  • Resolves internal local $ref pointers (#/components/schemas/...); external remote URL $refs must be bundled prior to diffing.
  • Tested v1.0.4 (14 November 2026).

Direct All-Access & Marketplace Plans

Direct Polar All-Access Keys unlock all 42 APIs (49 endpoints), /v1/pipeline, and /mcp on api.tinplate.dev: Pro ($29/mo · 120 req/min · 100k/mo · 128 KB) or Team ($79/mo · 300 req/min · 500k/mo · 256 KB).

PlanMonthly PriceIncluded RequestsRate LimitMax PayloadBest For
BASIC$0.00 / mo500 / month10 req / min64 KBEvaluation & CI smoke tests
PRO$9.99 / mo15,000 / month60 req / min128 KBSolo devs & production apps
ULTRA$29.99 / mo100,000 / month300 req / min256 KBGrowing SaaS & multi-agent pipelines
MEGA$79.99 / mo500,000 / month1,000 req / min256 KBHigh-volume enterprise workloads

Frequently Asked Questions

Can I gate pull requests in GitHub Actions with this API?

Yes—send your main branch OpenAPI JSON as before and the PR branch OpenAPI JSON as after, and fail CI if breaking: true.

Does it distinguish request vs response directionality in OpenAPI?

Yes: adding a required property to a request body is breaking, while adding a new property to a response body is non-breaking (minor).

Are local $ref references resolved?

Yes, local #/components/schemas/... and #/$defs/... pointers are resolved automatically.

Zero Payload Logging

Data Handling, Privacy & Proxy Disclosure

Stateless in-memory schema comparison; specs are never stored.

Worker Zero-Logging Guarantee: Cloudflare Workers Observability and invocation logging are disabled (observability.enabled = false, head_sampling_rate = 0, invocation_logs = false). Requests via RapidAPI or Zyla traverse marketplace proxies; use a Direct Bearer Key for zero-intermediary routing.

Related Tinplate APIs

POST /v1/semver-lockfile-judge Developer Utilities

SemVer & Package Manifest / Lockfile Diff Judge API

Diff two package.json files to flag breaking SemVer bumps and risky dependency changes.

POST /v1/tool-call-validator AI Safety & Agents

Agent Tool-Call Validator & Repairer API

Validate and auto-repair broken LLM tool-call arguments against your JSON Schema.

POST /v1/json-heal Live

Broken JSON & LLM Output Healer API

Repair malformed or truncated LLM JSON outputs into valid, schema-checked JSON in 1 ms.