glax/Tranga
2
0
Fork 0
Code

Github Reference Link Style

Browse Source
This commit is contained in:
Glax 2024-04-19 21:35:38 +02:00
parent 7e5fa6ce41
commit f5cecb9e30
1 changed files with 371 additions and 365 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
docs/API_Calls_v2.md
View File

@ -17,13 +17,13 @@ Parameters in *italics* are optional
### Quick Entry ### Quick Entry
* [Connectors](#connectors-suptopsup) * [Connectors](#connectors-top)
* [Manga](#manga-suptopsup) * [Manga](#manga-top)
* [Jobs](#jobs-suptopsup) * [Jobs](#jobs-top)
* [Settings](#settings-suptopsup) * [Settings](#settings-top)
* [Library Connectors](#library-connectors-suptopsup) * [Library Connectors](#library-connectors-top)
* [Notification Connectors](#notification-connectors-suptopsup) * [Notification Connectors](#notification-connectors-top)
* [Miscellaneous](#miscellaneous-suptopsup) * [Miscellaneous](#miscellaneous-top)
## Connectors <sup>[^top](#top)</sup> ## Connectors <sup>[^top](#top)</sup>
@ -33,6 +33,7 @@ Returns available Manga Connectors (Scanlation sites)
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
List of strings with Names. List of strings with Names.
</details> </details>
@ -43,7 +44,7 @@ Returns the Manga from the specified Manga Connector.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`ConnectorName` is returned in the response of [GET /v2/Connector/Types](#/v2/Connector) `ConnectorName` is returned in the response of [GET /v2/Connector/Types](#-v2connectortypes)
Use either `title` or `url` Parameter. Use either `title` or `url` Parameter.
@ -56,7 +57,7 @@ Use either `title` or `url` Parameter.
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
List of [Manga](Types.md/#Manga) List of [Manga](Types.md#Manga)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|--------------------------| |------------|--------------------------|
@ -74,18 +75,18 @@ Returns the specified Manga.
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Manga](Types.md/#manga) [Manga](Types.md#manga)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|--------------------------------------------| |------------|--------------------------------------------|
@ -100,12 +101,12 @@ Deletes all associated Jobs for the specified Manga
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
@ -125,12 +126,12 @@ Returns the URL for the Cover of the specified Manga.
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
@ -151,12 +152,12 @@ Returns the Chapter-list for the specified Manga.
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
@ -219,12 +220,12 @@ Creates a Monitoring-Job for the specified Manga at the specified Interval.
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
| Parameter | Value | | Parameter | Value |
|-----------|--------------------------------------------------------| |-----------|--------------------------------------------------------|
@ -234,7 +235,7 @@ Creates a Monitoring-Job for the specified Manga at the specified Interval.
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Job](Types.md/#job) [Job](Types.md#job)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|--------------------------------------------| |------------|--------------------------------------------|
@ -250,18 +251,18 @@ Creates a Job to check for new Chapters and Download new ones of the specified M
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Job](Types.md/#job) [Job](Types.md#job)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|--------------------------------------------| |------------|--------------------------------------------|
@ -275,7 +276,7 @@ Creates a Job to update the Metadata of all Manga.
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Job](Types.md/#job) [Job](Types.md#job)
</details> </details>
### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/UpdateMetadata/<internalId>` ### <sub>![POST](https://img.shields.io/badge/POST-00f)</sub> `/v2/Jobs/Create/UpdateMetadata/<internalId>`
@ -286,18 +287,18 @@ Updates the Metadata of the specified Manga.
<summary>Request</summary> <summary>Request</summary>
`internalId` is returned in the response of `internalId` is returned in the response of
* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) * [GET /v2/Jobs/*jobId*](#-v2jobs)
</details> </details>
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Job](Types.md/#job) [Job](Types.md#job)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|--------------------------------------------| |------------|--------------------------------------------|
@ -312,17 +313,16 @@ Returns the specified Job.
<summary>Request</summary> <summary>Request</summary>
`jobId` is returned in the response of `jobId` is returned in the response of
* [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring)
</details> </details>
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Job](Types.md/#job) [Job](Types.md#job)
| StatusCode | Meaning | | StatusCode | Meaning |
|------------|---------------------------------------| |------------|---------------------------------------|
@ -337,10 +337,10 @@ Deletes the specified Job and all descendants.
<summary>Request</summary> <summary>Request</summary>
`jobId` is returned in the response of `jobId` is returned in the response of
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
</details> </details>
<details> <details>
@ -360,10 +360,10 @@ Returns the progress the of the specified Job.
<summary>Request</summary> <summary>Request</summary>
`jobId` is returned in the response of `jobId` is returned in the response of
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
</details> </details>
<details> <details>
@ -384,10 +384,10 @@ Starts the specified Job.
<summary>Request</summary> <summary>Request</summary>
`jobId` is returned in the response of `jobId` is returned in the response of
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
</details> </details>
<details> <details>
@ -407,10 +407,10 @@ Cancels the specified Job, or dequeues it.
<summary>Request</summary> <summary>Request</summary>
`jobId` is returned in the response of `jobId` is returned in the response of
* [GET /v2/Jobs](#subsub-v2jobs) * [GET /v2/Jobs](#-v2jobs)
* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) * [GET /v2/Jobs/Running](#-v2jobsrunning)
* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) * [GET /v2/Jobs/Waiting](#-v2jobswaiting)
* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
</details> </details>
<details> <details>
@ -431,7 +431,7 @@ Returns the `settings.json` file.
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
[Settings](Types.md/#settings) [Settings](Types.md#settings)
</details> </details>
### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Settings/UserAgent` ### <sub>![GET](https://img.shields.io/badge/GET-0f0)</sub> `/v2/Settings/UserAgent`
@ -490,10 +490,10 @@ Sets the Rate-Limits for all Requests. If left empty, resets to default Rate-Lim
For each Rate-Limit set as follows: For each Rate-Limit set as follows:
| Parameter | Value | | Parameter | Value |
|---------------------------------------|---------------------| |------------------------------------|---------------------|
| [Type](#/v2/Settings/RateLimit/Types) | Requests per Minute | | [Type](#-v2settingsratelimittypes) | Requests per Minute |
`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes)
</details> </details>
<details> <details>
@ -511,7 +511,7 @@ Returns the current Rate-Limit for the Request-Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes)
</details> </details>
<details> <details>
@ -527,7 +527,7 @@ Sets the Rate-Limit for the Request-Type in Requests per Minute.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes)
| Parameter | Value | | Parameter | Value |
|-----------|---------------------| |-----------|---------------------|
@ -625,7 +625,7 @@ Returns the Library-Connector for the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
</details> </details>
<details> <details>
@ -645,7 +645,7 @@ Creates a Library-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
| Parameter | Value | | Parameter | Value |
|-------------|--------------------| |-------------|--------------------|
@ -684,7 +684,7 @@ Tests a Library-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
| Parameter | Value | | Parameter | Value |
|-------------|--------------------| |-------------|--------------------|
@ -723,7 +723,7 @@ Deletes the Library-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
</details> </details>
<details> <details>
@ -761,6 +761,12 @@ List of String of Names.
Returns the configured Notification-Connector of the specified Type. Returns the configured Notification-Connector of the specified Type.
<details>
<summary>Request</summary>
`Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes)
</details>
<details> <details>
<summary>Returns</summary> <summary>Returns</summary>
@ -778,7 +784,7 @@ Creates a Notification-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) `Type` is returned by [GET /v2/NotificationConnector/Types](-v2notificationconnectortypes)
#### Type specific Parameters (must be included for each) #### Type specific Parameters (must be included for each)
* Gotify * Gotify
@ -820,7 +826,7 @@ Tests a Notification-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) `Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes)
#### Type specific Parameters (must be included for each) #### Type specific Parameters (must be included for each)
* Gotify * Gotify
@ -862,7 +868,7 @@ Deletes the Notification-Connector of the specified Type.
<details> <details>
<summary>Request</summary> <summary>Request</summary>
`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) `Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes)
</details> </details>
<details> <details>