fix(types): allow missing find-in-page URLs

Author: Hughhhhcoder

api_reference/openapi.transformed.yml

@@ -60845,7 +60845,6 @@ components:
             The pattern or text to search for within the page.
       required:
       - type
-      - url
       - pattern
     WebSearchActionOpenPage:
       type: object
@@ -72435,7 +72434,6 @@ components:
             The pattern or text to search for within the page.
       required:
       - type
-      - url
       - pattern
     BetaWebSearchActionOpenPage:
       type: object

src/openai/types/beta/beta_response_function_web_search.py

@@ -62,7 +62,7 @@ class ActionFindInPage(BaseModel):
     type: Literal["find_in_page"]
     """The action type."""
 
-    url: str
+    url: Optional[str] = None
     """The URL of the page searched for the pattern."""
 
 

src/openai/types/beta/beta_response_function_web_search_param.py

@@ -63,7 +63,7 @@ class ActionFindInPage(TypedDict, total=False):
     type: Required[Literal["find_in_page"]]
     """The action type."""
 
-    url: Required[str]
+    url: str
     """The URL of the page searched for the pattern."""
 
 

src/openai/types/responses/response_function_web_search.py

@@ -61,7 +61,7 @@ class ActionFind(BaseModel):
     type: Literal["find_in_page"]
     """The action type."""
 
-    url: str
+    url: Optional[str] = None
     """The URL of the page searched for the pattern."""
 
 

src/openai/types/responses/response_function_web_search_param.py

@@ -62,7 +62,7 @@ class ActionFind(TypedDict, total=False):
     type: Required[Literal["find_in_page"]]
     """The action type."""
 
-    url: Required[str]
+    url: str
     """The URL of the page searched for the pattern."""
 
 

tests/lib/responses/test_responses.py

@@ -9,8 +9,9 @@
 from tests.respx2 import MockRouter
 from openai._types import omit
 from openai._utils import assert_signatures_in_sync
-from openai._models import construct_type_unchecked
-from openai.types.responses import Response
+from openai._models import BaseModel, construct_type_unchecked
+from openai.types.beta import BetaResponseFunctionWebSearch
+from openai.types.responses import Response, ResponseFunctionWebSearch
 from openai.lib._parsing._responses import parse_response
 
 from ...conftest import base_url
@@ -72,6 +73,25 @@ def test_parse_response_preserves_program_items(item: dict[str, object]) -> None
     assert parsed.output[0].to_dict() == item
 
 
+@pytest.mark.parametrize(
+    "response_model",
+    [ResponseFunctionWebSearch, BetaResponseFunctionWebSearch],
+    ids=["responses", "beta"],
+)
+def test_find_in_page_action_allows_missing_url(response_model: type[BaseModel]) -> None:
+    response = response_model.model_validate(
+        {
+            "id": "ws_redacted",
+            "type": "web_search_call",
+            "status": "completed",
+            "action": {"type": "find_in_page", "pattern": "og:image"},
+        }
+    )
+
+    assert response.action.type == "find_in_page"
+    assert getattr(response.action, "url", None) is None
+
+
 @pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"])
 def test_stream_method_definition_in_sync(sync: bool, client: OpenAI, async_client: AsyncOpenAI) -> None:
     checking_client: OpenAI | AsyncOpenAI = client if sync else async_client