chore: tidy up dashboard api naming

Author: alex-mcgovern

api/openapi.json

@@ -33,7 +33,7 @@
         ],
         "summary": "Get Messages",
         "description": "Get all the messages from the database and return them as a list of conversations.",
-        "operationId": "get_messages_api_v1_dashboard_messages_get",
+        "operationId": "v1_get_messages",
         "responses": {
           "200": {
             "description": "Successful Response",
@@ -44,7 +44,7 @@
                     "$ref": "#/components/schemas/Conversation"
                   },
                   "type": "array",
-                  "title": "Response Get Messages Api V1 Dashboard Messages Get"
+                  "title": "Response V1 Get Messages"
                 }
               }
             }
@@ -60,7 +60,7 @@
         ],
         "summary": "Get Alerts",
         "description": "Get all the messages from the database and return them as a list of conversations.",
-        "operationId": "get_alerts_api_v1_dashboard_alerts_get",
+        "operationId": "v1_get_alerts",
         "responses": {
           "200": {
             "description": "Successful Response",
@@ -78,7 +78,7 @@
                     ]
                   },
                   "type": "array",
-                  "title": "Response Get Alerts Api V1 Dashboard Alerts Get"
+                  "title": "Response V1 Get Alerts"
                 }
               }
             }
@@ -94,7 +94,7 @@
         ],
         "summary": "Stream Sse",
         "description": "Send alerts event",
-        "operationId": "stream_sse_api_v1_dashboard_alerts_notification_get",
+        "operationId": "v1_stream_sse",
         "responses": {
           "200": {
             "description": "Successful Response",
@@ -114,7 +114,7 @@
           "Dashboard"
         ],
         "summary": "Version Check",
-        "operationId": "version_check_api_v1_dashboard_version_get",
+        "operationId": "v1_version_check",
         "responses": {
           "200": {
             "description": "Successful Response",

src/codegate/api/dashboard/dashboard.py

@@ -1,6 +1,7 @@
 import asyncio
 from typing import AsyncGenerator, List, Optional
 
+from fastapi.routing import APIRoute
 import requests
 import structlog
 from fastapi import APIRouter, Depends, FastAPI
@@ -16,9 +17,12 @@
 
 logger = structlog.get_logger("codegate")
 
-dashboard_router = APIRouter(tags=["Dashboard"])
+dashboard_router = APIRouter()
 db_reader = None
 
+def uniq_name(route: APIRoute):
+    return f"v1_{route.name}"
+
 def get_db_reader():
     global db_reader
     if db_reader is None:
@@ -36,7 +40,7 @@ def fetch_latest_version() -> str:
     data = response.json()
     return data.get("tag_name", "unknown")
 
-@dashboard_router.get("/dashboard/messages")
+@dashboard_router.get("/dashboard/messages", tags=["Dashboard"], generate_unique_id_function=uniq_name)
 def get_messages(db_reader: DbReader = Depends(get_db_reader)) -> List[Conversation]:
     """
     Get all the messages from the database and return them as a list of conversations.
@@ -46,7 +50,7 @@ def get_messages(db_reader: DbReader = Depends(get_db_reader)) -> List[Conversat
     return asyncio.run(parse_messages_in_conversations(prompts_outputs))
 
 
-@dashboard_router.get("/dashboard/alerts")
+@dashboard_router.get("/dashboard/alerts", tags=["Dashboard"], generate_unique_id_function=uniq_name)
 def get_alerts(db_reader: DbReader = Depends(get_db_reader)) -> List[Optional[AlertConversation]]:
     """
     Get all the messages from the database and return them as a list of conversations.
@@ -64,14 +68,14 @@ async def generate_sse_events() -> AsyncGenerator[str, None]:
         yield f"data: {message}\n\n"
 
 
-@dashboard_router.get("/dashboard/alerts_notification")
+@dashboard_router.get("/dashboard/alerts_notification", tags=["Dashboard"], generate_unique_id_function=uniq_name)
 async def stream_sse():
     """
     Send alerts event
     """
     return StreamingResponse(generate_sse_events(), media_type="text/event-stream")
 
-@dashboard_router.get("/dashboard/version")
+@dashboard_router.get("/dashboard/version", tags=["Dashboard"], generate_unique_id_function=uniq_name)
 def version_check():
     try:
         latest_version = fetch_latest_version()