Merge branch 'auto-x-name' into 'master'

Add x-name on request bodies in manage.py generateschema instead of patch.py

See merge request !603

arkindex/project/openapi.py

@@ -68,6 +68,17 @@ class AutoSchema(BaseAutoSchema):
             }
         return schema
 
+    def _get_request_body(self, path, method):
+        """
+        Add x-name to requestBody objects to allow APIStar to use `body={}` arguments on requests
+        """
+        request_body = super()._get_request_body(path, method)
+        if not request_body:
+            return request_body
+        assert 'x-name' not in request_body
+        request_body['x-name'] = 'body'
+        return request_body
+
     def get_operation(self, path, method):
         operation = super().get_operation(path, method)
 

arkindex/project/tests/test_openapi.py

@@ -282,3 +282,62 @@ class TestOpenAPI(TestCase):
             },
             'required': ['my_field'],
         })
+
+    def test_request_body_apistar_compat(self):
+        """
+        Test x-name is added to requestBody to allow APIStar to use the request body as `body={}`
+        """
+
+        class ThingSerializer(serializers.Serializer):
+            my_field = serializers.CharField()
+
+        class ThingView(APIView):
+            serializer_class = ThingSerializer
+
+            def get_serializer(self):
+                return self.serializer_class()
+
+            def post(self, *args, **kwargs):
+                pass
+
+        inspector = AutoSchema()
+        inspector.view = create_view(ThingView, 'POST', create_request('/test/'))
+        self.assertDictEqual(
+            inspector.get_operation('/test/', 'POST'),
+            {
+                'operationId': 'CreateThing',
+                'parameters': [],
+                'requestBody': {
+                    'content': {
+                        'application/json': {
+                            'schema': {
+                                'properties': {
+                                    'my_field': {
+                                        'type': 'string',
+                                    },
+                                },
+                                'required': ['my_field']
+                            },
+                        },
+                    },
+                    'x-name': 'body',
+                },
+                'responses': {
+                    '200': {
+                        'content': {
+                            'application/json': {
+                                'schema': {
+                                    'properties': {
+                                        'my_field': {
+                                            'type': 'string',
+                                        },
+                                    },
+                                    'required': ['my_field']
+                                },
+                            },
+                        },
+                        'description': '',
+                    }
+                },
+            }
+        )

openapi/patch.py

@@ -86,22 +86,6 @@ def update_schema(schema, patches):
     schema.setdefault('info', {})
     schema['info']['version'] = ark_version
 
-    # Add x-name property on request body objects to let apistar register the parameters
-    for path, methods in schema['paths'].items():
-        for method, operation in methods.items():
-            if 'requestBody' not in operation:
-                continue
-            if not operation['requestBody']['content'].get('application/json', {}).get('schema'):
-                # Ignore empty schemas
-                continue
-
-            # Make sure we do not duplicate an existing parameter name
-            assert not any(param['name'] == 'body' for param in operation['parameters']), \
-                'Operation already has a body parameter'
-
-            print('Adding x-name to {} on {}'.format(method, path), file=sys.stderr)
-            operation['requestBody']['x-name'] = 'body'
-
     return schema
 
 

openapi/patch.yml

@@ -251,7 +251,6 @@ paths:
                   type: array
               required:
               - ids
-        x-name: body
       tags:
       - elements
   /api/v1/element/{child}/parent/{parent}/: