33from typing import TYPE_CHECKING , Any , Optional , cast
44
55from litestar .exceptions import NotFoundException
6+ from litestar .params import FromPath
67
78if TYPE_CHECKING :
89 from litestar import Controller
@@ -131,7 +132,7 @@ async def queue_list(self, task_queues: "TaskQueues") -> "dict[str, list[QueueIn
131132 summary = "Queue Detail" ,
132133 description = "List queue details." ,
133134 )
134- async def queue_detail (self , task_queues : "TaskQueues" , queue_id : str ) -> "dict[str, QueueInfo]" :
135+ async def queue_detail (self , task_queues : "TaskQueues" , queue_id : FromPath [ str ] ) -> "dict[str, QueueInfo]" :
135136 """Get queue information.
136137
137138 Args:
@@ -157,7 +158,7 @@ async def queue_detail(self, task_queues: "TaskQueues", queue_id: str) -> "dict[
157158 description = "List job details." ,
158159 )
159160 async def job_detail (
160- self , task_queues : "TaskQueues" , queue_id : str , job_id : str
161+ self , task_queues : "TaskQueues" , queue_id : FromPath [ str ] , job_id : FromPath [ str ]
161162 ) -> "dict[str, dict[str, Any]]" :
162163 """Get job information.
163164
@@ -191,7 +192,9 @@ async def job_detail(
191192 description = "Retry a failed job.." ,
192193 status_code = HTTP_202_ACCEPTED ,
193194 )
194- async def job_retry (self , task_queues : "TaskQueues" , queue_id : str , job_id : str ) -> "dict[str, str]" :
195+ async def job_retry (
196+ self , task_queues : "TaskQueues" , queue_id : FromPath [str ], job_id : FromPath [str ]
197+ ) -> "dict[str, str]" :
195198 """Retry job.
196199
197200 Args:
@@ -217,7 +220,9 @@ async def job_retry(self, task_queues: "TaskQueues", queue_id: str, job_id: str)
217220 description = "Abort active job." ,
218221 status_code = HTTP_202_ACCEPTED ,
219222 )
220- async def job_abort (self , task_queues : "TaskQueues" , queue_id : str , job_id : str ) -> "dict[str, str]" :
223+ async def job_abort (
224+ self , task_queues : "TaskQueues" , queue_id : FromPath [str ], job_id : FromPath [str ]
225+ ) -> "dict[str, str]" :
221226 """Abort job.
222227
223228 Args:
@@ -280,8 +285,8 @@ async def health(self, task_queues: "TaskQueues") -> Response[str]:
280285 )
281286 async def index (
282287 self ,
283- queue_id : Optional [str ] = None ,
284- job_id : Optional [str ] = None ,
288+ queue_id : FromPath [ Optional [str ] ] = None ,
289+ job_id : FromPath [ Optional [str ] ] = None ,
285290 ) -> str :
286291 return html_template
287292
0 commit comments