✨ Allow array values for OpenAPI schema `type` field (#13639)

Co-authored-by: Lukas Rajala <lukas.rajala@klarna.com>
Co-authored-by: dlax <denis@laxalde.org>
Co-authored-by: Motov Yurii <109919500+YuriiMotov@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

diff --git a/fastapi/openapi/models.py b/fastapi/openapi/models.py
index ed07b40f576109585f7e2b3f872edd90f718c320..81d276aed65fe7a9b059044279e5f43a3ec7eeed 100644 (file)
--- a/fastapi/openapi/models.py
+++ b/fastapi/openapi/models.py
@@ -121,6 +121,12 @@ class ExternalDocumentation(BaseModelWithConfig):
     url: AnyUrl
 
 
+# Ref JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation#name-type
+SchemaType = Literal[
+    "array", "boolean", "integer", "null", "number", "object", "string"
+]
+
+
 class Schema(BaseModelWithConfig):
     # Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-the-json-schema-core-vocabu
     # Core Vocabulary
@@ -145,7 +151,7 @@ class Schema(BaseModelWithConfig):
     dependentSchemas: Optional[Dict[str, "SchemaOrBool"]] = None
     prefixItems: Optional[List["SchemaOrBool"]] = None
     # TODO: uncomment and remove below when deprecating Pydantic v1
-    # It generales a list of schemas for tuples, before prefixItems was available
+    # It generates a list of schemas for tuples, before prefixItems was available
     # items: Optional["SchemaOrBool"] = None
     items: Optional[Union["SchemaOrBool", List["SchemaOrBool"]]] = None
     contains: Optional["SchemaOrBool"] = None
@@ -157,7 +163,7 @@ class Schema(BaseModelWithConfig):
     unevaluatedProperties: Optional["SchemaOrBool"] = None
     # Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-structural
     # A Vocabulary for Structural Validation
-    type: Optional[str] = None
+    type: Optional[Union[SchemaType, List[SchemaType]]] = None
     enum: Optional[List[Any]] = None
     const: Optional[Any] = None
     multipleOf: Optional[float] = Field(default=None, gt=0)

diff --git a/tests/test_custom_schema_fields.py b/tests/test_custom_schema_fields.py
index ee51fc7ff5e9b18737b9c40a55bc52106a2ed791..d890291b199a21c5ed36783e98807b1b02f3946b 100644 (file)
--- a/tests/test_custom_schema_fields.py
+++ b/tests/test_custom_schema_fields.py
@@ -1,7 +1,13 @@
+from typing import Optional
+
 from fastapi import FastAPI
 from fastapi._compat import PYDANTIC_V2
 from fastapi.testclient import TestClient
 from pydantic import BaseModel
+from typing_extensions import Annotated
+
+if PYDANTIC_V2:
+    from pydantic import WithJsonSchema
 
 app = FastAPI()
 
@@ -10,12 +16,17 @@ class Item(BaseModel):
     name: str
 
     if PYDANTIC_V2:
+        description: Annotated[
+            Optional[str], WithJsonSchema({"type": ["string", "null"]})
+        ] = None
+
         model_config = {
             "json_schema_extra": {
                 "x-something-internal": {"level": 4},
             }
         }
     else:
+        description: Optional[str] = None  # type: ignore[no-redef]
 
         class Config:
             schema_extra = {
@@ -42,7 +53,11 @@ item_schema = {
         "name": {
             "title": "Name",
             "type": "string",
-        }
+        },
+        "description": {
+            "title": "Description",
+            "type": ["string", "null"] if PYDANTIC_V2 else "string",
+        },
     },
 }
 
@@ -57,4 +72,4 @@ def test_response():
     # For coverage
     response = client.get("/foo")
     assert response.status_code == 200, response.text
-    assert response.json() == {"name": "Foo item"}
+    assert response.json() == {"name": "Foo item", "description": None}

diff --git a/tests/test_openapi_schema_type.py b/tests/test_openapi_schema_type.py
new file mode 100644 (file)
index 0000000..a45ea20
--- /dev/null
+++ b/tests/test_openapi_schema_type.py
@@ -0,0 +1,26 @@
+from typing import List, Optional, Union
+
+import pytest
+from fastapi.openapi.models import Schema, SchemaType
+
+
+@pytest.mark.parametrize(
+    "type_value",
+    [
+        "array",
+        ["string", "null"],
+        None,
+    ],
+)
+def test_allowed_schema_type(
+    type_value: Optional[Union[SchemaType, List[SchemaType]]],
+) -> None:
+    """Test that Schema accepts SchemaType, List[SchemaType] and None for type field."""
+    schema = Schema(type=type_value)
+    assert schema.type == type_value
+
+
+def test_invalid_type_value() -> None:
+    """Test that Schema raises ValueError for invalid type values."""
+    with pytest.raises(ValueError, match="2 validation errors for Schema"):
+        Schema(type=True)  # type: ignore[arg-type]