Merge pull request #166 from zzz4zzz/fields2parameters_missing_default_in

Fix `default_in` error when location is not provided

Author: sloria

flask_apispec/apidoc.py

@@ -94,6 +94,8 @@ def get_parameters(self, rule, view, docs, parent=None):
             locations = options.pop('locations', None)
             if locations:
                 options['default_in'] = locations[0]
+            else:
+                options['default_in'] = 'body'
             extra_params += converter(schema, **options) if args else []
 
         rule_params = rule_to_params(rule, docs.get('params')) or []

tests/test_openapi.py

@@ -48,7 +48,6 @@ def test_error_if_spec_does_not_have_marshmallow_plugin(app):
     with pytest.raises(RuntimeError):
         ResourceConverter(app=app, spec=bad_spec)
 
-
 class TestFunctionView:
 
     @pytest.fixture
@@ -244,3 +243,80 @@ def test_params(self, app, path):
             }] + rule_to_params(rule)
         )
         assert params == expected
+
+
+class TestFiledsNoLocationProvided:
+
+    @pytest.fixture
+    def function_view(self, app):
+        @app.route('/bands/<int:band_id>/')
+        @use_kwargs({'name': fields.Str(), 'address': fields.Str()})
+        def get_band(**kwargs):
+            return kwargs
+
+        return get_band
+
+    @pytest.fixture
+    def path(self, app, spec, function_view):
+        converter = ViewConverter(app=app, spec=spec)
+        paths = converter.convert(function_view)
+        for path in paths:
+            spec.path(**path)
+        return spec._paths['/bands/{band_id}/']
+
+    def test_params(self, app, path):
+        params = path['get']['parameters']
+        rule = app.url_map._rules_by_endpoint['get_band'][0]
+        expected = (
+                [{
+                    'in': 'body',
+                    'name': 'body',
+                    'required': False,
+                    'schema': {
+                        'properties': {
+                            'address': {
+                                'type': 'string'
+                            },
+                            'name': {
+                                'type': 'string'
+                            }
+                        },
+                        'type': 'object'
+                    },
+                }] + rule_to_params(rule)
+        )
+        assert params == expected
+
+class TestSchemaNoLocationProvided:
+
+    @pytest.fixture
+    def function_view(self, app, models, schemas):
+        class BodySchema(Schema):
+            address = fields.Str()
+
+        @app.route('/bands/<int:band_id>/')
+        @use_kwargs(BodySchema)
+        def get_band(**kwargs):
+            return kwargs
+        return get_band
+
+    @pytest.fixture
+    def path(self, app, spec, function_view):
+        converter = ViewConverter(app=app, spec=spec)
+        paths = converter.convert(function_view)
+        for path in paths:
+            spec.path(**path)
+        return spec._paths['/bands/{band_id}/']
+
+    def test_params(self, app, path):
+        params = path['get']['parameters']
+        rule = app.url_map._rules_by_endpoint['get_band'][0]
+        expected = (
+                [{
+                    'in': 'body',
+                    'name': 'body',
+                    'required': False,
+                    'schema': {'$ref': '#/definitions/Body'}
+                }] + rule_to_params(rule)
+        )
+        assert params == expected