🐛 Fix issue with rendering OpenAPI response body.

. Updated OpenAPI docs for the response spec.
dymmond · Nov 5, 2022 · c707b06 · c707b06
1 parent 5e01e35
commit c707b06
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/docs/responses.md b/docs/responses.md
@@ -56,6 +56,30 @@ uses the `TemplateResponse`.
 {!> ../docs_src/responses/template.py !}
 ```
 
+## OpenAPI Responses
+
+This is a special attribute that is used for OpenAPI spec purposes and can be created and added to a specific handler.
+
+```python
+from typing import Union
+
+from esmerald import post
+from esmerald.openapi.datastructures import ResponseSpec
+from pydantic import BaseModel
+
+
+class ItemOut(BaseModel):
+    sku: str
+    description: str
+
+
+@post(path='/create', summary="Creates an item", responses={200: ResponseSpec(model=TaskIn, description=...)})
+async def create() -> Union[None, ItemOut]:
+    ...
+```
+
+This will add an extra response description and details to your OpenAPI spec handler definition.
+
 ## Other responses
 
 There are other responses you can have that does not necessessarily have to be the ones provided here. Every case is

diff --git a/docs/routing/handlers.md b/docs/routing/handlers.md
@@ -114,7 +114,7 @@ class.
 * **security** - Security definition of the application. Used for OpenAPI.
 * **operation_id** - Internal unique identifier of the handler. Used for OpenAPI.
 * **response_description** - Description of the response. Used for OpenAPI.
-* **responses** - The available responses of the handler. Used for OpenAPI.
+* **responses** - The available responses of the handler. Used for OpenAPI. [More details](../responses.md#openapi-responses).
 
 ## HTTP handler summary
 

diff --git a/esmerald/config/openapi.py b/esmerald/config/openapi.py
@@ -19,6 +19,7 @@
     Server,
     Tag,
 )
+from openapi_schemas_pydantic.v3_1_0.path_item import PathItem
 from pydantic import AnyUrl, BaseModel
 from typing_extensions import Literal
 
@@ -129,7 +130,7 @@ def parse_route(app, prefix=""):
                             schema.paths[path] = {}
                         if not verb in schema.paths[path]:
                             schema.paths[path][verb] = {}
-                        schema.paths[path][verb] = path_item
+                        schema.paths[path][verb] = getattr(path_item, verb, None)
                     continue
 
                 route_app = getattr(route, "app", None)

diff --git a/esmerald/openapi/apiview.py b/esmerald/openapi/apiview.py
@@ -216,6 +216,7 @@ def render_swagger_ui(self, request: Request) -> str:
                 schema_copy.json(by_alias=True, exclude_none=True),
                 option=OPT_INDENT_2,
             ).decode("utf-8")
+
         head = f"""
           <head>
             <title>{schema.info.title}</title>

diff --git a/esmerald/openapi/path_item.py b/esmerald/openapi/path_item.py
@@ -24,7 +24,7 @@ def get_description_for_handler(
     return description
 
 
-def extract_layered_values(
+def extract_level_values(
     handler: "HTTPHandler",
 ) -> Tuple[Optional[List[str]], Optional[List[Dict[str, List[str]]]]]:
     tags: List[str] = []
@@ -71,7 +71,7 @@ def create_path_item(
                     field=handler_fields["data"], create_examples=create_examples
                 )
 
-            tags, security = extract_layered_values(handler=handler)
+            tags, security = extract_level_values(handler=handler)
             operation = Operation(
                 operationId=handler.operation_id or handler_name,
                 tags=tags,