DOCUMENTATION / RULE REFERENCE

Response property becomes optional or nullable.

By Soumik Ghosh · Published 3 November 2026

The revised response can omit a previously required property or allow null where it was excluded. Existing consumers need to handle the wider set of responses.

Rule ID

response.now_optional_or_nullable

Direction

response

Classification

Breaking

What does a minimal example look like?

These are illustrative JSON Schemas for the changed constraint, not a captured vendor release. The rule ID applies to detector findings with the relevant direction and policy context.

Before

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ]
}

After

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  }
}

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.