diff options
| author | crobibero <cody@robibe.ro> | 2020-05-02 17:06:29 -0600 |
|---|---|---|
| committer | crobibero <cody@robibe.ro> | 2020-05-02 17:06:29 -0600 |
| commit | 0017163f39438e2718f7c95b3fb65df5dde65e3d (patch) | |
| tree | 9e580196ee86e763ca81470f75dcdaf109b46fff /Jellyfin.Api/Controllers | |
| parent | 311f2e2bc317cea7ac4d4cc783b961793bb997d5 (diff) | |
Update endpoint docs
Diffstat (limited to 'Jellyfin.Api/Controllers')
| -rw-r--r-- | Jellyfin.Api/Controllers/DisplayPreferencesController.cs | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Jellyfin.Api/Controllers/DisplayPreferencesController.cs b/Jellyfin.Api/Controllers/DisplayPreferencesController.cs index 0d375e668..2837ea8e8 100644 --- a/Jellyfin.Api/Controllers/DisplayPreferencesController.cs +++ b/Jellyfin.Api/Controllers/DisplayPreferencesController.cs @@ -34,7 +34,9 @@ namespace Jellyfin.Api.Controllers /// <param name="displayPreferencesId">Display preferences id.</param> /// <param name="userId">User id.</param> /// <param name="client">Client.</param> - /// <returns>Display Preferences.</returns> + /// <response code="200">Display preferences retrieved.</response> + /// <response code="404">Specified display preferences not found.</response> + /// <returns>An <see cref="OkResult"/> containing the display preferences on success, or a <see cref="NotFoundResult"/> if the display preferences could not be found.</returns> [HttpGet("{DisplayPreferencesId}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] @@ -59,7 +61,9 @@ namespace Jellyfin.Api.Controllers /// <param name="userId">User Id.</param> /// <param name="client">Client.</param> /// <param name="displayPreferences">New Display Preferences object.</param> - /// <returns>Status.</returns> + /// <response code="200">Display preferences updated.</response> + /// <response code="404">Specified display preferences not found.</response> + /// <returns>An <see cref="OkResult"/> on success, or a <see cref="NotFoundResult"/> if the display preferences could not be found.</returns> [HttpPost("{DisplayPreferencesId}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(typeof(ModelStateDictionary), StatusCodes.Status400BadRequest)] |