dev: Improve Docs Generation (#4402)

Co-authored-by: Kuchenpirat <[email protected]>
mealie-recipes · Oct 21, 2024 · a7c8b33 · a7c8b33
1 parent 674ad23
commit a7c8b33
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 11 deletions.
diff --git a/dev/code-generation/gen_docs_api.py b/dev/code-generation/gen_docs_api.py
@@ -1,5 +1,8 @@
 import json
 
+from fastapi import FastAPI
+from freezegun import freeze_time
+
 from mealie.app import app
 from mealie.core.config import determine_data_dir
 
@@ -36,11 +39,12 @@
 HTML_PATH = DATA_DIR.parent.parent.joinpath("docs/docs/overrides/api.html")
 
 
-def generate_api_docs(my_app):
+def generate_api_docs(my_app: FastAPI):
     with open(HTML_PATH, "w") as fd:
         text = HTML_TEMPLATE.replace("MY_SPECIFIC_TEXT", json.dumps(my_app.openapi()))
         fd.write(text)
 
 
 if __name__ == "__main__":
-    generate_api_docs(app)
+    with freeze_time("2024-01-20T17:00:55Z"):
+        generate_api_docs(app)
diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html
diff --git a/mealie/routes/recipe/__init__.py b/mealie/routes/recipe/__init__.py
@@ -6,9 +6,9 @@
 
 router = APIRouter()
 
-router.include_router(recipe_crud_routes.router_exports)
-router.include_router(recipe_crud_routes.router)
+router.include_router(recipe_crud_routes.router_exports, tags=["Recipe: Exports"])
+router.include_router(recipe_crud_routes.router, tags=["Recipe: CRUD"])
 router.include_router(comments.router, prefix=prefix, tags=["Recipe: Comments"])
-router.include_router(bulk_actions.router, prefix=prefix, tags=["Recipe: Bulk Exports"])
+router.include_router(bulk_actions.router, prefix=prefix, tags=["Recipe: Bulk Actions"])
 router.include_router(shared_routes.router, prefix=prefix, tags=["Recipe: Shared"])
 router.include_router(timeline_events.events_router, prefix=prefix, tags=["Recipe: Timeline"])
diff --git a/mealie/routes/recipe/bulk_actions.py b/mealie/routes/recipe/bulk_actions.py
@@ -17,7 +17,7 @@
 from mealie.schema.response.responses import SuccessResponse
 from mealie.services.recipe.recipe_bulk_service import RecipeBulkActionsService
 
-router = APIRouter(prefix="/bulk-actions", tags=["Recipe: Bulk Actions"])
+router = APIRouter(prefix="/bulk-actions")
 
 
 @controller(router)

diff --git a/mealie/routes/recipe/recipe_crud_routes.py b/mealie/routes/recipe/recipe_crud_routes.py
@@ -123,7 +123,7 @@ class FormatResponse(BaseModel):
     jinja2: list[str]
 
 
-router_exports = UserAPIRouter(prefix="/recipes", tags=["Recipe: Exports"])
+router_exports = UserAPIRouter(prefix="/recipes")
 
 
 @controller(router_exports)
@@ -176,7 +176,7 @@ def get_recipe_as_zip(self, slug: str, token: str):
             )
 
 
-router = UserAPIRouter(prefix="/recipes", tags=["Recipe: CRUD"], route_class=MealieCrudRoute)
+router = UserAPIRouter(prefix="/recipes", route_class=MealieCrudRoute)
 
 
 @controller(router)

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,6 +71,7 @@ types-python-slugify = "^6.0.0"
 types-requests = "^2.27.12"
 types-urllib3 = "^1.26.11"
 pydantic-to-typescript2 = "^1.0.4"
+freezegun = "^1.5.1"
 
 
 [build-system]