Swagger: Creating a swagger module

Kyoo.sln

@@ -23,6 +23,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Host.WindowsTrait", "s
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Host.Console", "src\Kyoo.Host.Console\Kyoo.Host.Console.csproj", "{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Swagger", "src\Kyoo.Swagger\Kyoo.Swagger.csproj", "{7D1A7596-73F6-4D35-842E-A5AD9C620596}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -81,5 +83,9 @@ Global
 		{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal

src/Directory.Build.props

@@ -1,4 +1,14 @@
 <Project>
+	<PropertyGroup>
+		<Company>Kyoo</Company>
+		<Authors>Kyoo</Authors>
+		<Copyright>Copyright (c) Kyoo</Copyright>
+		<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
+		<RequireLicenseAcceptance>true</RequireLicenseAcceptance>
+		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
+		<RepositoryType>git</RepositoryType>
+	</PropertyGroup>
+
 	<PropertyGroup>
 		<IsWindows Condition="$([MSBuild]::IsOSPlatform('Windows'))">true</IsWindows>
 		<IsOSX Condition="$([MSBuild]::IsOSPlatform('OSX'))">true</IsOSX>
@@ -11,6 +21,10 @@
 		<CheckCodingStyle Condition="$(CheckCodingStyle) == ''">true</CheckCodingStyle>
 	</PropertyGroup>
 
+	<ItemGroup>
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.0-beta-20204-02" PrivateAssets="All" />
+	</ItemGroup>
+
 	<ItemGroup Condition="$(CheckCodingStyle) == true">
 		<PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
 		<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.354" PrivateAssets="All" />

src/Kyoo.Abstractions/Kyoo.Abstractions.csproj

@@ -24,7 +24,6 @@
 		<PackageReference Include="Microsoft.AspNetCore.Mvc.Abstractions" Version="2.2.0" />
 		<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="5.0.0" />
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="5.0.0" />
-		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.0-beta-20204-02" PrivateAssets="All" />
 		<PackageReference Include="System.ComponentModel.Composition" Version="5.0.0" />
 	</ItemGroup>
 

src/Kyoo.Core/Kyoo.Core.csproj

@@ -1,13 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
-		<TranscoderRoot>../Kyoo.Transcoder/</TranscoderRoot>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.Core</AssemblyName>
+		<RootNamespace>Kyoo.Core</RootNamespace>
+		<TranscoderRoot>../Kyoo.Transcoder/</TranscoderRoot>
 	</PropertyGroup>
 
 	<PropertyGroup>

src/Kyoo.Database/Kyoo.Database.csproj

@@ -1,12 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
+		<LangVersion>default</LangVersion>
 		<AssemblyName>Kyoo.Database</AssemblyName>
 		<RootNamespace>Kyoo.Database</RootNamespace>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
-		<LangVersion>default</LangVersion>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -19,5 +16,4 @@
 	<ItemGroup>
 	  <ProjectReference Include="../Kyoo.Abstractions/Kyoo.Abstractions.csproj" />
 	</ItemGroup>
-
 </Project>

src/Kyoo.Host.Console/Kyoo.Host.Console.csproj

@@ -2,23 +2,21 @@
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
 		<TargetFramework>net5.0</TargetFramework>
-		<StartupObject>Kyoo.Host.Console.Program</StartupObject>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.Host.Console</AssemblyName>
+		<RootNamespace>Kyoo.Host.Console</RootNamespace>
+		<StartupObject>Kyoo.Host.Console.Program</StartupObject>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="$(IncludeConsole) == true">
-		<!-- 
+		<!--
-			IncludeConsole is a property used when deploying the windows host. Since the runtime identifier is removed, 
+			IncludeConsole is a property used when deploying the windows host. Since the runtime identifier is removed,
 			we specify it manually. This is kindy hacky but MsBuild does not really work well with multiples exe output
 			and we need multiples exe with the same shared framework (SelfContained).
 		 -->
 		<RuntimeIdentifier>win-x64</RuntimeIdentifier>
 	</PropertyGroup>
-	
+
 	<ItemGroup>
 		<ProjectReference Include="../Kyoo.Core/Kyoo.Core.csproj" />
 	</ItemGroup>

src/Kyoo.Host.WindowsTrait/Kyoo.Host.WindowsTrait.csproj

@@ -4,8 +4,10 @@
 	<PropertyGroup Condition="$(IsWindows) == true">
 		<OutputType>WinExe</OutputType>
 		<TargetFramework>net5.0-windows</TargetFramework>
+		<LangVersion>default</LangVersion>
 		<UseWindowsForms>true</UseWindowsForms>
-		<RootNamespace>Kyoo.WindowsHost</RootNamespace>
+		<AssemblyName>Kyoo.Host.WindowsTrait</AssemblyName>
+		<RootNamespace>Kyoo.Host.WindowsTrait</RootNamespace>
 	</PropertyGroup>
 	<ItemGroup Condition="$(IsWindows) == true">
 		<ProjectReference Include="../Kyoo.Core/Kyoo.Core.csproj" />

src/Kyoo.Postgresql/Kyoo.Postgresql.csproj

@@ -1,11 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.Postgresql</AssemblyName>
+		<RootNamespace>Kyoo.Postgresql</RootNamespace>
 	</PropertyGroup>
 
 	<ItemGroup>

src/Kyoo.SqLite/Kyoo.SqLite.csproj

@@ -1,24 +1,18 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.SqLite</AssemblyName>
 		<RootNamespace>Kyoo.SqLite</RootNamespace>
 	</PropertyGroup>
-	
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="5.0.8">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="5.0.8" />
-	</ItemGroup>
+		<ProjectReference Include="../Kyoo.Database/Kyoo.Database.csproj" />
-
-	<ItemGroup>
-		<ProjectReference Include="..\Kyoo.Database\Kyoo.Database.csproj" />
 		<ProjectReference Include="../Kyoo.Abstractions/Kyoo.Abstractions.csproj" />
 	</ItemGroup>
 </Project>

src/Kyoo.Swagger/Kyoo.Swagger.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net5.0</TargetFramework>
+		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.Swagger</AssemblyName>
+		<RootNamespace>Kyoo.Swagger</RootNamespace>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.1" />
+		<ProjectReference Include="../Kyoo.Abstractions/Kyoo.Abstractions.csproj" />
+	</ItemGroup>
+</Project>

src/Kyoo.Swagger/SwaggerModule.cs

@@ -0,0 +1,27 @@
+// Kyoo - A portable and vast media library solution.
+// Copyright (c) Kyoo.
+//
+// See AUTHORS.md and LICENSE file in the project root for full license information.
+//
+// Kyoo is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// Kyoo is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
+
+namespace Kyoo.Swagger
+{
+	/// <summary>
+	/// A module to enable a swagger interface and an OpenAPI endpoint to document Kyoo.
+	/// </summary>
+	public class SwaggerModule
+	{
+	}
+}

src/Kyoo.TheMovieDb/Kyoo.TheMovieDb.csproj

@@ -1,11 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.TheMovieDb</AssemblyName>
 		<RootNamespace>Kyoo.TheMovieDb</RootNamespace>
 	</PropertyGroup>
 

src/Kyoo.TheTvdb/Kyoo.TheTvdb.csproj

@@ -1,11 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
 		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.TheTvdb</AssemblyName>
 		<RootNamespace>Kyoo.TheTvdb</RootNamespace>
 	</PropertyGroup>
 
@@ -14,9 +11,6 @@
 		<PackageReference Include="Microsoft.Extensions.Options" Version="5.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="5.0.0" />
 		<PackageReference Include="TvDbSharper" Version="3.2.2" />
-	</ItemGroup>
-	
-	<ItemGroup>
 		<ProjectReference Include="../Kyoo.Abstractions/Kyoo.Abstractions.csproj" />
 	</ItemGroup>
 </Project>

src/Kyoo.WebApp/Kyoo.WebApp.csproj

@@ -1,8 +1,12 @@
 <Project>
 	<Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" />
-	
+
 	<PropertyGroup>
 		<TargetFramework>net5.0</TargetFramework>
+		<LangVersion>default</LangVersion>
+		<AssemblyName>Kyoo.WebApp</AssemblyName>
+		<RootNamespace>Kyoo.WebApp</RootNamespace>
+
 		<TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
 		<TypeScriptToolsVersion>Latest</TypeScriptToolsVersion>
 		<IsPackable>false</IsPackable>
@@ -12,11 +16,6 @@
 
 		<!-- Set this to true if you enable server-side prerendering -->
 		<BuildServerSideRenderer>false</BuildServerSideRenderer>
-
-		<Company>SDG</Company>
-		<Authors>Zoe Roux</Authors>
-		<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
-		<LangVersion>default</LangVersion>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -41,7 +40,7 @@
 			<Output TaskParameter="ExitCode" PropertyName="ErrorCode" />
 		</Exec>
 		<Error Condition="'$(ErrorCode)' != '0'" Text="Node.js is required to build and run this project. To continue, please install Node.js from https://nodejs.org/, and then restart your command prompt or IDE." />
-		
+
 		<Message Importance="high" Text="Restoring dependencies using 'npm'. This may take several minutes..." />
 		<Exec WorkingDirectory="$(SpaRoot)" Command="npm install" />
 		<Touch Files="$(NpmStamp)" AlwaysCreate="true" />