Update endpoints

tranga-website/src/api/V2.ts

@@ -14,8 +14,13 @@ import {
     Author,
     Chapter,
     CoverSize,
+    CreateGotifyConnectorRecord,
+    CreateLibraryConnectorRecord,
+    CreateLibraryRecord,
+    CreateNotificationConnectorRecord,
+    CreateNtfyConnectorRecord,
+    CreatePushoverConnectorRecord,
     FileLibrary,
-    GotifyRecord,
     LibraryConnector,
     Manga,
     MangaConnector,
@@ -24,9 +29,7 @@ import {
     MetadataSearchResult,
     MinimalManga,
     NotificationConnector,
-    NtfyRecord,
     ProblemDetails,
-    PushoverRecord,
     RequestType,
     TrangaSettings,
     Worker,
@@ -40,7 +43,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags FileLibrary
      * @name FileLibraryList
-     * @summary Returns all API.Schema.MangaContext.FileLibrary
+     * @summary Returns all API.Controllers.DTOs.FileLibrary
      * @request GET:/v2/FileLibrary
      */
     fileLibraryList = (params: RequestParams = {}) =>
@@ -55,10 +58,10 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags FileLibrary
      * @name FileLibraryUpdate
-     * @summary Creates new API.Schema.MangaContext.FileLibrary
+     * @summary Creates new API.Controllers.DTOs.FileLibrary
      * @request PUT:/v2/FileLibrary
      */
-    fileLibraryUpdate = (data: FileLibrary, params: RequestParams = {}) =>
+    fileLibraryUpdate = (data: CreateLibraryRecord, params: RequestParams = {}) =>
         this.request<void, string>({
             path: `/v2/FileLibrary`,
             method: 'PUT',
@@ -71,7 +74,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags FileLibrary
      * @name FileLibraryDetail
-     * @summary Returns API.Schema.MangaContext.FileLibrary with FileLibraryId
+     * @summary Returns API.Controllers.DTOs.FileLibrary with FileLibraryId
      * @request GET:/v2/FileLibrary/{FileLibraryId}
      */
     fileLibraryDetail = (fileLibraryId: string, params: RequestParams = {}) =>
@@ -140,7 +143,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags LibraryConnector
      * @name LibraryConnectorList
-     * @summary Gets all configured API.Schema.LibraryContext.LibraryConnectors.LibraryConnector
+     * @summary Gets all configured API.Controllers.DTOs.LibraryConnector
      * @request GET:/v2/LibraryConnector
      */
     libraryConnectorList = (params: RequestParams = {}) =>
@@ -155,10 +158,10 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags LibraryConnector
      * @name LibraryConnectorUpdate
-     * @summary Creates a new API.Schema.LibraryContext.LibraryConnectors.LibraryConnector
+     * @summary Creates a new API.Controllers.DTOs.LibraryConnector
      * @request PUT:/v2/LibraryConnector
      */
-    libraryConnectorUpdate = (data: LibraryConnector, params: RequestParams = {}) =>
+    libraryConnectorUpdate = (data: CreateLibraryConnectorRecord, params: RequestParams = {}) =>
         this.request<string, string>({
             path: `/v2/LibraryConnector`,
             method: 'PUT',
@@ -171,7 +174,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags LibraryConnector
      * @name LibraryConnectorDetail
-     * @summary Returns API.Schema.LibraryContext.LibraryConnectors.LibraryConnector with LibraryConnectorId
+     * @summary Returns API.Controllers.DTOs.LibraryConnector with LibraryConnectorId
      * @request GET:/v2/LibraryConnector/{LibraryConnectorId}
      */
     libraryConnectorDetail = (libraryConnectorId: string, params: RequestParams = {}) =>
@@ -186,7 +189,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags LibraryConnector
      * @name LibraryConnectorDelete
-     * @summary Deletes API.Schema.LibraryContext.LibraryConnectors.LibraryConnector with LibraryConnectorId
+     * @summary Deletes API.Controllers.DTOs.LibraryConnector with LibraryConnectorId
      * @request DELETE:/v2/LibraryConnector/{LibraryConnectorId}
      */
     libraryConnectorDelete = (libraryConnectorId: string, params: RequestParams = {}) =>
@@ -429,7 +432,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags Manga
      * @name MangaChangeLibraryCreate
-     * @summary Move API.Controllers.DTOs.Manga to different API.Schema.MangaContext.FileLibrary
+     * @summary Move API.Controllers.DTOs.Manga to different API.Controllers.DTOs.FileLibrary
      * @request POST:/v2/Manga/{MangaId}/ChangeLibrary/{LibraryId}
      */
     mangaChangeLibraryCreate = (mangaId: string, libraryId: string, params: RequestParams = {}) =>
@@ -681,7 +684,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorList
-     * @summary Gets all configured API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector
+     * @summary Gets all configured API.Controllers.DTOs.NotificationConnector
      * @request GET:/v2/NotificationConnector
      */
     notificationConnectorList = (params: RequestParams = {}) =>
@@ -696,16 +699,18 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorUpdate
-     * @summary Creates a new API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector
+     * @summary Creates a new API.Controllers.DTOs.NotificationConnector
      * @request PUT:/v2/NotificationConnector
      */
-    notificationConnectorUpdate = (data: NotificationConnector, params: RequestParams = {}) =>
+    notificationConnectorUpdate = (
-        this.request<string, string>({
+        data: CreateNotificationConnectorRecord,
+        params: RequestParams = {}
+    ) =>
+        this.request<void, string>({
             path: `/v2/NotificationConnector`,
             method: 'PUT',
             body: data,
             type: ContentType.Json,
-            format: 'json',
             ...params,
         });
     /**
@@ -713,7 +718,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorDetail
-     * @summary Returns API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector with requested Name
+     * @summary Returns API.Controllers.DTOs.NotificationConnector with requested Name
      * @request GET:/v2/NotificationConnector/{Name}
      */
     notificationConnectorDetail = (name: string, params: RequestParams = {}) =>
@@ -728,7 +733,7 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorDelete
-     * @summary Deletes the API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector with the requested Name
+     * @summary Deletes the API.Controllers.DTOs.NotificationConnector with the requested Name
      * @request DELETE:/v2/NotificationConnector/{Name}
      */
     notificationConnectorDelete = (name: string, params: RequestParams = {}) =>
@@ -742,16 +747,18 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorGotifyUpdate
-     * @summary Creates a new Gotify-API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector
+     * @summary Creates a new Gotify-API.Controllers.DTOs.NotificationConnector
      * @request PUT:/v2/NotificationConnector/Gotify
      */
-    notificationConnectorGotifyUpdate = (data: GotifyRecord, params: RequestParams = {}) =>
+    notificationConnectorGotifyUpdate = (
-        this.request<string, string>({
+        data: CreateGotifyConnectorRecord,
+        params: RequestParams = {}
+    ) =>
+        this.request<void, string>({
             path: `/v2/NotificationConnector/Gotify`,
             method: 'PUT',
             body: data,
             type: ContentType.Json,
-            format: 'json',
             ...params,
         });
     /**
@@ -759,16 +766,18 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorNtfyUpdate
-     * @summary Creates a new Ntfy-API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector
+     * @summary Creates a new Ntfy-API.Controllers.DTOs.NotificationConnector
      * @request PUT:/v2/NotificationConnector/Ntfy
      */
-    notificationConnectorNtfyUpdate = (data: NtfyRecord, params: RequestParams = {}) =>
+    notificationConnectorNtfyUpdate = (
-        this.request<string, string>({
+        data: CreateNtfyConnectorRecord,
+        params: RequestParams = {}
+    ) =>
+        this.request<void, string>({
             path: `/v2/NotificationConnector/Ntfy`,
             method: 'PUT',
             body: data,
             type: ContentType.Json,
-            format: 'json',
             ...params,
         });
     /**
@@ -776,16 +785,18 @@ export class V2<SecurityDataType = unknown> extends HttpClient<SecurityDataType>
      *
      * @tags NotificationConnector
      * @name NotificationConnectorPushoverUpdate
-     * @summary Creates a new Pushover-API.Schema.NotificationsContext.NotificationConnectors.NotificationConnector
+     * @summary Creates a new Pushover-API.Controllers.DTOs.NotificationConnector
      * @request PUT:/v2/NotificationConnector/Pushover
      */
-    notificationConnectorPushoverUpdate = (data: PushoverRecord, params: RequestParams = {}) =>
+    notificationConnectorPushoverUpdate = (
-        this.request<string, string>({
+        data: CreatePushoverConnectorRecord,
+        params: RequestParams = {}
+    ) =>
+        this.request<void, string>({
             path: `/v2/NotificationConnector/Pushover`,
             method: 'PUT',
             body: data,
             type: ContentType.Json,
-            format: 'json',
             ...params,
         });
     /**

tranga-website/src/api/data-contracts.ts

@@ -111,46 +111,170 @@ export interface Chapter {
     key: string;
 }
 
-export interface FileLibrary {
+export interface CreateGotifyConnectorRecord {
     /**
-     * @minLength 0
+     * The Name of the Notification Connector
-     * @maxLength 256
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The Url of the Instance
+     * @format uri
+     * @minLength 1
+     */
+    url: string;
+    /**
+     * The Apptoken used for authentication
+     * @minLength 1
+     */
+    appToken: string;
+    /**
+     * The Priority of Notifications
+     * @format int32
+     */
+    priority: number;
+}
+
+export interface CreateLibraryConnectorRecord {
+    libraryType: LibraryType;
+    /**
+     * The Url of the Library instance
+     * @format uri
+     * @minLength 1
+     */
+    url: string;
+    /**
+     * The Username to authenticate to the Library instance
+     * @minLength 1
+     */
+    username: string;
+    /**
+     * The Password to authenticate to the Library instance
+     * @minLength 1
+     */
+    password: string;
+}
+
+export interface CreateLibraryRecord {
+    /**
+     * The directory Path of the library
+     * @minLength 1
      */
     basePath: string;
     /**
-     * @minLength 0
+     * The Name of the library
-     * @maxLength 512
+     * @minLength 1
+     */
+    libraryName: string;
+}
+
+export interface CreateNotificationConnectorRecord {
+    /**
+     * The Name of the Notification Connector
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The Url of the Instance
+     * @format uri
+     * @minLength 1
+     */
+    url: string;
+    /**
+     * The HTTP Request Method to use for notifications
+     * @minLength 1
+     */
+    httpMethod: string;
+    /**
+     * The Request Body to use to send notifications
+     * @minLength 1
+     */
+    body: string;
+    /** The Request Headers to use to send notifications */
+    headers: Record<string, string>;
+}
+
+export interface CreateNtfyConnectorRecord {
+    /**
+     * The Name of the Notification Connector
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The Url of the Instance
+     * @format uri
+     * @minLength 1
+     */
+    url: string;
+    /**
+     * The Priority of Notifications
+     * @format int32
+     */
+    priority: number;
+    /**
+     * The Username used for authentication
+     * @minLength 1
+     */
+    username: string;
+    /**
+     * The Password used for authentication
+     * @minLength 1
+     */
+    password: string;
+    /**
+     * The Topic of Notifications
+     * @minLength 1
+     */
+    topic: string;
+}
+
+export interface CreatePushoverConnectorRecord {
+    /**
+     * The Name of the Notification Connector
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The Apptoken used for authentication
+     * @minLength 1
+     */
+    appToken: string;
+    /**
+     * The Username used for authentication
+     * @minLength 1
+     */
+    username: string;
+}
+
+export interface FileLibrary {
+    /**
+     * The directory Path of the library
+     * @minLength 1
+     */
+    basePath: string;
+    /**
+     * The Name of the library
+     * @minLength 1
      */
     libraryName: string;
     /**
+     * Unique Identifier of the DTO
      * @minLength 16
      * @maxLength 64
      */
     key: string;
 }
 
-export interface GotifyRecord {
-    name?: string | null;
-    endpoint?: string | null;
-    appToken?: string | null;
-    /** @format int32 */
-    priority?: number;
-}
-
 export interface LibraryConnector {
-    libraryType: LibraryType;
     /**
+     * The Url of the Library instance
      * @format uri
-     * @minLength 0
+     * @minLength 1
-     * @maxLength 256
      */
     baseUrl: string;
+    type: LibraryType;
     /**
-     * @minLength 0
+     * Unique Identifier of the DTO
-     * @maxLength 256
-     */
-    auth: string;
-    /**
      * @minLength 16
      * @maxLength 64
      */
@@ -309,37 +433,34 @@ export interface MinimalManga {
 
 export interface NotificationConnector {
     /**
-     * @minLength 0
+     * The Name of the Notification Connector
-     * @maxLength 64
+     * @minLength 1
      */
     name: string;
     /**
+     * The Url of the Instance
      * @format uri
-     * @minLength 0
+     * @minLength 1
-     * @maxLength 2048
      */
     url: string;
-    headers: Record<string, string>;
     /**
-     * @minLength 0
+     * The HTTP Request Method to use for notifications
-     * @maxLength 8
+     * @minLength 1
      */
     httpMethod: string;
     /**
-     * @minLength 0
+     * The Request Body to use to send notifications
-     * @maxLength 4096
+     * @minLength 1
      */
     body: string;
-}
+    /** The Request Headers to use to send notifications */
-
+    headers: Record<string, string>;
-export interface NtfyRecord {
+    /**
-    name?: string | null;
+     * Unique Identifier of the DTO
-    endpoint?: string | null;
+     * @minLength 16
-    username?: string | null;
+     * @maxLength 64
-    password?: string | null;
+     */
-    topic?: string | null;
+    key: string;
-    /** @format int32 */
-    priority?: number;
 }
 
 export interface ProblemDetails {
@@ -352,12 +473,6 @@ export interface ProblemDetails {
     [key: string]: any;
 }
 
-export interface PushoverRecord {
-    name?: string | null;
-    appToken?: string | null;
-    user?: string | null;
-}
-
 export interface TrangaSettings {
     downloadLocation?: string | null;
     userAgent?: string | null;