diff options
| author | crobibero <cody@robibe.ro> | 2020-05-02 17:10:59 -0600 |
|---|---|---|
| committer | crobibero <cody@robibe.ro> | 2020-05-02 17:10:59 -0600 |
| commit | f67daa84b04ae6c8ffcc42c038a65ecb8a433861 (patch) | |
| tree | 455547b4cccb1ac195248c35c48506f67bc7eb17 /Jellyfin.Api/Controllers/ScheduledTasksController.cs | |
| parent | 88b856796a9e4852ae4f9938baddd4741e8285d5 (diff) | |
Update endpoint docs
Diffstat (limited to 'Jellyfin.Api/Controllers/ScheduledTasksController.cs')
| -rw-r--r-- | Jellyfin.Api/Controllers/ScheduledTasksController.cs | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/Jellyfin.Api/Controllers/ScheduledTasksController.cs b/Jellyfin.Api/Controllers/ScheduledTasksController.cs index da7cfbc3a..ad70bf83b 100644 --- a/Jellyfin.Api/Controllers/ScheduledTasksController.cs +++ b/Jellyfin.Api/Controllers/ScheduledTasksController.cs @@ -33,7 +33,8 @@ namespace Jellyfin.Api.Controllers /// </summary> /// <param name="isHidden">Optional filter tasks that are hidden, or not.</param> /// <param name="isEnabled">Optional filter tasks that are enabled, or not.</param> - /// <returns>Task list.</returns> + /// <response code="200">Scheduled tasks retrieved.</response> + /// <returns>The list of scheduled tasks.</returns> [HttpGet] [ProducesResponseType(StatusCodes.Status200OK)] public IEnumerable<IScheduledTaskWorker> GetTasks( @@ -65,7 +66,9 @@ namespace Jellyfin.Api.Controllers /// Get task by id. /// </summary> /// <param name="taskId">Task Id.</param> - /// <returns>Task Info.</returns> + /// <response code="200">Task retrieved.</response> + /// <response code="404">Task not found.</response> + /// <returns>An <see cref="OkResult"/> containing the task on success, or a <see cref="NotFoundResult"/> if the task could not be found.</returns> [HttpGet("{TaskID}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -87,7 +90,9 @@ namespace Jellyfin.Api.Controllers /// Start specified task. /// </summary> /// <param name="taskId">Task Id.</param> - /// <returns>Status.</returns> + /// <response code="200">Task started.</response> + /// <response code="404">Task not found.</response> + /// <returns>An <see cref="OkResult"/> on success, or a <see cref="NotFoundResult"/> if the file could not be found.</returns> [HttpPost("Running/{TaskID}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -109,7 +114,9 @@ namespace Jellyfin.Api.Controllers /// Stop specified task. /// </summary> /// <param name="taskId">Task Id.</param> - /// <returns>Status.</returns> + /// <response code="200">Task stopped.</response> + /// <response code="404">Task not found.</response> + /// <returns>An <see cref="OkResult"/> on success, or a <see cref="NotFoundResult"/> if the file could not be found.</returns> [HttpDelete("Running/{TaskID}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -132,7 +139,9 @@ namespace Jellyfin.Api.Controllers /// </summary> /// <param name="taskId">Task Id.</param> /// <param name="triggerInfos">Triggers.</param> - /// <returns>Status.</returns> + /// <response code="200">Task triggers updated.</response> + /// <response code="404">Task not found.</response> + /// <returns>An <see cref="OkResult"/> on success, or a <see cref="NotFoundResult"/> if the file could not be found.</returns> [HttpPost("{TaskID}/Triggers")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] |