APIFlask 2.3.0__tar.gz → 2.3.1__tar.gz

{apiflask-2.3.0 → apiflask-2.3.1}/CHANGES.md

@@ -1,3 +1,12 @@
+## Version 2.3.1
+
+Released: 2024/12/7
+
+- Include input documentation in API spec when specifying `validation=False` on `@input` decorator  ([issue #626][issue_626]).
+
+[issue_626]: https://github.com/apiflask/apiflask/issues/626
+
+
 ## Version 2.3.0
 
 Released: 2024/11/25

{apiflask-2.3.0 → apiflask-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.3.0
+Version: 2.3.1
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT

{apiflask-2.3.0 → apiflask-2.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ description = "A lightweight web API framework based on Flask and marshmallow-co
 readme = "README.md"
 license = { text = "MIT" }
 authors = [{ name = "Grey Li", email = "withlihui@gmail.com" }]
-version = "2.3.0"
+version = "2.3.1"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Web Environment",

{apiflask-2.3.0 → apiflask-2.3.1}/src/APIFlask.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.3.0
+Version: 2.3.1
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT

{apiflask-2.3.0 → apiflask-2.3.1}/src/apiflask/scaffold.py

@@ -338,16 +338,6 @@ class APIScaffold:
         def decorator(f):
             f = _ensure_sync(f)
 
-            if not validation:
-
-                @wraps(f)
-                def wrapper(*args: t.Any, **kwargs: t.Any):
-                    raw_data = _load_raw_data(location)
-                    kwargs[f'{location}_data'] = raw_data
-                    return f(*args, **kwargs)
-
-                return wrapper
-
             is_body_location = location in BODY_LOCATIONS
             if is_body_location and hasattr(f, '_spec') and 'body' in f._spec:
                 raise RuntimeError(
@@ -394,6 +384,17 @@ class APIScaffold:
                     _annotate(f, omit_default_path_parameters=True)
                 # TODO: Support set example for request parameters
                 f._spec['args'].append((schema, location))
+
+            if not validation:
+
+                @wraps(f)
+                def wrapper(*args: t.Any, **kwargs: t.Any):
+                    raw_data = _load_raw_data(location)
+                    kwargs[f'{location}_data'] = raw_data
+                    return f(*args, **kwargs)
+
+                return wrapper
+
             return use_args(
                 schema, location=location, arg_name=arg_name or f'{location}_data', **kwargs
             )(f)

{apiflask-2.3.0 → apiflask-2.3.1}/tests/test_decorator_input.py

@@ -435,6 +435,16 @@ def test_skip_validation(app, client):
     assert no_validated_rv.json['json_data']['name'] == 'Kitty'
     assert no_validated_rv.json['json_data']['category'] == 'unknown'
 
+    rv = client.get('/openapi.json')
+    assert rv.status_code == 200
+    assert (
+        rv.json['paths']['/pets_without_validation/{pet_id}']['patch']['requestBody']['content'][
+            'application/json'
+        ]['schema']['$ref']
+        == '#/components/schemas/PetIn'
+    )
+    assert 'PetIn' in rv.json['components']['schemas']
+
 
 def test_location_raw_data(app):
     from apiflask.scaffold import _load_raw_data