diff options
| author | crobibero <cody@robibe.ro> | 2020-05-19 09:29:59 -0600 |
|---|---|---|
| committer | crobibero <cody@robibe.ro> | 2020-05-19 09:29:59 -0600 |
| commit | 6dbbfcbfbef28e8866aa0144170e1edfff1a2bcb (patch) | |
| tree | 47231f14f13958150d3f41df19b65890786916ee | |
| parent | bb8e738a0817be2e13a8b21929d0f0aeb0c6a461 (diff) | |
update xml docs
| -rw-r--r-- | Jellyfin.Api/Controllers/ConfigurationController.cs | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/Jellyfin.Api/Controllers/ConfigurationController.cs b/Jellyfin.Api/Controllers/ConfigurationController.cs index b508ac054..992cb0087 100644 --- a/Jellyfin.Api/Controllers/ConfigurationController.cs +++ b/Jellyfin.Api/Controllers/ConfigurationController.cs @@ -44,6 +44,7 @@ namespace Jellyfin.Api.Controllers /// <summary> /// Gets application configuration. /// </summary> + /// <response code="200">Application configuration returned.</response> /// <returns>Application configuration.</returns> [HttpGet("Configuration")] [ProducesResponseType(StatusCodes.Status200OK)] @@ -56,7 +57,8 @@ namespace Jellyfin.Api.Controllers /// Updates application configuration. /// </summary> /// <param name="configuration">Configuration.</param> - /// <returns>Status.</returns> + /// <response code="200">Configuration updated.</response> + /// <returns>Update status.</returns> [HttpPost("Configuration")] [Authorize(Policy = Policies.RequiresElevation)] [ProducesResponseType(StatusCodes.Status200OK)] @@ -70,6 +72,7 @@ namespace Jellyfin.Api.Controllers /// Gets a named configuration. /// </summary> /// <param name="key">Configuration key.</param> + /// <response code="200">Configuration returned.</response> /// <returns>Configuration.</returns> [HttpGet("Configuration/{Key}")] [ProducesResponseType(StatusCodes.Status200OK)] @@ -82,7 +85,8 @@ namespace Jellyfin.Api.Controllers /// Updates named configuration. /// </summary> /// <param name="key">Configuration key.</param> - /// <returns>Status.</returns> + /// <response code="200">Named configuration updated.</response> + /// <returns>Update status.</returns> [HttpPost("Configuration/{Key}")] [Authorize(Policy = Policies.RequiresElevation)] [ProducesResponseType(StatusCodes.Status200OK)] @@ -103,7 +107,8 @@ namespace Jellyfin.Api.Controllers /// <summary> /// Gets a default MetadataOptions object. /// </summary> - /// <returns>MetadataOptions.</returns> + /// <response code="200">Metadata options returned.</response> + /// <returns>Default MetadataOptions.</returns> [HttpGet("Configuration/MetadataOptions/Default")] [Authorize(Policy = Policies.RequiresElevation)] [ProducesResponseType(StatusCodes.Status200OK)] @@ -116,6 +121,7 @@ namespace Jellyfin.Api.Controllers /// Updates the path to the media encoder. /// </summary> /// <param name="mediaEncoderPath">Media encoder path form body.</param> + /// <response code="200">Media encoder path updated.</response> /// <returns>Status.</returns> [HttpPost("MediaEncoder/Path")] [Authorize(Policy = Policies.FirstTimeSetupOrElevated)] |