Descriptions for Records and DTOs

API/Controllers/DTOs/FileLibrary.cs

@@ -1,14 +1,21 @@
+using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 
 namespace API.Controllers.DTOs;
 
 public sealed record FileLibrary(string Key, string BasePath, string LibraryName) : Identifiable(Key)
 {
-    [StringLength(256)]
+    /// <summary>
+    /// The directory Path of the library
+    /// </summary>
     [Required]
+    [Description("The directory Path of the library")]
     public string BasePath { get; internal set; } = BasePath;
 
-    [StringLength(512)]
+    /// <summary>
+    /// The Name of the library
+    /// </summary>
     [Required]
+    [Description("The Name of the library")]
     public string LibraryName { get; internal set; } = LibraryName;
 }

API/Controllers/DTOs/LibraryConnector.cs

@@ -1,3 +1,4 @@
+using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using API.Schema.LibraryContext.LibraryConnectors;
 
@@ -5,11 +6,18 @@ namespace API.Controllers.DTOs;
 
 public record LibraryConnector(string Key, string BaseUrl, LibraryType Type) : Identifiable(Key)
 {
-    [StringLength(256)]
+    /// <summary>
+    /// The Url of the Library instance
+    /// </summary>
     [Required]
     [Url]
-    public string BaseUrl {get; init;} =  BaseUrl;
+    [Description("The Url of the Library instance")]
+    public string BaseUrl { get; init;} =  BaseUrl;
 
+    /// <summary>
+    /// The <see cref="LibraryType"/>
+    /// </summary>
     [Required]
+    [Description("The Library Type")]
     public LibraryType Type { get; init; } = Type;
 }

API/Controllers/FileLibraryController.cs

@@ -1,4 +1,5 @@
-using API.Schema.MangaContext;
+using API.Controllers.Requests;
+using API.Schema.MangaContext;
 using Asp.Versioning;
 using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
@@ -120,7 +121,6 @@ public class FileLibraryController(MangaContext context) : Controller
         
         return TypedResults.Created(string.Empty, library.Key);
     }
-    public sealed record CreateLibraryRecord(string BasePath, string LibraryName);
     
     /// <summary>
     /// Deletes the <see cref="FileLibraryId"/>.LibraryName with <paramref name="FileLibraryId"/>

API/Controllers/LibraryConnectorController.cs

@@ -1,4 +1,5 @@
-using API.Schema.LibraryContext;
+using API.Controllers.Requests;
+using API.Schema.LibraryContext;
 using API.Schema.LibraryContext.LibraryConnectors;
 using Asp.Versioning;
 using Microsoft.AspNetCore.Http.HttpResults;
@@ -75,7 +76,6 @@ public class LibraryConnectorController(LibraryContext context) : Controller
             return TypedResults.InternalServerError(result.exceptionMessage);
         return TypedResults.Created(string.Empty, connector.Key);
     }
-    public sealed record CreateLibraryConnectorRecord(LibraryType LibraryType, string Url, string Username, string Password);
     
     /// <summary>
     /// Deletes <see cref="LibraryConnector"/> with <paramref name="LibraryConnectorId"/>

API/Controllers/MangaController.cs

@@ -1,5 +1,4 @@
-using System.Diagnostics.CodeAnalysis;
-using API.Controllers.DTOs;
+using API.Controllers.DTOs;
 using API.Schema.MangaContext;
 using API.Workers;
 using Asp.Versioning;

API/Controllers/Requests/CreateLibraryConnectorRecord.cs

@@ -0,0 +1,37 @@
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+using API.Schema.LibraryContext.LibraryConnectors;
+
+namespace API.Controllers.Requests;
+
+public sealed record CreateLibraryConnectorRecord(LibraryType LibraryType, string Url, string Username, string Password)
+{
+    /// <summary>
+    /// The <see cref="LibraryType"/>
+    /// </summary>
+    [Required]
+    [Description("The Library Type")]
+    public LibraryType LibraryType { get; init; } = LibraryType;
+    
+    /// <summary>
+    /// The Url of the Library instance
+    /// </summary>
+    [Required]
+    [Url]
+    [Description("The Url of the Library instance")]
+    public string Url { get; init; } = Url;
+    
+    /// <summary>
+    /// The Username to authenticate to the Library instance
+    /// </summary>
+    [Required]
+    [Description("The Username to authenticate to the Library instance")]
+    public string Username { get; init; } = Username;
+    
+    /// <summary>
+    /// The Password to authenticate to the Library instance
+    /// </summary>
+    [Required]
+    [Description("The Password to authenticate to the Library instance")]
+    public string Password { get; init; } = Password;
+}

API/Controllers/Requests/CreateLibraryRecord.cs

@@ -0,0 +1,21 @@
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+
+namespace API.Controllers.Requests;
+
+public sealed record CreateLibraryRecord(string BasePath, string LibraryName)
+{
+    /// <summary>
+    /// The directory Path of the library
+    /// </summary>
+    [Required]
+    [Description("The directory Path of the library")]
+    public string BasePath { get; init; } = BasePath;
+    
+    /// <summary>
+    /// The Name of the library
+    /// </summary>
+    [Required]
+    [Description("The Name of the library")]
+    public string LibraryName { get; init; } = LibraryName;
+}