OpenAPI 3.1.0 Documentation Generation

flask_parameter_validation/exceptions/exceptions.py

@@ -24,5 +24,15 @@ def __init__(self, error_string, input_name, input_type):
         )
         super().__init__(error_string, input_name, input_type)
 
+    def __str__(self):
+        return self.message
+
+class ConfigurationError(Exception):
+    """Called if app configuration is invalid"""
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(message)
+
     def __str__(self):
         return self.message

flask_parameter_validation/parameter_types/parameter.py

@@ -98,6 +98,7 @@ def validate(self, value):
                 except JSONSchemaValidationError as e:
                     raise ValueError(f"failed JSON Schema validation: {e.args[0]}")
         elif type(value) is dict:
+            # TODO: Make json_schema work for all parameters besides FileStorage and datetime.*? Or maybe even datetime.*?
             if self.json_schema is not None:
                 try:
                     jsonschema.validate(value, self.json_schema)

flask_parameter_validation/parameter_validation.py

@@ -35,8 +35,9 @@ class ValidateParameters:
     def get_fn_list(cls):
         return fn_list
 
-    def __init__(self, error_handler=None):
+    def __init__(self, error_handler=None, openapi_responses=None):
         self.custom_error_handler = error_handler
+        self.openapi_responses = openapi_responses
 
     def __call__(self, f):
         """
@@ -59,6 +60,7 @@ def __call__(self, f):
             "argspec": argspec,
             "docstring": f.__doc__.strip() if f.__doc__ else None,
             "decorators": decorators.copy(),
+            "openapi_responses": self.openapi_responses,
         }
         fn_list[fsig] = fdocs
 

flask_parameter_validation/test/enums.py

@@ -2,10 +2,18 @@
 
 
 class Fruits(str, Enum):
-    APPLE = "apple"
-    ORANGE = "orange"
+    """
+    Possible fruits
+    """
+
+    APPLE = "apple"  # An apple a day keeps the doctor away, so they say
+    ORANGE = "orange"  # Oranges contain vitamin C, which might also keep the doctor away
 
 
 class Binary(int, Enum):
-    ZERO = 0
-    ONE = 1
+    """
+    Possible binary values
+    """
+
+    ZERO = 0  # Logic level low
+    ONE = 1  # Logic level high