DOCUMENTATION / RULE REFERENCE

OpenAPI & JSON Schema Breaking Change: Request schema accepts fewer values

By Soumik Ghosh ยท Published

A validated counterexample passes the previous request schema and fails the revised one. Confirm the operation and locate callers that could send that value.

Rule ID
schema.request_acceptance_narrowed
Direction
request
Classification
Breaking

What does a minimal example look like?

These examples illustrate the rule with contract fragments or detector evidence. The rule ID applies to detector findings with the relevant direction and policy context.

Before

JSON
{
  "type": "integer",
  "minimum": 0
}

After

JSON
{
  "type": "integer",
  "minimum": 1
}

What should I check in my application?

Find the operation and affected field in the scanned commit. Confirm the server policy and application intent, inspect any missing coverage, then test the complete candidate. This rule alone does not prove repository impact, runtime failure, or a safe automatic fix.

Replay classifier inputs and policy choices or compare these schemas in both directions.

API compatibility guides and tools

Use public API change evidence in your IDE with MCP

Browse public API change history, including OpenAI and Sentry.

Rule reference