Ignore `Grabbed` from API docs

Run application in docs.sh specific to platform

(cherry picked from commit c331c8bd119fa9f85a53e96db04f541b2d90bbd3)

Closes #3515
pull/3516/head
Bogdan 8 months ago
parent 5b1b2a2d67
commit 932356be61

@ -1,3 +1,7 @@
#!/bin/bash
set -e
FRAMEWORK="net6.0"
PLATFORM=$1 PLATFORM=$1
if [ "$PLATFORM" = "Windows" ]; then if [ "$PLATFORM" = "Windows" ]; then
@ -21,15 +25,21 @@ slnFile=src/Readarr.sln
platform=Posix platform=Posix
if [ "$PLATFORM" = "Windows" ]; then
application=Readarr.Console.dll
else
application=Readarr.dll
fi
dotnet clean $slnFile -c Debug dotnet clean $slnFile -c Debug
dotnet clean $slnFile -c Release dotnet clean $slnFile -c Release
dotnet msbuild -restore $slnFile -p:Configuration=Debug -p:Platform=$platform -p:RuntimeIdentifiers=$RUNTIME -t:PublishAllRids dotnet msbuild -restore $slnFile -p:Configuration=Debug -p:Platform=$platform -p:RuntimeIdentifiers=$RUNTIME -t:PublishAllRids
dotnet new tool-manifest 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/Readarr.Api.V1/openapi.json "$outputFolder/net6.0/$RUNTIME/Readarr.console.dll" v1 & dotnet tool run swagger tofile --output ./src/Readarr.Api.V1/openapi.json "$outputFolder/$FRAMEWORK/$RUNTIME/$application" v1 &
sleep 45 sleep 45

@ -46,7 +46,8 @@
<PackageVersion Include="SharpZipLib" Version="1.4.2" /> <PackageVersion Include="SharpZipLib" Version="1.4.2" />
<PackageVersion Include="SixLabors.ImageSharp" Version="3.1.4" /> <PackageVersion Include="SixLabors.ImageSharp" Version="3.1.4" />
<PackageVersion Include="StyleCop.Analyzers" Version="1.1.118" /> <PackageVersion Include="StyleCop.Analyzers" Version="1.1.118" />
<PackageVersion Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.5.0" /> <PackageVersion Include="Swashbuckle.AspNetCore.Annotations" Version="6.6.2" />
<PackageVersion Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.6.2" />
<PackageVersion Include="System.Buffers" Version="4.5.1" /> <PackageVersion Include="System.Buffers" Version="4.5.1" />
<PackageVersion Include="System.Configuration.ConfigurationManager" Version="6.0.1" /> <PackageVersion Include="System.Configuration.ConfigurationManager" Version="6.0.1" />
<PackageVersion Include="System.Data.SQLite.Core.Servarr" Version="1.0.115.5-18" /> <PackageVersion Include="System.Data.SQLite.Core.Servarr" Version="1.0.115.5-18" />

@ -7,6 +7,7 @@ using NzbDrone.Core.Books;
using NzbDrone.Core.MediaCover; using NzbDrone.Core.MediaCover;
using Readarr.Api.V1.Author; using Readarr.Api.V1.Author;
using Readarr.Http.REST; using Readarr.Http.REST;
using Swashbuckle.AspNetCore.Annotations;
namespace Readarr.Api.V1.Books namespace Readarr.Api.V1.Books
{ {
@ -38,6 +39,7 @@ namespace Readarr.Api.V1.Books
//Hiding this so people don't think its usable (only used to set the initial state) //Hiding this so people don't think its usable (only used to set the initial state)
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
[SwaggerIgnore]
public bool Grabbed { get; set; } public bool Grabbed { get; set; }
} }

@ -5,6 +5,7 @@ using Newtonsoft.Json;
using NzbDrone.Core.Books; using NzbDrone.Core.Books;
using NzbDrone.Core.MediaCover; using NzbDrone.Core.MediaCover;
using Readarr.Http.REST; using Readarr.Http.REST;
using Swashbuckle.AspNetCore.Annotations;
namespace Readarr.Api.V1.Books namespace Readarr.Api.V1.Books
{ {
@ -33,6 +34,7 @@ namespace Readarr.Api.V1.Books
//Hiding this so people don't think its usable (only used to set the initial state) //Hiding this so people don't think its usable (only used to set the initial state)
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
[SwaggerIgnore]
public bool Grabbed { get; set; } public bool Grabbed { get; set; }
} }

@ -9,10 +9,11 @@
<ProjectReference Include="..\NzbDrone.SignalR\Readarr.SignalR.csproj" /> <ProjectReference Include="..\NzbDrone.SignalR\Readarr.SignalR.csproj" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="System.Reflection.TypeExtensions" />
<PackageReference Include="FluentValidation" /> <PackageReference Include="FluentValidation" />
<PackageReference Include="Ical.Net" /> <PackageReference Include="Ical.Net" />
<PackageReference Include="NLog" /> <PackageReference Include="NLog" />
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" />
<PackageReference Include="System.IO.Abstractions" /> <PackageReference Include="System.IO.Abstractions" />
<PackageReference Include="System.Reflection.TypeExtensions" />
</ItemGroup> </ItemGroup>
</Project> </Project>

Loading…
Cancel
Save