Add PrefixItems to Schema Model for use with Tuple types (#197)

Author: JesseDeLoore

flask_openapi3/models/schema.py

@@ -39,6 +39,7 @@ class Schema(BaseModel):
     anyOf: Optional[List[Union[Reference, "Schema"]]] = None
     schema_not: Optional[Union[Reference, "Schema"]] = Field(default=None, alias="not")
     items: Optional[Union[Reference, "Schema"]] = None
+    prefixItems: Optional[List[Union[Reference, "Schema"]]] = None
     properties: Optional[Dict[str, Union[Reference, "Schema"]]] = None
     additionalProperties: Optional[Union[bool, Reference, "Schema"]] = None
     description: Optional[str] = None

tests/test_openapi.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Generic, TypeVar, List, Optional
+from typing import Generic, TypeVar, List, Optional, Tuple, Literal
 
 from pydantic import BaseModel, Field
 
@@ -543,3 +543,31 @@ def endpoint_test():
     data = test_app.api_doc["paths"]["/test"]["post"]
 
     assert "deprecated" not in data
+
+
+class TupleModel(BaseModel):
+    my_tuple: Tuple[Literal["a", "b"], Literal["c", "d"]]
+
+
+def test_prefix_items(request):
+    test_app = OpenAPI(request.node.name)
+    test_app.config["TESTING"] = True
+
+    @test_app.post("/test")
+    def endpoint_test(body: TupleModel):
+        print([])  # pragma: no cover
+
+    schema = test_app.api_doc["paths"]["/test"]["post"]["requestBody"]["content"]["application/json"]["schema"]
+    assert schema == {'$ref': '#/components/schemas/TupleModel'}
+    components = test_app.api_doc["components"]["schemas"]
+    assert components["TupleModel"] == {'properties': {'my_tuple': {'maxItems': 2,
+                             'minItems': 2,
+                             'prefixItems': [{'enum': ['a', 'b'],
+                                              'type': 'string'},
+                                             {'enum': ['c', 'd'],
+                                              'type': 'string'}],
+                             'title': 'My Tuple',
+                             'type': 'array'}},
+ 'required': ['my_tuple'],
+ 'title': 'TupleModel',
+ 'type': 'object'}