WebSearchToolCall incorrectly requires an action on every returned item

Open Beginner friendly
#572 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
openapi
Domain
api

Research direction

Start in openapi.yaml near line 67210, reviewing the WebSearchToolCall.action schema and the linked source reports. Reconcile the schema with completed web_search_call objects where action is omitted, and separately verify the intended JSON-null behavior without relying on Python None; done means the published schema reflects both decisions.

Written by the indexing model from the issue text.

Description

bug specification

Source reports

Current specification gap

Affected surface: POST /responses; WebSearchToolCall.action.

The Python report observes completed web_search_call objects with action=None. That SDK representation alone does not distinguish omission from JSON null. The current public schema requires action on every item. Please reconcile requiredness with completed items whose action is absent, and verify JSON-null behavior separately.

Specification reviewed at b61ced9.

Expected reconciliation

Make action optional where the API omits it. Determine JSON-null behavior separately; do not infer it solely from a Python None representation.

Verification scope

Reviewed the source reports, relevant comments, and current published schema. No new live API request was made. This mirrors the specification gap and preserves the original reproduction; it does not claim that a fix has shipped.

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

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.

More from openai/openai-openapi

All issues in openai/openai-openapi

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.