openai / openai/openai-openapi

Reconcile find_in_page URL presence across API responses and SDK validation

Open
#571 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug specification
Dominant language
No language data
Stars
2.5k
Forks
527
Avg merge
1h 46m
Merged PRs (30d)
2

Description

Source reports

Reported API/SDK contract mismatch

Affected surface: POST /responses; WebSearchActionFind.

The source report describes a completed find_in_page item with pattern but no url, followed by strict validation failure when restoring saved Agents state. Its local reproduction supplies a dictionary; it does not include a complete raw HTTP/SSE capture that identifies where the URL was lost. The current public schema lists url in required. This is distinct from the corrected find/find_in_page discriminator in closed #512.

Specification reviewed at b61ced9.

Minimal shape

{
  "type": "find_in_page",
  "pattern": "og:image"
}

This is a sanitized illustration of the reported shape, not a new live API capture.

Expected reconciliation

Determine whether a producer or serialization step loses a required URL, or whether the supported find_in_page contract permits omission. The original report allows either a server correction that always provides the URL or a deliberate SDK/schema change. Compare the raw response, SDK item and saved/restored state before choosing the repair. Treat omission and explicit JSON null separately, and preserve the valid discriminator fix.

Verification scope

Reviewed the source reports, relevant comments, and current published schema. No new live API request was made. This tracks the reported contract mismatch and preserves the original reproduction; it does not establish the deployed root cause or claim that a fix has shipped.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the source report and openapi.yaml at the referenced schema location, then compare the reported API response, SDK item, and saved/restored state for POST /responses and WebSearchActionFind. Determine whether omission or explicit JSON null is involved and whether the required URL is lost during production or serialization. Done means the supported contract and schema behavior are reconciled while preserving the corrected find/find_in_page discriminator.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, backend-api-design
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.