Add Job and ProgressToken Types to docs

This commit is contained in:
Glax 2024-10-18 17:51:53 +02:00
parent 2c9bd2532e
commit 8670863810
2 changed files with 26 additions and 7 deletions

View File

@ -305,7 +305,7 @@ Returns the latest Chapter of the specified Manga.
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Jobs`
Returns all configured Jobs.
Returns all configured Jobs as IDs.
<details>
<summary>Returns</summary>
@ -315,7 +315,7 @@ Returns all configured Jobs.
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Jobs/Running`
Returns all Running Jobs.
Returns all Running Jobs as IDs.
<details>
<summary>Returns</summary>
@ -325,7 +325,7 @@ Returns all Running Jobs.
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Jobs/Waiting`
Returns all Waiting Jobs.
Returns all Waiting Jobs as IDs.
<details>
<summary>Returns</summary>
@ -335,7 +335,7 @@ Returns all Waiting Jobs.
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Jobs/Monitoring`
Returns all Monitoring Jobs.
Returns all Monitoring Jobs as IDs.
<details>
<summary>Returns</summary>

View File

@ -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
}
```