glax/Tranga
1
0
Fork 0
mirror of https://github.com/C9Glax/tranga.git synced 2025-06-12 22:47:52 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Changed the Creation Job API to a single Endpoint /v2/Job/Create/<Type>

Browse Source 
Added and implemented GET /v2/Job/Types
Implemented /v2/Job/<jobId>
Implemented /v2/Job/<jobId>/StartNow
Implemented /v2/Job/<jobId>/Cancel
Implemented /v2/Job/<jobId>/SetInterval
This commit is contained in:
Glax
2024-04-22 00:00:35 +02:00
parent 6d48a100ca
commit 49cfff8a2f
4 changed files with 95 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/API_Calls_v2.md
View File

@ -218,39 +218,32 @@ Returns all Monitoring Jobs.
List of JobIds.
</details>
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/Monitor/<internalId>`
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Job/Types`
Creates a Monitoring-Job for the specified Manga at the specified Interval.
<details>
<summary>Request</summary>
`internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Job/*jobId*](#-v2jobjobid)
| Parameter | Value |
|-----------|--------------------------------------------------------|
| interval | Interval at which the Job is re-run in HH:MM:SS format |
</details>
Returns the valid Job-Types.
<details>
<summary>Returns</summary>
[Job](Types.md#job)
| StatusCode | Meaning |
|------------|--------------------------------------------|
| 404 | Manga with `internalId` could not be found |
| 500 | Error parsing interval |
List of strings.
</details>
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/DownloadNewChapters/<internalId>`
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Job/Create/<Type>`
Creates a Job to check for new Chapters and Download new ones of the specified Manga.
Creates a Job.
<details>
<summary>Request</summary>
`Type` is returned in the response of [GET /v2/Job/Types](#-v2jobtypes)
| Parameter | Value |
|------------|---------------------------------------------------------------------------------------------------|
| connector | Name of the connector to use |
| internalId | Manga ID |
| *interval* | Interval at which the Job is re-run in HH:MM:SS format<br />Only for MonitorManga, UpdateMetadata |
| *language* | Translated language<br />Only for MonitorManga, DownloadNewChapters and DownloadChapter |
`internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
@ -262,41 +255,10 @@ Creates a Job to check for new Chapters and Download new ones of the specified M
[Job](Types.md#job)
| StatusCode | Meaning |
|------------|--------------------------------------------|
| 404 | Manga with `internalId` could not be found |
</details>
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/UpdateMetadata`
Creates a Job to update the Metadata of all Manga.
<details>
<summary>Returns</summary>
[Job](Types.md#job)
</details>
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/UpdateMetadata/<internalId>`
Updates the Metadata of the specified Manga.
<details>
<summary>Request</summary>
`internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Job/*jobId*](#-v2jobjobid)
</details>
<details>
<summary>Returns</summary>
[Job](Types.md#job)
| StatusCode | Meaning |
|------------|--------------------------------------------|
| 404 | Manga with `internalId` could not be found |
| StatusCode | Meaning |
|------------|------------------------------------------|
| 404 | Parameter missing or could not be found. |
| 500 | Error parsing interval |
</details>
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Job/<jobId>`