michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update endpoint docs

Browse Source
This commit is contained in:
crobibero 2020-05-02 17:10:59 -06:00
parent 88b856796a
commit f67daa84b0
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Jellyfin.Api/Controllers/ScheduledTasksController.cs
View File

@ -33,7 +33,8 @@ namespace Jellyfin.Api.Controllers
/// </summary> /// </summary>
/// <param name="isHidden">Optional filter tasks that are hidden, or not.</param> /// <param name="isHidden">Optional filter tasks that are hidden, or not.</param>
/// <param name="isEnabled">Optional filter tasks that are enabled, 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] [HttpGet]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
public IEnumerable<IScheduledTaskWorker> GetTasks( public IEnumerable<IScheduledTaskWorker> GetTasks(
@ -65,7 +66,9 @@ namespace Jellyfin.Api.Controllers
/// Get task by id. /// Get task by id.
/// </summary> /// </summary>
/// <param name="taskId">Task Id.</param> /// <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}")] [HttpGet("{TaskID}")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]
@ -87,7 +90,9 @@ namespace Jellyfin.Api.Controllers
/// Start specified task. /// Start specified task.
/// </summary> /// </summary>
/// <param name="taskId">Task Id.</param> /// <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}")] [HttpPost("Running/{TaskID}")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]
@ -109,7 +114,9 @@ namespace Jellyfin.Api.Controllers
/// Stop specified task. /// Stop specified task.
/// </summary> /// </summary>
/// <param name="taskId">Task Id.</param> /// <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}")] [HttpDelete("Running/{TaskID}")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]
@ -132,7 +139,9 @@ namespace Jellyfin.Api.Controllers
/// </summary> /// </summary>
/// <param name="taskId">Task Id.</param> /// <param name="taskId">Task Id.</param>
/// <param name="triggerInfos">Triggers.</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")] [HttpPost("{TaskID}/Triggers")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)] [ProducesResponseType(StatusCodes.Status404NotFound)]