Rework _prepare_*_doc callbacks

Author: lafrech

flask_smorest/arguments.py

@@ -94,55 +94,54 @@ def wrapper(*f_args, **f_kwargs):
     def _prepare_arguments_doc(self, doc, doc_info, spec, **kwargs):
         # This callback should run first as it overrides existing parameters
         # in doc. Following callbacks should append to parameters list.
-        operation = doc_info.get('arguments', {})
-
-        parameters = [
-            p for p in operation.get('parameters', [])
-            if isinstance(p, abc.Mapping)
-        ]
-
-        # OAS 2
-        if spec.openapi_version.major < 3:
-            for param in parameters:
-                if param['in'] in (
-                        self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING
-                ):
-                    content_type = (
-                        param.pop('content_type', None) or
-                        self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING[
-                            param['in']]
-                    )
-                    if content_type != DEFAULT_REQUEST_BODY_CONTENT_TYPE:
-                        operation['consumes'] = [content_type, ]
-                    # body and formData are mutually exclusive
-                    break
-        # OAS 3
-        else:
-            for param in parameters:
-                if param['in'] in (
-                        self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING
-                ):
-                    request_body = {
-                        x: param[x]
-                        for x in ('description', 'required')
-                        if x in param
-                    }
-                    fields = {
-                        x: param.pop(x)
-                        for x in ('schema', 'example', 'examples')
-                        if x in param
-                    }
-                    content_type = (
-                        param.pop('content_type', None) or
-                        self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING[
-                            param['in']]
-                    )
-                    request_body['content'] = {content_type: fields}
-                    operation['requestBody'] = request_body
-                    # There can be only one requestBody
-                    operation['parameters'].remove(param)
-                    if not operation['parameters']:
-                        del operation['parameters']
-                    break
-        doc = deepupdate(doc, operation)
+        operation = doc_info.get('arguments')
+        if operation:
+            parameters = [
+                p for p in operation['parameters']
+                if isinstance(p, abc.Mapping)
+            ]
+            # OAS 2
+            if spec.openapi_version.major < 3:
+                for param in parameters:
+                    if param['in'] in (
+                            self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING
+                    ):
+                        content_type = (
+                            param.pop('content_type', None) or
+                            self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING[
+                                param['in']]
+                        )
+                        if content_type != DEFAULT_REQUEST_BODY_CONTENT_TYPE:
+                            operation['consumes'] = [content_type, ]
+                        # body and formData are mutually exclusive
+                        break
+            # OAS 3
+            else:
+                for param in parameters:
+                    if param['in'] in (
+                            self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING
+                    ):
+                        request_body = {
+                            x: param[x]
+                            for x in ('description', 'required')
+                            if x in param
+                        }
+                        fields = {
+                            x: param.pop(x)
+                            for x in ('schema', 'example', 'examples')
+                            if x in param
+                        }
+                        content_type = (
+                            param.pop('content_type', None) or
+                            self.DEFAULT_LOCATION_CONTENT_TYPE_MAPPING[
+                                param['in']]
+                        )
+                        request_body['content'] = {content_type: fields}
+                        operation['requestBody'] = request_body
+                        # There can be only one requestBody
+                        operation['parameters'].remove(param)
+                        if not operation['parameters']:
+                            del operation['parameters']
+                        break
+            doc = deepupdate(doc, operation)
         return doc

flask_smorest/pagination.py

@@ -288,10 +288,8 @@ def _document_pagination_metadata(self, spec, resp_doc):
     def _prepare_pagination_doc(self, doc, doc_info, spec, **kwargs):
         operation = doc_info.get('pagination')
         if operation:
-            parameters = operation.get('parameters')
-            doc.setdefault('parameters', []).append(parameters)
-            response = operation.get('response')
-            doc.setdefault('responses', {}).update(response)
+            doc.setdefault('parameters', []).append(operation['parameters'])
+            doc.setdefault('responses', {}).update(operation['response'])
             success_status_code = doc_info.get('success_status_code')
             if success_status_code is not None:
                 self._document_pagination_metadata(

flask_smorest/response.py

@@ -158,8 +158,9 @@ def _prepare_response_content(data):
 
     @staticmethod
     def _prepare_response_doc(doc, doc_info, spec, **kwargs):
-        operation = doc_info.get('response', {})
-        for response in operation.get('responses', {}).values():
-            prepare_response(response, spec, DEFAULT_RESPONSE_CONTENT_TYPE)
-        doc = deepupdate(doc, operation)
+        operation = doc_info.get('response')
+        if operation:
+            for response in operation['responses'].values():
+                prepare_response(response, spec, DEFAULT_RESPONSE_CONTENT_TYPE)
+            doc = deepupdate(doc, operation)
         return doc