docs: Update API Docs (#3856)

mealie-recipes · Jul 8, 2024 · 17f9eef · 17f9eef
1 parent ca1ab33
commit 17f9eef
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 17 deletions.
diff --git a/mealie/app.py b/mealie/app.py
@@ -17,29 +17,24 @@
 
 settings = get_app_settings()
 
-description = f"""
+description = """
 Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful
 API interactive documentation that can be used to explore the API. If you're justing getting started with
 the API and want to get started quickly, you can use the
-[API Usage | Mealie Docs](https://nightly.mealie.io/documentation/getting-started/api-usage/)
+[API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/)
 as a reference for how to get started.
 
 
-As of this release <b>{APP_VERSION}</b>, Mealie is still in rapid development and therefore some of these APIs may
-change from version to version.
-
-
 If you have any questions or comments about mealie, please use the discord server to talk to the developers or other
 community members. If you'd like to file an issue, please use the
 [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)
 
 
 ## Helpful Links
 - [Home Page](https://mealie.io)
-- [Documentation](https://nightly.mealie.io)
+- [Documentation](https://docs.mealie.io)
 - [Discord](https://discord.gg/QuStdQGSGK)
 - [Demo](https://demo.mealie.io)
-- [Beta](https://demo.mealie.io)
 """
 
 logger = get_logger()

diff --git a/mealie/routes/_base/base_controllers.py b/mealie/routes/_base/base_controllers.py
@@ -131,7 +131,7 @@ class BaseCrudController(BaseUserController):
     Base class for all CRUD controllers to facilitate common CRUD functions.
     """
 
-    event_bus: EventBusService = Depends(EventBusService.create)
+    event_bus: EventBusService = Depends(EventBusService.as_dependency)
 
     def publish_event(self, event_type: EventTypes, document_data: EventDocumentDataBase, message: str = "") -> None:
         self.event_bus.dispatch(

diff --git a/mealie/routes/admin/admin_analytics.py b/mealie/routes/admin/admin_analytics.py
@@ -6,7 +6,7 @@
 from mealie.schema.analytics.analytics import MealieAnalytics
 from mealie.services.analytics.service_analytics import AnalyticsService
 
-router = APIRouter(prefix="/analytics")
+router = APIRouter(prefix="/analytics", include_in_schema=False)  # deprecated - use statistics route instead
 
 
 @controller(router)

diff --git a/mealie/routes/groups/controller_group_notifications.py b/mealie/routes/groups/controller_group_notifications.py
@@ -35,7 +35,7 @@
 
 @controller(router)
 class GroupEventsNotifierController(BaseUserController):
-    event_bus: EventBusService = Depends(EventBusService.create)
+    event_bus: EventBusService = Depends(EventBusService.as_dependency)
 
     @cached_property
     def repo(self):

diff --git a/mealie/routes/spa/__init__.py b/mealie/routes/spa/__init__.py
@@ -221,6 +221,6 @@ def mount_spa(app: FastAPI):
     global __contents
     __contents = pathlib.Path(__app_settings.STATIC_FILES).joinpath("index.html").read_text()
 
-    app.get("/g/{group_slug}/r/{recipe_slug}")(serve_recipe_with_meta)
-    app.get("/g/{group_slug}/shared/r/{token_id}")(serve_shared_recipe_with_meta)
+    app.get("/g/{group_slug}/r/{recipe_slug}", include_in_schema=False)(serve_recipe_with_meta)
+    app.get("/g/{group_slug}/shared/r/{token_id}", include_in_schema=False)(serve_shared_recipe_with_meta)
     app.mount("/", SPAStaticFiles(directory=__app_settings.STATIC_FILES, html=True), name="spa")
diff --git a/mealie/routes/users/registration.py b/mealie/routes/users/registration.py
@@ -15,7 +15,7 @@
 
 @controller(router)
 class RegistrationController(BasePublicController):
-    event_bus: EventBusService = Depends(EventBusService.create)
+    event_bus: EventBusService = Depends(EventBusService.as_dependency)
 
     @router.post("", response_model=UserOut, status_code=status.HTTP_201_CREATED)
     def register_new_user(self, data: CreateUserRegistration):

diff --git a/mealie/routes/validators/__init__.py b/mealie/routes/validators/__init__.py
@@ -6,4 +6,4 @@
 
 router = APIRouter()
 
-router.include_router(validators.router, prefix=prefix, tags=["Validators"])
+router.include_router(validators.router, prefix=prefix, tags=["Validators"], include_in_schema=False)
diff --git a/mealie/services/event_bus_service/event_bus_service.py b/mealie/services/event_bus_service/event_bus_service.py
@@ -1,4 +1,4 @@
-from fastapi import BackgroundTasks, Depends
+from fastapi import BackgroundTasks, Depends, Query
 from pydantic import UUID4
 from sqlalchemy.orm.session import Session
 
@@ -84,5 +84,11 @@ def publish_event(self, event: Event) -> None:
                 listener.publish_to_subscribers(event, subscribers)
 
     @classmethod
-    def create(cls, bg: BackgroundTasks, session=Depends(generate_session), group_id: UUID4 | None = None):
+    def as_dependency(
+        cls,
+        bg: BackgroundTasks,
+        session=Depends(generate_session),
+        group_id: UUID4 | None = Query(None, include_in_schema=False),
+    ):
+        """Convenience method to use as a dependency in FastAPI routes"""
         return cls(bg, session, group_id)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@

		router = APIRouter()

		router.include_router(validators.router, prefix=prefix, tags=["Validators"])
		router.include_router(validators.router, prefix=prefix, tags=["Validators"], include_in_schema=False)