DOCUMENTATION / API COMPATIBILITY

OpenAI OpenAPI breaking changes: a captured response change.

By Soumik Ghosh ยท Published

This report examines one captured OpenAI specification finding, not a live service incident or a scan of your application. The finding is classified as breaking by response.now_optional_or_nullable.

What changed in the captured specification?

the response property `output/items/oneOf[subschema #10: Web search tool call]/action/oneOf[subschema #3: Find action]/url` became optional for the status `200`

Operation
POST /responses/compact
Field
output/items/oneOf[subschema #10: Web search tool call]/action/oneOf[subschema #3: Find action]/url
Capture date (UTC)
Publisher version
2.3.0 to 2.3.0. An unchanged publisher version can still contain a changed contract.
Classifier version
2026-10-15.2

Which exact revisions were compared?

Previous specification SHA-256: 6192daf366457d9f11b03b342dd9ac12209a4fc5296c048ab457d35a31c85521

Revised specification SHA-256: 61c03019918d396837535eb923298aff0ec73f423436f3c3fd9bd3f8749fb516

Inspect the recorded release or read the public source finding. Capture dates identify evidence collection; they do not establish when a provider deployed behavior.

How could this affect an existing caller?

A consumer that assumes the find-action URL is always present now needs to handle the allowed missing-field response. Find the relevant field reads before deciding on fallback behavior.

if (typeof action.url === 'string') {
  inspectSearchUrl(action.url);
} else {
  handleMissingSearchUrl(action);
}

This handling pattern is illustrative. It is not a generated or tested patch for your application.

How do I check my TypeScript or Python integration?

  1. Confirm the operation and field used by your code against the captured revisions.
  2. Authorize the repositories you want analyzed and inspect supported SDK or HTTP call-site matches.
  3. Review uncertain patterns and select application behavior explicitly.
  4. Check the proposal's schema, type, configured runtime, and repository CI evidence before delivery.

Browse the OpenAI specification history, replay captured examples, or check supported coverage.

API compatibility guides and tools

Rule reference