fastapi-rtk 2.0.0__tar.gz → 2.0.2__tar.gz

{fastapi_rtk-2.0.0 → fastapi_rtk-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.0.0
+Version: 2.0.2
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.0.2/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.0.2"

{fastapi_rtk-2.0.0 → fastapi_rtk-2.0.2}/fastapi_rtk/cli/commands/export.py

@@ -163,7 +163,9 @@ def api_docs(
     )
 
     # Load all schema into the docs
-    for key, schema in openapi_docs["components"]["schemas"].items():
+    for key, schema in (
+        openapi_docs.get("components", {}).get("schemas", {}).items()
+    ):
         parsed_schema = parser.parse_schema(schema)
         parsed_schema[0] = parsed_schema[0].replace(key, f"Schemas-{key}")
         api_data_docs["Schemas"][key] = "".join(parsed_schema)
@@ -171,14 +173,15 @@ def api_docs(
 
     for path, data in openapi_docs["paths"].items():
         for method, method_data in data.items():
-            for tag in method_data["tags"]:
+            for tag in method_data.get("tags", []):
                 if tag not in api_data_docs["APIs"]:
                     continue
 
                 api_path_docs = APIPathDocs(
                     path=path,
                     method=method.upper(),
-                    description=method_data.get("summary", ""),
+                    description=method_data.get("description")
+                    or method_data.get("summary", ""),
                 )
 
                 # Add responses to the API data docs
@@ -219,29 +222,15 @@ def api_docs(
                     Responses=responses,
                 )
 
-                # Add metadata to the API data docs
-                api_data_docs["APIs"][tag]["Metadata"][path] = api_metadata_docs
+                # Add metadata to the API data docs, keyed by method + path so
+                # endpoints sharing a path (e.g. GET/PUT/DELETE on the same URL)
+                # do not overwrite each other.
+                api_data_docs["APIs"][tag]["Metadata"][
+                    f"{method.upper()} {path}"
+                ] = api_metadata_docs
 
                 api_data_docs["APIs"][tag]["Paths"].append(api_path_docs)
 
-                # Add schema
-                schemas_to_add = []
-                for resp in responses:
-                    if resp["content"]:
-                        schemas_to_add.append(resp["content"])
-
-                if body:
-                    schemas_to_add.append(body)
-
-                for schema in schemas_to_add:
-                    key = schema.split("]")[0].replace("[", "")
-                    schema = openapi_docs["components"]["schemas"].get(key)
-                    if schema:
-                        parsed_schema = parser.parse_schema(schema)
-                        parsed_schema[0] = parsed_schema[0].replace(
-                            key, f"Schemas-{key}"
-                        )
-
     with open(filename, "w") as f:
         f.write(
             json_to_markdown(
@@ -492,14 +481,14 @@ def _generate_fastapi_rtk_tables_docs():
     # Permission API docs
     table_documentation[PERMISSION_API_TABLE]["description"] = (
         table_documentation[PERMISSION_API_TABLE]["description"]
-        or "Stores which permissions are associated with which API."
+        or "Stores which permissions are associated with which APIs."
     )
     table_documentation[PERMISSION_API_TABLE]["columns"] = table_documentation[
         PERMISSION_API_TABLE
     ]["columns"] or {
         "id": "Primary key.",
-        "view_menu_id": f"FK to `{PERMISSION_TABLE}.id`.",
-        "api_id": f"FK to `{API_TABLE}.id`.",
+        "view_menu_id": f"FK to `{API_TABLE}.id`.",
+        "permission_id": f"FK to `{PERMISSION_TABLE}.id`.",
     }
 
     # Assoc Permission API Role docs
@@ -555,7 +544,7 @@ def _generate_fastapi_rtk_tables_docs():
     table_documentation[ACCESSTOKEN_TABLE]["columns"] = table_documentation[
         ACCESSTOKEN_TABLE
     ]["columns"] or {
-        "token": "Access token string.",
+        "token": "Primary key. Access token string.",
         "created_at": "Timestamp when the token was created.",
         "user_id": f"FK to `{USER_TABLE}.id`. Identifies the user.",
     }

{fastapi_rtk-2.0.0 → fastapi_rtk-2.0.2}/tests/unit/cli/test_commands.py

@@ -1053,6 +1053,127 @@ class TestApiDocsCommand:
         assert "WidgetIn" in body
 
 
+    def test_api_docs_handles_route_without_tags(
+        self, tmp_path, monkeypatch, global_setter
+    ):
+        """
+        Regression: a route registered without ``tags=`` (e.g. a top-level
+        health probe attached directly to FastAPI) used to raise
+        ``KeyError: 'tags'`` while iterating ``method_data["tags"]``. The
+        path walk must now treat ``tags`` as optional.
+        """
+        from unittest.mock import MagicMock
+
+        from fastapi import FastAPI
+
+        from fastapi_rtk.cli.commands import export as ex_mod
+
+        fastapi_app = FastAPI()
+
+        @fastapi_app.get("/healthz")
+        def healthz():
+            return {"ok": True}
+
+        app_obj = MagicMock()
+        app_obj.app = fastapi_app
+        app_obj.apis = []
+        global_setter("current_app", app_obj)
+
+        target = tmp_path / "untagged.md"
+        ex_mod.api_docs(filename=str(target))
+        assert target.exists()
+
+    def test_api_docs_metadata_distinguishes_methods_on_same_path(
+        self, tmp_path, monkeypatch, global_setter
+    ):
+        """
+        Regression: metadata used to be keyed by path alone, so GET and
+        DELETE on the same URL clobbered each other. The metadata key must
+        now include the method.
+        """
+        from unittest.mock import MagicMock
+
+        from fastapi import FastAPI
+
+        from fastapi_rtk.api.model_rest_api import ModelRestApi
+        from fastapi_rtk.cli.commands import export as ex_mod
+
+        fastapi_app = FastAPI()
+
+        @fastapi_app.get("/widgets/{id}", tags=["WidgetApi"], summary="Get widget")
+        def get_widget(id: int):
+            return {"id": id}
+
+        @fastapi_app.delete(
+            "/widgets/{id}", tags=["WidgetApi"], summary="Delete widget"
+        )
+        def delete_widget(id: int):
+            return {"id": id}
+
+        class WidgetApi(ModelRestApi):
+            pass
+
+        widget = MagicMock(spec=WidgetApi)
+        widget.__class__ = WidgetApi
+        widget.description = ""
+        widget.integrate_router = MagicMock()
+
+        app_obj = MagicMock()
+        app_obj.app = fastapi_app
+        app_obj.apis = [widget]
+        global_setter("current_app", app_obj)
+
+        target = tmp_path / "two-methods.md"
+        ex_mod.api_docs(apis="WidgetApi", filename=str(target))
+        body = target.read_text()
+        assert "GET /widgets/{id}" in body
+        assert "DELETE /widgets/{id}" in body
+
+    def test_api_docs_prefers_route_description_over_summary(
+        self, tmp_path, monkeypatch, global_setter
+    ):
+        """
+        ``description`` (operation docstring) must win over ``summary``
+        (humanized function name) when both are present on an OpenAPI
+        operation.
+        """
+        from unittest.mock import MagicMock
+
+        from fastapi import FastAPI
+
+        from fastapi_rtk.api.model_rest_api import ModelRestApi
+        from fastapi_rtk.cli.commands import export as ex_mod
+
+        fastapi_app = FastAPI()
+
+        @fastapi_app.get(
+            "/widgets/",
+            tags=["WidgetApi"],
+            summary="Short summary",
+            description="Detailed widget description goes here.",
+        )
+        def list_widgets():
+            return []
+
+        class WidgetApi(ModelRestApi):
+            pass
+
+        widget = MagicMock(spec=WidgetApi)
+        widget.__class__ = WidgetApi
+        widget.description = ""
+        widget.integrate_router = MagicMock()
+
+        app_obj = MagicMock()
+        app_obj.app = fastapi_app
+        app_obj.apis = [widget]
+        global_setter("current_app", app_obj)
+
+        target = tmp_path / "description-fallback.md"
+        ex_mod.api_docs(apis="WidgetApi", filename=str(target))
+        body = target.read_text()
+        assert "Detailed widget description goes here." in body
+
+
 class TestApiDocsCommandFilteredWalk:
     """Hit the body of api_docs (lines 154-241): integrate_router + paths walk."""
 

fastapi_rtk-2.0.0/fastapi_rtk/_version.py

@@ -1 +0,0 @@
-__version__ = "2.0.0"