fix: Nullable header values

Author: dbanty

end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py

@@ -13,7 +13,7 @@ def _get_kwargs(
     *,
     string_param: Union[Unset, str] = UNSET,
     integer_param: Union[Unset, int] = 0,
-    header_param: Union[Unset, str] = UNSET,
+    header_param: Union[None, Unset, str] = UNSET,
     cookie_param: Union[Unset, str] = UNSET,
 ) -> Dict[str, Any]:
     headers = {}
@@ -66,7 +66,7 @@ def sync_detailed(
     client: Union[AuthenticatedClient, Client],
     string_param: Union[Unset, str] = UNSET,
     integer_param: Union[Unset, int] = 0,
-    header_param: Union[Unset, str] = UNSET,
+    header_param: Union[None, Unset, str] = UNSET,
     cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
@@ -75,7 +75,7 @@ def sync_detailed(
         path_param (str):
         string_param (Union[Unset, str]):
         integer_param (Union[Unset, int]):
-        header_param (Union[Unset, str]):
+        header_param (Union[None, Unset, str]):
         cookie_param (Union[Unset, str]):
 
     Raises:
@@ -107,7 +107,7 @@ async def asyncio_detailed(
     client: Union[AuthenticatedClient, Client],
     string_param: Union[Unset, str] = UNSET,
     integer_param: Union[Unset, int] = 0,
-    header_param: Union[Unset, str] = UNSET,
+    header_param: Union[None, Unset, str] = UNSET,
     cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
@@ -116,7 +116,7 @@ async def asyncio_detailed(
         path_param (str):
         string_param (Union[Unset, str]):
         integer_param (Union[Unset, int]):
-        header_param (Union[Unset, str]):
+        header_param (Union[None, Unset, str]):
         cookie_param (Union[Unset, str]):
 
     Raises:

end_to_end_tests/openapi_3.0.json

@@ -2364,7 +2364,8 @@
         "in": "header",
         "required": false,
         "schema": {
-          "type": "string"
+          "type": "string",
+          "nullable": true
         }
       },
       "cookie-param": {

end_to_end_tests/openapi_3.1.yaml

@@ -2420,7 +2420,10 @@ info:
       "in": "header",
       "required": false,
       "schema": {
-        "type": "string"
+        oneOf: [
+          type: "string",
+          type: "null",
+        ]
       }
     },
     "cookie-param": {

openapi_python_client/parser/properties/none.py

@@ -4,9 +4,10 @@
 
 from attr import define
 
-from ...utils import PythonIdentifier
-from ..errors import PropertyError
 from .protocol import PropertyProtocol, Value
+from ..errors import PropertyError
+from ... import schema as oai
+from ...utils import PythonIdentifier
 
 
 @define
@@ -20,6 +21,11 @@ class NoneProperty(PropertyProtocol):
     description: str | None
     example: str | None
 
+    _allowed_locations: ClassVar[set[oai.ParameterLocation]] = {
+        oai.ParameterLocation.QUERY,
+        oai.ParameterLocation.COOKIE,
+        oai.ParameterLocation.HEADER,
+    }
     _type_string: ClassVar[str] = "None"
     _json_type_string: ClassVar[str] = "None"
 

openapi_python_client/parser/properties/union.py

@@ -8,7 +8,7 @@
 from ... import Config
 from ... import schema as oai
 from ...utils import PythonIdentifier
-from ..errors import PropertyError
+from ..errors import PropertyError, ParseError
 from .protocol import PropertyProtocol, Value
 from .schemas import Schemas
 
@@ -169,3 +169,12 @@ def get_lazy_imports(self, *, prefix: str) -> set[str]:
         for inner_prop in self.inner_properties:
             lazy_imports.update(inner_prop.get_lazy_imports(prefix=prefix))
         return lazy_imports
+
+    def validate_location(self, location: oai.ParameterLocation) -> ParseError | None:
+        """Returns an error if this type of property is not allowed in the given location"""
+        for inner_prop in self.inner_properties:
+            if inner_prop.validate_location(location) is not None:
+                return ParseError(detail=f"{self.get_type_string()} is not allowed in {location}")
+        if location == oai.ParameterLocation.PATH and not self.required:
+            return ParseError(detail="Path parameter must be required")
+        return None