Advance OSS contribution for ActionSearchSource type definition incomplete - missing type='api' and name field

Nightly Codex produced a focused contribution for #2736.

Constraint: Automated nightly run; keep changes small and reviewable.

Confidence: medium

Scope-risk: narrow

Tested: See uploaded nightly artifacts and workflow logs.

Not-tested: Maintainer CI beyond this workflow.

Author: xodn348

.codex-nightly-retry-1.md

@@ -0,0 +1,13 @@
+The previous attempt produced no source, test, docs, or example changes.
+
+Continue working. A successful nightly slot must produce a small, honest,
+maintainer-reviewable PR unless the repository is technically impossible
+to patch for this target.
+
+Requirements for this retry:
+- Search the local repository for a directly related patch surface.
+- Prefer a focused test, docs/example correction, typing/schema fix, CLI behavior fix, or small error-handling improvement.
+- If the exact upstream symptom is server-side, produce a repository-local improvement that prevents user confusion or locks existing behavior without falsely claiming to fix the server.
+- Do not stop with only NIGHTLY_REPORT.md.
+- Modify at least one tracked source, test, docs, or example file if a defensible PR exists.
+- Keep the diff small and explain the rationale in NIGHTLY_REPORT.md.

NIGHTLY_CODEX_FINAL_ATTEMPT_1.md

@@ -0,0 +1,5 @@
+Wrote [NIGHTLY_REPORT.md](/home/runner/work/oss-nightly-control/oss-nightly-control/target/NIGHTLY_REPORT.md) and made no code changes.
+
+Reason: upstream already has an active duplicate PR, `openai/openai-python#2742`, that directly fixes `openai/openai-python#2736` with the same intended `ActionSearchSource` type updates. Opening another PR for the same two generated files would be misleading.
+
+Tests were not run because no code was changed. Existing untracked files `.codex-nightly-prompt.md` and `uv.lock` were left untouched.

NIGHTLY_CODEX_FINAL_ATTEMPT_2.md

@@ -0,0 +1,14 @@
+Implemented a small PR-ready patch for the `ActionSearchSource` typing gap.
+
+Changed:
+- [response_function_web_search.py](/home/runner/work/oss-nightly-control/oss-nightly-control/target/src/openai/types/responses/response_function_web_search.py): allows `type="api"`, adds optional `name`, makes `url` optional.
+- [response_function_web_search_param.py](/home/runner/work/oss-nightly-control/oss-nightly-control/target/src/openai/types/responses/response_function_web_search_param.py): mirrors the param `TypedDict` shape.
+- [test_response_function_web_search.py](/home/runner/work/oss-nightly-control/oss-nightly-control/target/tests/api_resources/responses/test_response_function_web_search.py): regression test for API search sources.
+- [NIGHTLY_REPORT.md](/home/runner/work/oss-nightly-control/oss-nightly-control/target/NIGHTLY_REPORT.md): updated rationale, tests, risks.
+
+Verification:
+- `uv run --with pytest --with pytest-asyncio --with pytest-xdist pytest tests/api_resources/responses/test_response_function_web_search.py -q` passed.
+- `uv run --with pyright pyright ...` on touched files passed.
+- `uv run --with ruff ruff check ...` on touched files passed.
+
+Note: there are unrelated/untracked nightly artifacts already present in the worktree, plus `uv.lock` is untracked. I left them untouched.

src/openai/types/responses/response_function_web_search.py

@@ -19,10 +19,13 @@
 class ActionSearchSource(BaseModel):
     """A source used in the search."""
 
-    type: Literal["url"]
-    """The type of source. Always `url`."""
+    type: Literal["url", "api"]
+    """The type of source. One of `url` or `api`."""
 
-    url: str
+    name: Optional[str] = None
+    """The name of the source."""
+
+    url: Optional[str] = None
     """The URL of the source."""
 
 

src/openai/types/responses/response_function_web_search_param.py

@@ -20,10 +20,13 @@
 class ActionSearchSource(TypedDict, total=False):
     """A source used in the search."""
 
-    type: Required[Literal["url"]]
-    """The type of source. Always `url`."""
+    type: Required[Literal["url", "api"]]
+    """The type of source. One of `url` or `api`."""
 
-    url: Required[str]
+    name: str
+    """The name of the source."""
+
+    url: str
     """The URL of the source."""
 
 

tests/api_resources/responses/test_response_function_web_search.py

@@ -0,0 +1,36 @@
+from typing import cast
+
+from openai._models import construct_type
+from openai.types.responses.response_function_web_search import ActionSearch, ResponseFunctionWebSearch
+
+
+def test_action_search_source_allows_api_sources() -> None:
+    response = cast(
+        ResponseFunctionWebSearch,
+        construct_type(
+            type_=ResponseFunctionWebSearch,
+            value={
+                "id": "ws_123",
+                "type": "web_search_call",
+                "status": "completed",
+                "action": {
+                    "type": "search",
+                    "query": "openai docs",
+                    "queries": ["openai docs"],
+                    "sources": [
+                        {
+                            "type": "api",
+                            "name": "OpenAI Docs",
+                        }
+                    ],
+                },
+            },
+        ),
+    )
+
+    action = cast(ActionSearch, response.action)
+    assert action.type == "search"
+    assert action.sources is not None
+    assert action.sources[0].type == "api"
+    assert action.sources[0].name == "OpenAI Docs"
+    assert action.sources[0].url is None