Merge pull request #104 from sondrelg/sondrelg/document-404-response

document 404 response

Author: awtkns

.gitignore

@@ -39,6 +39,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+.mypy_cache/
 
 # Environments
 .env

CONTRIBUTING.md

@@ -1,3 +1 @@
-
-
 Pull requests and contributions are welcome. Please read the [contributions guidelines](https://fastapi-crudrouter.awtkns.com/contributing) for more details.

fastapi_crudrouter/_version.py

@@ -1 +1 @@
-__version__ = "0.8.2"
+__version__ = "0.8.3"

fastapi_crudrouter/core/_base.py

@@ -90,6 +90,7 @@ def __init__(
                 response_model=self.schema,
                 summary="Get One",
                 dependencies=get_one_route,
+                error_responses=[NOT_FOUND],
             )
 
         if update_route:
@@ -100,6 +101,7 @@ def __init__(
                 response_model=self.schema,
                 summary="Update One",
                 dependencies=update_route,
+                error_responses=[NOT_FOUND],
             )
 
         if delete_one_route:
@@ -110,17 +112,27 @@ def __init__(
                 response_model=self.schema,
                 summary="Delete One",
                 dependencies=delete_one_route,
+                error_responses=[NOT_FOUND],
             )
 
     def _add_api_route(
         self,
         path: str,
         endpoint: Callable[..., Any],
         dependencies: Union[bool, DEPENDENCIES],
+        error_responses: Optional[List[HTTPException]] = None,
         **kwargs: Any,
     ) -> None:
         dependencies = [] if isinstance(dependencies, bool) else dependencies
-        super().add_api_route(path, endpoint, dependencies=dependencies, **kwargs)
+        responses: Any = (
+            {err.status_code: {"detail": err.detail} for err in error_responses}
+            if error_responses
+            else None
+        )
+
+        super().add_api_route(
+            path, endpoint, dependencies=dependencies, responses=responses, **kwargs
+        )
 
     def api_route(
         self, path: str, *args: Any, **kwargs: Any

tests/conftest.py

@@ -1,5 +1,4 @@
 import pytest
-import inspect
 from fastapi.testclient import TestClient
 
 from .implementations import *

tests/test_openapi_schema.py

@@ -1,6 +1,9 @@
+from pytest import mark
+
 from tests import CUSTOM_TAGS
 
 POTATO_TAGS = ["Potato"]
+PATHS = ["/potato", "/carrot"]
 PATH_TAGS = {
     "/potato": POTATO_TAGS,
     "/potato/{item_id}": POTATO_TAGS,
@@ -26,3 +29,19 @@ def test_schema_tags(self, client):
 
             for m in method:
                 assert method[m]["tags"] == PATH_TAGS[path]
+
+    @mark.parametrize("path", PATHS)
+    def test_response_types(self, client, path):
+        schema = self.test_schema_exists(client).json()
+        paths = schema["paths"]
+
+        for method in ["get", "post", "delete"]:
+            assert "200" in paths[path][method]["responses"]
+
+        assert "422" in paths[path]["post"]["responses"]
+
+        item_path = path + "/{item_id}"
+        for method in ["get", "put", "delete"]:
+            assert "200" in paths[item_path][method]["responses"]
+            assert "404" in paths[item_path][method]["responses"]
+            assert "422" in paths[item_path][method]["responses"]