fix: Improve Swagger documentation (#4652)

* Upgrade Swashbuckle dependency * Document /token response * Add support for Newtonsoft annotations in Swagger * Remove unecessary ActionResult [skip ci]
Ombi-app · May 27, 2022 · 181892b · 181892b
1 parent ae430e7
commit 181892b
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/src/Ombi.Api.Plex/Models/Metadata.cs b/src/Ombi.Api.Plex/Models/Metadata.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using Newtonsoft.Json;
 
 namespace Ombi.Api.Plex.Models
 {
@@ -38,6 +39,9 @@ public class Metadata
         public string grandparentTheme { get; set; }
         public string chapterSource { get; set; }
         public Medium[] Media { get; set; }
+
+
+        [JsonProperty("guids")]      
         public List<PlexGuids> Guid { get; set; } = new List<PlexGuids>();
     }
 

diff --git a/src/Ombi/Controllers/V1/TokenController.cs b/src/Ombi/Controllers/V1/TokenController.cs
@@ -16,9 +16,20 @@
 using Ombi.Store.Repository;
 using Ombi.Core.Settings;
 using Ombi.Settings.Settings.Models;
+using System.Text.Json.Serialization;
+using Newtonsoft.Json;
 
 namespace Ombi.Controllers.V1
 {
+
+
+    public class Token
+    {
+        [JsonProperty("access_token")]
+        public string AccessToken { get; set; }
+        public DateTime Expiration { get; set; }
+    }
+
     [ApiV1]
     [Produces("application/json")]
     [ApiController]
@@ -47,6 +58,7 @@ public TokenController(OmbiUserManager um, ITokenRepository token,
         /// <returns></returns>
         [HttpPost]
         [ProducesResponseType(401)]
+        [ProducesResponseType(typeof(Token), 200)]
         public async Task<IActionResult> GetToken([FromBody] UserAuthModel model)
         {
             if (!model.UsePlexOAuth)
@@ -161,10 +173,10 @@ private async Task<IActionResult> CreateToken(bool rememberMe, OmbiUser user)
 
             await _userManager.UpdateAsync(user);
 
-            return new JsonResult(new
+            return Ok(new Token
             {
-                access_token = accessToken,
-                expiration = token.ValidTo
+                AccessToken = accessToken,
+                Expiration = token.ValidTo
             });
         }
 

diff --git a/src/Ombi/Extensions/StartupExtensions.cs b/src/Ombi/Extensions/StartupExtensions.cs
@@ -79,6 +79,8 @@ public static void AddSwagger(this IServiceCollection services)
 
                 c.DescribeAllParametersInCamelCase();
             });
+
+            services.AddSwaggerGenNewtonsoftSupport();
         }
 
         public static void AddAppSettingsValues(this IServiceCollection services, IConfigurationRoot configuration)

diff --git a/src/Ombi/Ombi.csproj b/src/Ombi/Ombi.csproj
@@ -79,7 +79,8 @@
     <PackageReference Include="Serilog.Extensions.Logging" Version="3.0.1" />
     <PackageReference Include="Serilog.Sinks.File" Version="4.1.0" />
     <PackageReference Include="Serilog.Settings.Configuration" Version="3.3.0" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.3.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.3.1" />
     <PackageReference Include="System.Security.Cryptography.Csp" Version="4.3.0" />
     <PackageReference Include="Microsoft.AspNetCore.SpaServices" Version="5.0.0-preview.8.20414.8" />
     <PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="6.0.0" />