2024-10-17 21:03:37 +02:00
|
|
|
## Connector
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"name": string,
|
2024-10-18 00:48:46 +02:00
|
|
|
"SupportedLanguages": string[],
|
2024-10-18 00:48:58 +02:00
|
|
|
"BaseUris": string[]
|
2024-10-17 21:03:37 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Manga
|
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-18 00:29:29 +02:00
|
|
|
"sortName": string,
|
|
|
|
"authors": string[],
|
|
|
|
"altTitles": string[][],
|
|
|
|
"description": string,
|
|
|
|
"tags": string[],
|
|
|
|
"coverUrl": string,
|
|
|
|
"coverFileNameInCache": string,
|
|
|
|
"links": string[][],
|
|
|
|
"year": int,
|
|
|
|
"originalLanguage": string,
|
2024-10-20 01:08:22 +02:00
|
|
|
"releaseStatus": ReleaseStatus, see ReleaseStatus
|
2024-10-18 00:29:29 +02:00
|
|
|
"folderName": string,
|
|
|
|
"publicationId": string,
|
|
|
|
"internalId": string,
|
2024-10-18 17:51:53 +02:00
|
|
|
"ignoreChaptersBelow": number,
|
|
|
|
"latestChapterDownloaded": number,
|
|
|
|
"latestChapterAvailable": number,
|
2024-10-18 00:29:29 +02:00
|
|
|
"websiteUrl": string,
|
|
|
|
"mangaConnector": Connector
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Chapter
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 18:32:49 +02:00
|
|
|
"parentManga": IManga,
|
|
|
|
"name": string | undefined,
|
|
|
|
"volumeNumber": string,
|
|
|
|
"chapterNumber": string,
|
|
|
|
"url": string,
|
2024-10-27 03:39:40 +01:00
|
|
|
"fileName": string,
|
|
|
|
"id": string?
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-10-20 20:58:59 +02:00
|
|
|
### ReleaseStatus
|
2024-10-18 19:31:09 +02:00
|
|
|
```
|
|
|
|
{
|
|
|
|
Continuing = 0,
|
|
|
|
Completed = 1,
|
|
|
|
OnHiatus = 2,
|
|
|
|
Cancelled = 3,
|
|
|
|
Unreleased = 4
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-04-19 21:23:15 +02:00
|
|
|
## Job
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 18:32:49 +02:00
|
|
|
"progressToken": IProgressToken,
|
|
|
|
"recurring": boolean,
|
|
|
|
"recurrenceTime": string,
|
|
|
|
"lastExecution": Date,
|
|
|
|
"nextExecution": Date,
|
|
|
|
"id": string,
|
|
|
|
"jobType": number, //see JobType
|
|
|
|
"parentJobId": string | null,
|
|
|
|
"mangaConnector": IMangaConnector,
|
|
|
|
"mangaInternalId": string | undefined, //only on DownloadNewChapters
|
|
|
|
"translatedLanguage": string | undefined, //only on DownloadNewChapters
|
|
|
|
"chapter": IChapter | undefined, //only on DownloadChapter
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-10-20 20:58:59 +02:00
|
|
|
### JobType
|
2024-10-20 01:08:22 +02:00
|
|
|
```
|
|
|
|
{
|
|
|
|
DownloadChapterJob = 0,
|
|
|
|
DownloadNewChaptersJob = 1,
|
|
|
|
UpdateMetaDataJob = 2,
|
|
|
|
MonitorManga = 3
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-04-19 21:23:15 +02:00
|
|
|
## ProgressToken
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 18:32:49 +02:00
|
|
|
"cancellationRequested": boolean,
|
|
|
|
"increments": number,
|
|
|
|
"incrementsCompleted": number,
|
|
|
|
"progress": number,
|
|
|
|
"lastUpdate": Date,
|
|
|
|
"executionStarted": Date,
|
|
|
|
"timeRemaining": Date,
|
2024-10-20 20:58:59 +02:00
|
|
|
"state": number //see ProgressState
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
### ProgressState
|
|
|
|
```
|
|
|
|
{
|
|
|
|
Running = 0,
|
|
|
|
Complete = 1,
|
|
|
|
Standby = 2,
|
|
|
|
Cancelled = 3,
|
|
|
|
Waiting = 4
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Settings
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 18:32:57 +02:00
|
|
|
"downloadLocation": string,
|
|
|
|
"workingDirectory": string,
|
|
|
|
"apiPortNumber": number,
|
|
|
|
"userAgent": string,
|
|
|
|
"bufferLibraryUpdates": boolean,
|
|
|
|
"bufferNotifications": boolean,
|
|
|
|
"version": number,
|
|
|
|
"aprilFoolsMode": boolean,
|
2024-10-27 03:40:07 +01:00
|
|
|
"compressImages": boolean,
|
|
|
|
"bwImages": boolean,
|
2024-10-20 18:32:57 +02:00
|
|
|
"requestLimits": {
|
|
|
|
"MangaInfo": number,
|
|
|
|
"MangaDexFeed": number,
|
|
|
|
"MangaDexImage": number,
|
|
|
|
"MangaImage": number,
|
|
|
|
"MangaCover": number,
|
|
|
|
"Default": number
|
|
|
|
}
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## LibraryConnector
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 18:53:03 +02:00
|
|
|
"libraryType": number, //see LibraryType
|
|
|
|
"baseUrl": string,
|
|
|
|
"auth": string
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-10-20 20:58:59 +02:00
|
|
|
### LibraryType
|
2024-10-20 18:53:03 +02:00
|
|
|
```
|
|
|
|
{
|
|
|
|
Komga = 0,
|
|
|
|
Kavita = 1
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## NotificationConnector
|
2024-10-17 21:03:37 +02:00
|
|
|
```
|
2024-04-19 21:23:15 +02:00
|
|
|
{
|
2024-10-20 20:43:40 +02:00
|
|
|
"notificationConnectorType": number, //see NotificationConnectorType
|
|
|
|
"endpoint": string, //only on Ntfy, Gotify
|
|
|
|
"appToken": string, //only on Gotify
|
|
|
|
"auth": string, //only on Ntfy
|
|
|
|
"topic": string, //only on Ntfy
|
|
|
|
"id": string, //only on LunaSea
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2024-10-20 20:58:59 +02:00
|
|
|
### NotificationConnectorType
|
2024-10-20 20:43:40 +02:00
|
|
|
```
|
|
|
|
{
|
|
|
|
Gotify = 0,
|
|
|
|
LunaSea = 1,
|
|
|
|
Ntfy = 2
|
2024-04-19 21:23:15 +02:00
|
|
|
}
|
|
|
|
```
|