From 8670863810e10dd85bc75f6973fb7a28aa22c1bc Mon Sep 17 00:00:00 2001 From: Glax Date: Fri, 18 Oct 2024 17:51:53 +0200 Subject: [PATCH] Add Job and ProgressToken Types to docs --- docs/API_Calls_v2.md | 8 ++++---- docs/Types.md | 25 ++++++++++++++++++++++--- 2 files changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/API_Calls_v2.md b/docs/API_Calls_v2.md index 559acca..3f167c5 100644 --- a/docs/API_Calls_v2.md +++ b/docs/API_Calls_v2.md @@ -305,7 +305,7 @@ Returns the latest Chapter of the specified Manga. ### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs` -Returns all configured Jobs. +Returns all configured Jobs as IDs.
Returns @@ -315,7 +315,7 @@ Returns all configured Jobs. ### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Running` -Returns all Running Jobs. +Returns all Running Jobs as IDs.
Returns @@ -325,7 +325,7 @@ Returns all Running Jobs. ### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Waiting` -Returns all Waiting Jobs. +Returns all Waiting Jobs as IDs.
Returns @@ -335,7 +335,7 @@ Returns all Waiting Jobs. ### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Monitoring` -Returns all Monitoring Jobs. +Returns all Monitoring Jobs as IDs.
Returns diff --git a/docs/Types.md b/docs/Types.md index 360a8c6..8ae0c0c 100644 --- a/docs/Types.md +++ b/docs/Types.md @@ -25,9 +25,9 @@ "folderName": string, "publicationId": string, "internalId": string, - "ignoreChaptersBelow": decimal, - "latestChapterDownloaded": decimal, - "latestChapterAvailable": decimal, + "ignoreChaptersBelow": number, + "latestChapterDownloaded": number, + "latestChapterAvailable": number, "websiteUrl": string, "mangaConnector": Connector } @@ -42,12 +42,31 @@ ## Job ``` { + jobType: number, + mangaInternalId: string, + translatedLanguage: string, + progressToken: ProgressToken, + recurring: boolean, + recurrenceTime: string, + lastExecution: Date, + nextExecution: Date, + id: string, + parentJobId: string | null, + mangaConnector: Connector } ``` ## ProgressToken ``` { + cancellationRequested: boolean, + increments: number, + incrementsCompleted: number, + progress: number, + lastUpdate: Date, + executionStarted: Date, + timeRemaining: Date, + state: number } ```