mirror of
https://github.com/rommapp/romm.git
synced 2026-02-19 07:50:57 +01:00
70825830c4
Improve OpenAPI documentation by setting tags to each API router. Also, set a prefix to each router to group the endpoints by their functionality.
42 lines
1.1 KiB
Python
42 lines
1.1 KiB
Python
from decorators.auth import protected_route
|
|
from endpoints.responses import MessageResponse
|
|
from fastapi import Request
|
|
from handler.auth.constants import Scope
|
|
from tasks.update_switch_titledb import update_switch_titledb_task
|
|
from utils.router import APIRouter
|
|
|
|
router = APIRouter(
|
|
prefix="/tasks",
|
|
tags=["tasks"],
|
|
)
|
|
|
|
|
|
@protected_route(router.post, "/run", [Scope.TASKS_RUN])
|
|
async def run_tasks(request: Request) -> MessageResponse:
|
|
"""Run all tasks endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
Returns:
|
|
RunTasksResponse: Standard message response
|
|
"""
|
|
|
|
await update_switch_titledb_task.run()
|
|
return {"msg": "All tasks ran successfully!"}
|
|
|
|
|
|
@protected_route(router.post, "/{task}/run", [Scope.TASKS_RUN])
|
|
async def run_task(request: Request, task: str) -> MessageResponse:
|
|
"""Run all tasks endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
Returns:
|
|
RunTasksResponse: Standard message response
|
|
"""
|
|
|
|
tasks = {"switch_titledb": update_switch_titledb_task}
|
|
|
|
await tasks[task].run()
|
|
return {"msg": f"Task {task} run successfully!"}
|