# OpenAPI Compatibility Audit

> OpenAPI Compatibility Audit is a paid API for AI agents from rooke-token-risk-pilot.rookepoole.workers.dev, paid per call via x402, $3/call, status unknown (last checked 2026-10-12).

Compares two OpenAPI specifications (previous vs proposed) and detects breaking, non-breaking, and potentially breaking changes with a severity verdict and recommended version bump.

## Facts

- Endpoint: POST https://rooke-token-risk-pilot.rookepoole.workers.dev/v1/x402/openapi-compatibility-audit?utm_source=zero.xyz
- Price: $3/call
- Payment: x402
- Status: unknown
- Last checked: 2026-10-12
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/openapi-compatibility-audit-e7cf7ce6
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_7QWFoUyzzU-1wBZjnH18O

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability openapi-compatibility-audit-e7cf7ce6 -d '<json body>'
```

Example prompt: 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.

## When to prefer this

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.

## Known failure modes

- 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

## How this service works

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.

## Output

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.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "properties": {
  "previousSpec": {
   "type": "object",
   "propertyNames": {
    "type": "string"
   },
   "additionalProperties": {}
  },
  "proposedSpec": {
   "type": "object",
   "propertyNames": {
    "type": "string"
   },
   "additionalProperties": {}
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "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"
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/openapi-compatibility-audit-e7cf7ce6/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from rooke-token-risk-pilot.rookepoole.workers.dev](https://www.zero.xyz/host/rooke-token-risk-pilot.rookepoole.workers.dev/llms.txt)
