Add additional_properties to the v31 Schema

Author: RobertoPrevato

openapidocs/v31.py

@@ -282,6 +282,9 @@ class Schema(OpenAPIElement):
             A list of required property names.
         properties (Optional[Dict[str, Union["Schema", "Reference"]]]):
             A dictionary of property names to their schemas or references.
+        additional_properties (Union[None, bool, "Schema", "Reference"]):
+            Indicates whether additional properties are allowed. If a schema or reference
+            is provided, it defines the schema of the additional properties.
         default (Optional[Any]):
             The default value for the schema.
         deprecated (Optional[bool]):
@@ -329,6 +332,7 @@ class Schema(OpenAPIElement):
     format: Union[None, str, ValueFormat] = None
     required: Optional[List[str]] = None
     properties: Optional[Dict[str, Union["Schema", "Reference"]]] = None
+    additional_properties: Union[None, bool, "Schema", "Reference"] = None
     default: Optional[Any] = None
     deprecated: Optional[bool] = None
     example: Any = None

tests/test_v31.py

@@ -2074,6 +2074,49 @@ def json(self) -> str:
         """
 
 
+class ResponseExample2(TestItem):
+    def get_instance(self) -> Any:
+        return Response(
+            description="A simple string response",
+            content={
+                "text/plain": MediaType(
+                    schema=Schema(
+                        type="object",
+                        additional_properties=Schema(type="string"),
+                    )
+                )
+            },
+        )
+
+    def yaml(self) -> str:
+        return """
+        description: A simple string response
+        content:
+            text/plain:
+                schema:
+                    type: object
+                    additionalProperties:
+                        type: string
+        """
+
+    def json(self) -> str:
+        return """
+        {
+            "description": "A simple string response",
+            "content": {
+                "text/plain": {
+                    "schema": {
+                        "type": "object",
+                        "additionalProperties": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        }
+        """
+
+
 class RequestBodyExample1(TestItem):
     def get_instance(self) -> Any:
         return RequestBody(