From 9eda077c03ad7933974811fb573beb420a57a939 Mon Sep 17 00:00:00 2001
From: Bogdan <mynameisbogdan@users.noreply.github.com>
Date: Mon, 10 Jun 2024 11:23:33 +0300
Subject: [PATCH] Ignore `Grabbed` from API docs

Run application in docs.sh specific to platform

(cherry picked from commit c331c8bd119fa9f85a53e96db04f541b2d90bbd3)

Closes #4847
---
 docs.sh                                   | 10 ++++++++--
 src/Lidarr.Api.V1/Albums/AlbumResource.cs |  2 ++
 src/Lidarr.Api.V1/Lidarr.Api.V1.csproj    |  1 +
 src/Lidarr.Api.V1/Tracks/TrackResource.cs |  2 ++
 src/NzbDrone.Host/Lidarr.Host.csproj      |  2 +-
 5 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/docs.sh b/docs.sh
index 9cbb02756..a84de5fc0 100644
--- a/docs.sh
+++ b/docs.sh
@@ -21,15 +21,21 @@ slnFile=src/Lidarr.sln
 
 platform=Posix
 
+if [ "$PLATFORM" = "Windows" ]; then
+  application=Lidarr.Console.dll
+else
+  application=Lidarr.dll
+fi
+
 dotnet clean $slnFile -c Debug
 dotnet clean $slnFile -c Release
 
 dotnet msbuild -restore $slnFile -p:Configuration=Debug -p:Platform=$platform -p:RuntimeIdentifiers=$RUNTIME -t:PublishAllRids
 
 dotnet new tool-manifest
-dotnet tool install --version 6.5.0 Swashbuckle.AspNetCore.Cli
+dotnet tool install --version 6.6.2 Swashbuckle.AspNetCore.Cli
 
-dotnet tool run swagger tofile --output ./src/Lidarr.Api.V1/openapi.json "$outputFolder/net6.0/$RUNTIME/lidarr.console.dll" v1 &
+dotnet tool run swagger tofile --output ./src/Lidarr.Api.V1/openapi.json "$outputFolder/net6.0/$RUNTIME/$application" v1 &
 
 sleep 45
 
diff --git a/src/Lidarr.Api.V1/Albums/AlbumResource.cs b/src/Lidarr.Api.V1/Albums/AlbumResource.cs
index 06548e334..7a3d2a561 100644
--- a/src/Lidarr.Api.V1/Albums/AlbumResource.cs
+++ b/src/Lidarr.Api.V1/Albums/AlbumResource.cs
@@ -6,6 +6,7 @@
 using Newtonsoft.Json;
 using NzbDrone.Core.MediaCover;
 using NzbDrone.Core.Music;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace Lidarr.Api.V1.Albums
 {
@@ -49,6 +50,7 @@ public int MediumCount
 
         // Hiding this so people don't think its usable (only used to set the initial state)
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        [SwaggerIgnore]
         public bool Grabbed { get; set; }
     }
 
diff --git a/src/Lidarr.Api.V1/Lidarr.Api.V1.csproj b/src/Lidarr.Api.V1/Lidarr.Api.V1.csproj
index 7fe0a2d5a..da4390af4 100644
--- a/src/Lidarr.Api.V1/Lidarr.Api.V1.csproj
+++ b/src/Lidarr.Api.V1/Lidarr.Api.V1.csproj
@@ -9,6 +9,7 @@
     <ProjectReference Include="..\NzbDrone.SignalR\Lidarr.SignalR.csproj" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.6.2" />
     <PackageReference Include="System.Reflection.TypeExtensions" Version="4.7.0" />
     <PackageReference Include="FluentValidation" Version="9.5.4" />
     <PackageReference Include="Ical.Net" Version="4.2.0" />
diff --git a/src/Lidarr.Api.V1/Tracks/TrackResource.cs b/src/Lidarr.Api.V1/Tracks/TrackResource.cs
index 47f58811d..6e66e7922 100644
--- a/src/Lidarr.Api.V1/Tracks/TrackResource.cs
+++ b/src/Lidarr.Api.V1/Tracks/TrackResource.cs
@@ -5,6 +5,7 @@
 using Lidarr.Http.REST;
 using Newtonsoft.Json;
 using NzbDrone.Core.Music;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace Lidarr.Api.V1.Tracks
 {
@@ -29,6 +30,7 @@ public class TrackResource : RestResource
 
         // Hiding this so people don't think its usable (only used to set the initial state)
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+        [SwaggerIgnore]
         public bool Grabbed { get; set; }
     }
 
diff --git a/src/NzbDrone.Host/Lidarr.Host.csproj b/src/NzbDrone.Host/Lidarr.Host.csproj
index 9c3f91115..2209c0b6a 100644
--- a/src/NzbDrone.Host/Lidarr.Host.csproj
+++ b/src/NzbDrone.Host/Lidarr.Host.csproj
@@ -6,7 +6,7 @@
   <ItemGroup>
     <PackageReference Include="System.Text.Encoding.CodePages" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="6.0.2" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.6.2" />
     <PackageReference Include="DryIoc.dll" Version="5.4.3" />
     <PackageReference Include="DryIoc.Microsoft.DependencyInjection" Version="6.2.0" />
   </ItemGroup>