openai / openai/openai-openapi

WebSearchActionSearch.sources omits specialized api sources and their name field

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

Nobody has claimed this yet.

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

Description

Source reports

Current specification gap

Affected surface: POST /responses; WebSearchActionSearch.sources.items.

Two reports show a specialized weather source with type api and name oai-weather, without url. Current published sources.items permits only type url, requires url, and has no name.

Specification reviewed at b61ced9.

Minimal shape

{
  "name": "oai-weather",
  "type": "api"
}

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

Expected reconciliation

Represent specialized API sources alongside URL sources using their actual fields, so a name-bearing api source does not need a fabricated url.

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.

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 in openapi.yaml around the reviewed specification at line 67014 and inspect POST /responses, WebSearchActionSearch.sources.items. Compare the current URL-only shape with the reported sanitized api source containing name and no url. Done means the schema represents both URL sources and name-bearing specialized API sources without requiring a fabricated url.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.