Compatibility with apispec 3.0 and drops support of <3.0. Closes #63

maximdanilchenko · Sep 23, 2019 · 4e76b52 · 4e76b52
1 parent 6c0d081
commit 4e76b52
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/aiohttp_apispec/aiohttp_apispec.py b/aiohttp_apispec/aiohttp_apispec.py
@@ -14,7 +14,7 @@
 
 _AiohttpView = Callable[[web.Request], Awaitable[web.StreamResponse]]
 
-VALID_RESPONSE_FIELDS = {"schema", "description", "headers", "examples"}
+VALID_RESPONSE_FIELDS = {"description", "headers", "examples"}
 
 
 class AiohttpApiSpec:
@@ -45,9 +45,11 @@ def __init__(
             self.register(app, in_place)
 
     def swagger_dict(self):
+        """ Returns swagger spec representation in JSON format """
         return self.spec.to_dict()
 
     def register(self, app: web.Application, in_place: bool = False):
+        """ Creates spec based on registered app routes and registers needed view """
         if self._registered is True:
             return None
 
@@ -119,7 +121,7 @@ def _update_paths(self, data: dict, method: str, url_path: str):
         if method not in VALID_METHODS_OPENAPI_V2:
             return None
         if "schema" in data:
-            parameters = self.plugin.openapi.schema2parameters(
+            parameters = self.plugin.converter.schema2parameters(
                 data.pop("schema"), **data.pop("options")
             )
             data["parameters"].extend(parameters)
@@ -135,15 +137,15 @@ def _update_paths(self, data: dict, method: str, url_path: str):
             responses = {}
             for code, params in data["responses"].items():
                 if "schema" in params:
-                    raw_parameters = self.plugin.openapi.schema2parameters(
+                    raw_parameters = self.plugin.converter.schema2parameters(
                         params["schema"], required=params.get("required", False)
                     )[0]
-                    # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responseObject
                     parameters = {
                         k: v
                         for k, v in raw_parameters.items()
                         if k in VALID_RESPONSE_FIELDS
                     }
+                    parameters['schema'] = params["schema"]
                     for extra_info in ("description", "headers", "examples"):
                         if extra_info in params:
                             parameters[extra_info] = params[extra_info]

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 aiohttp>=3.0.1
-apispec>=1.0.0
+apispec>=3.0.0
 webargs
 jinja2
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@ def read(file_name):
 
 setup(
     name='aiohttp-apispec',
-    version='1.4.0',
+    version='1.5.0',
     description='Build and document REST APIs with aiohttp and apispec',
     long_description=read('README.md'),
     long_description_content_type="text/markdown",