diff options
| author | crobibero <cody@robibe.ro> | 2020-05-19 10:02:52 -0600 |
|---|---|---|
| committer | crobibero <cody@robibe.ro> | 2020-05-19 10:02:52 -0600 |
| commit | e03c97d7cdfad65a48bc0aff6ca0e45f9b3ec3cd (patch) | |
| tree | ca9007f808ac002f5fdc0c799ee005a774c5cd0b | |
| parent | 714aaefbcc3abf0b952efc831001cf42e1c873b0 (diff) | |
update xml docs
| -rw-r--r-- | Jellyfin.Api/Controllers/EnvironmentController.cs | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Jellyfin.Api/Controllers/EnvironmentController.cs b/Jellyfin.Api/Controllers/EnvironmentController.cs index 139c1af08..78c206ba1 100644 --- a/Jellyfin.Api/Controllers/EnvironmentController.cs +++ b/Jellyfin.Api/Controllers/EnvironmentController.cs @@ -40,7 +40,8 @@ namespace Jellyfin.Api.Controllers /// <param name="path">The path.</param> /// <param name="includeFiles">An optional filter to include or exclude files from the results. true/false.</param> /// <param name="includeDirectories">An optional filter to include or exclude folders from the results. true/false.</param> - /// <returns>File system entries.</returns> + /// <response code="200">Directory contents returned.</response> + /// <returns>Directory contents.</returns> [HttpGet("DirectoryContents")] [ProducesResponseType(StatusCodes.Status200OK)] public IEnumerable<FileSystemEntryInfo> GetDirectoryContents( @@ -79,7 +80,9 @@ namespace Jellyfin.Api.Controllers /// Validates path. /// </summary> /// <param name="validatePathDto">Validate request object.</param> - /// <returns>Status.</returns> + /// <response code="200">Path validated.</response> + /// <response code="404">Path not found.</response> + /// <returns>Validation status.</returns> [HttpPost("ValidatePath")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -132,6 +135,7 @@ namespace Jellyfin.Api.Controllers /// <summary> /// Gets network paths. /// </summary> + /// <response code="200">Empty array returned.</response> /// <returns>List of entries.</returns> [Obsolete("This endpoint is obsolete.")] [HttpGet("NetworkShares")] @@ -144,6 +148,7 @@ namespace Jellyfin.Api.Controllers /// <summary> /// Gets available drives from the server's file system. /// </summary> + /// <response code="200">List of entries returned.</response> /// <returns>List of entries.</returns> [HttpGet("Drives")] [ProducesResponseType(StatusCodes.Status200OK)] @@ -189,6 +194,7 @@ namespace Jellyfin.Api.Controllers /// <summary> /// Get Default directory browser. /// </summary> + /// <response code="200">Default directory browser returned.</response> /// <returns>Default directory browser.</returns> [HttpGet("DefaultDirectoryBrowser")] [ProducesResponseType(StatusCodes.Status200OK)] |