update xml docs

This commit is contained in:
crobibero 2020-05-19 09:29:59 -06:00
parent bb8e738a08
commit 6dbbfcbfbe
1 changed files with 9 additions and 3 deletions

View File

@ -44,6 +44,7 @@ namespace Jellyfin.Api.Controllers
/// <summary> /// <summary>
/// Gets application configuration. /// Gets application configuration.
/// </summary> /// </summary>
/// <response code="200">Application configuration returned.</response>
/// <returns>Application configuration.</returns> /// <returns>Application configuration.</returns>
[HttpGet("Configuration")] [HttpGet("Configuration")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
@ -56,7 +57,8 @@ namespace Jellyfin.Api.Controllers
/// Updates application configuration. /// Updates application configuration.
/// </summary> /// </summary>
/// <param name="configuration">Configuration.</param> /// <param name="configuration">Configuration.</param>
/// <returns>Status.</returns> /// <response code="200">Configuration updated.</response>
/// <returns>Update status.</returns>
[HttpPost("Configuration")] [HttpPost("Configuration")]
[Authorize(Policy = Policies.RequiresElevation)] [Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
@ -70,6 +72,7 @@ namespace Jellyfin.Api.Controllers
/// Gets a named configuration. /// Gets a named configuration.
/// </summary> /// </summary>
/// <param name="key">Configuration key.</param> /// <param name="key">Configuration key.</param>
/// <response code="200">Configuration returned.</response>
/// <returns>Configuration.</returns> /// <returns>Configuration.</returns>
[HttpGet("Configuration/{Key}")] [HttpGet("Configuration/{Key}")]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
@ -82,7 +85,8 @@ namespace Jellyfin.Api.Controllers
/// Updates named configuration. /// Updates named configuration.
/// </summary> /// </summary>
/// <param name="key">Configuration key.</param> /// <param name="key">Configuration key.</param>
/// <returns>Status.</returns> /// <response code="200">Named configuration updated.</response>
/// <returns>Update status.</returns>
[HttpPost("Configuration/{Key}")] [HttpPost("Configuration/{Key}")]
[Authorize(Policy = Policies.RequiresElevation)] [Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
@ -103,7 +107,8 @@ namespace Jellyfin.Api.Controllers
/// <summary> /// <summary>
/// Gets a default MetadataOptions object. /// Gets a default MetadataOptions object.
/// </summary> /// </summary>
/// <returns>MetadataOptions.</returns> /// <response code="200">Metadata options returned.</response>
/// <returns>Default MetadataOptions.</returns>
[HttpGet("Configuration/MetadataOptions/Default")] [HttpGet("Configuration/MetadataOptions/Default")]
[Authorize(Policy = Policies.RequiresElevation)] [Authorize(Policy = Policies.RequiresElevation)]
[ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status200OK)]
@ -116,6 +121,7 @@ namespace Jellyfin.Api.Controllers
/// Updates the path to the media encoder. /// Updates the path to the media encoder.
/// </summary> /// </summary>
/// <param name="mediaEncoderPath">Media encoder path form body.</param> /// <param name="mediaEncoderPath">Media encoder path form body.</param>
/// <response code="200">Media encoder path updated.</response>
/// <returns>Status.</returns> /// <returns>Status.</returns>
[HttpPost("MediaEncoder/Path")] [HttpPost("MediaEncoder/Path")]
[Authorize(Policy = Policies.FirstTimeSetupOrElevated)] [Authorize(Policy = Policies.FirstTimeSetupOrElevated)]