From f5cecb9e301be28ad9516b97b47c3c859285c64b Mon Sep 17 00:00:00 2001 From: Glax Date: Fri, 19 Apr 2024 21:35:38 +0200 Subject: [PATCH] Github Reference Link Style --- docs/API_Calls_v2.md | 736 ++++++++++++++++++++++--------------------- 1 file changed, 371 insertions(+), 365 deletions(-) diff --git a/docs/API_Calls_v2.md b/docs/API_Calls_v2.md index e81f287..6f08921 100644 --- a/docs/API_Calls_v2.md +++ b/docs/API_Calls_v2.md @@ -17,13 +17,13 @@ Parameters in *italics* are optional ### Quick Entry -* [Connectors](#connectors-suptopsup) -* [Manga](#manga-suptopsup) -* [Jobs](#jobs-suptopsup) -* [Settings](#settings-suptopsup) -* [Library Connectors](#library-connectors-suptopsup) -* [Notification Connectors](#notification-connectors-suptopsup) -* [Miscellaneous](#miscellaneous-suptopsup) +* [Connectors](#connectors-top) +* [Manga](#manga-top) +* [Jobs](#jobs-top) +* [Settings](#settings-top) +* [Library Connectors](#library-connectors-top) +* [Notification Connectors](#notification-connectors-top) +* [Miscellaneous](#miscellaneous-top) ## Connectors [^top](#top) @@ -33,7 +33,8 @@ Returns available Manga Connectors (Scanlation sites)
Returns -List of strings with Names. + + List of strings with Names.
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Connector//GetManga` @@ -42,26 +43,26 @@ Returns the Manga from the specified Manga Connector.
Request - -`ConnectorName` is returned in the response of [GET /v2/Connector/Types](#/v2/Connector) - -Use either `title` or `url` Parameter. - -| Parameter | Value | -|-----------|-------------------------------------------------| -| title | Search Term | -| url | Direct link (URL) to the Manga on the used Site | + + `ConnectorName` is returned in the response of [GET /v2/Connector/Types](#-v2connectortypes) + + Use either `title` or `url` Parameter. + + | Parameter | Value | + |-----------|-------------------------------------------------| + | title | Search Term | + | url | Direct link (URL) to the Manga on the used Site |
Returns - -List of [Manga](Types.md/#Manga) - -| StatusCode | Meaning | -|------------|--------------------------| -| 400 | Connector does not exist | -| 404 | URL/Connector Mismatch | + + List of [Manga](Types.md#Manga) + + | StatusCode | Meaning | + |------------|--------------------------| + | 400 | Connector does not exist | + | 404 | URL/Connector Mismatch |
## Manga [^top](#top) @@ -72,24 +73,24 @@ Returns the specified Manga.
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns - -[Manga](Types.md/#manga) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | + + [Manga](Types.md#manga) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found |
### ![DELETE](https://img.shields.io/badge/DELETE-f00) `/v2/Manga/` @@ -98,23 +99,23 @@ Deletes all associated Jobs for the specified Manga
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 200 | Jobs were deleted | -| 404 | Manga with `internalId` could not be found | + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 200 | Jobs were deleted | + | 404 | Manga with `internalId` could not be found |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Manga//Cover` @@ -123,24 +124,24 @@ Returns the URL for the Cover of the specified Manga.
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns String with the url. - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Manga//Chapters` @@ -149,24 +150,24 @@ Returns the Chapter-list for the specified Manga.
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns - -List of [Chapters](Types.md/#chapter) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | + + List of [Chapters](Types.md/#chapter) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found |
## Jobs [^top](#top) @@ -177,8 +178,8 @@ Returns all configured Jobs.
Returns - -List of [Jobs](Types.md#job) + + List of [Jobs](Types.md#job)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Running` @@ -187,8 +188,8 @@ Returns all Running Jobs.
Returns - -List of [Jobs](Types.md#job) + + List of [Jobs](Types.md#job)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Waiting` @@ -197,8 +198,8 @@ Returns all Waiting Jobs.
Returns - -List of [Jobs](Types.md#job) + + List of [Jobs](Types.md#job)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Jobs/Monitoring` @@ -207,8 +208,8 @@ Returns all Monitoring Jobs.
Returns - -List of [Jobs](Types.md#job) + + List of [Jobs](Types.md#job)
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Jobs/Create/Monitor/` @@ -217,29 +218,29 @@ Creates a Monitoring-Job for the specified Manga at the specified Interval.
Request + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs) -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) - - | Parameter | Value | - |-----------|--------------------------------------------------------| - | interval | Interval at which the Job is re-run in HH:MM:SS format | + | Parameter | Value | + |-----------|--------------------------------------------------------| + | interval | Interval at which the Job is re-run in HH:MM:SS format |
Returns - -[Job](Types.md/#job) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | -| 500 | Error parsing interval | + + [Job](Types.md#job) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found | + | 500 | Error parsing interval |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Jobs/Create/DownloadNewChapters/` @@ -248,24 +249,24 @@ Creates a Job to check for new Chapters and Download new ones of the specified M
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns - -[Job](Types.md/#job) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | + + [Job](Types.md#job) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Jobs/Create/UpdateMetadata` @@ -274,8 +275,8 @@ Creates a Job to update the Metadata of all Manga.
Returns - -[Job](Types.md/#job) + + [Job](Types.md#job)
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Jobs/Create/UpdateMetadata/` @@ -284,24 +285,24 @@ Updates the Metadata of the specified Manga.
Request - -`internalId` is returned in the response of -* [GET /v2/Connector/*ConnectorName*/GetManga](#subsub-v2connectorconnectornamegetmanga) -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) -* [GET /v2/Jobs/*jobId*](#subsub-v2jobs) + + `internalId` is returned in the response of + * [GET /v2/Connector/*ConnectorName*/GetManga](#-v2connectorconnectornamegetmanga) + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring) + * [GET /v2/Jobs/*jobId*](#-v2jobs)
Returns - -[Job](Types.md/#job) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Manga with `internalId` could not be found | + + [Job](Types.md#job) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Manga with `internalId` could not be found |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Job/` @@ -310,23 +311,22 @@ Returns the specified Job.
Request - -`jobId` is returned in the response of - -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) + + `jobId` is returned in the response of + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
Returns - -[Job](Types.md/#job) - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 404 | Manga with `jobId` could not be found | + + [Job](Types.md#job) + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 404 | Manga with `jobId` could not be found |
### ![DELETE](https://img.shields.io/badge/DELETE-f00) `/v2/Job/` @@ -335,21 +335,21 @@ Deletes the specified Job and all descendants.
Request - -`jobId` is returned in the response of -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) + + `jobId` is returned in the response of + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
Returns - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 200 | Job deleted | -| 404 | Manga with `jobId` could not be found | + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 200 | Job deleted | + | 404 | Manga with `jobId` could not be found |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Job//Progress` @@ -358,22 +358,22 @@ Returns the progress the of the specified Job.
Request - -`jobId` is returned in the response of -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) + + `jobId` is returned in the response of + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
Returns -[ProgressToken](Types.md#progresstoken) - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 404 | Manga with `jobId` could not be found | + [ProgressToken](Types.md#progresstoken) + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 404 | Manga with `jobId` could not be found |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Job//StartNow` @@ -382,21 +382,21 @@ Starts the specified Job.
Request - -`jobId` is returned in the response of -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) + + `jobId` is returned in the response of + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
Returns -| StatusCode | Meaning | -|------------|---------------------------------------| -| 200 | Job started | -| 404 | Manga with `jobId` could not be found | + | StatusCode | Meaning | + |------------|---------------------------------------| + | 200 | Job started | + | 404 | Manga with `jobId` could not be found |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Job//Cancel` @@ -406,20 +406,20 @@ Cancels the specified Job, or dequeues it.
Request -`jobId` is returned in the response of -* [GET /v2/Jobs](#subsub-v2jobs) -* [GET /v2/Jobs/Running](#subsub-v2jobsrunning) -* [GET /v2/Jobs/Waiting](#subsub-v2jobswaiting) -* [GET /v2/Jobs/Monitoring](#subsub-v2jobsmonitoring) + `jobId` is returned in the response of + * [GET /v2/Jobs](#-v2jobs) + * [GET /v2/Jobs/Running](#-v2jobsrunning) + * [GET /v2/Jobs/Waiting](#-v2jobswaiting) + * [GET /v2/Jobs/Monitoring](#-v2jobsmonitoring)
Returns -| StatusCode | Meaning | -|------------|---------------------------------------| -| 200 | Job cancelled | -| 404 | Manga with `jobId` could not be found | + | StatusCode | Meaning | + |------------|---------------------------------------| + | 200 | Job cancelled | + | 404 | Manga with `jobId` could not be found |
## Settings [^top](#top) @@ -431,7 +431,7 @@ Returns the `settings.json` file.
Returns -[Settings](Types.md/#settings) + [Settings](Types.md#settings)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Settings/UserAgent` @@ -441,7 +441,7 @@ Returns the current User Agent used for Requests.
Returns -[UserAgent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) + [UserAgent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent)
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Settings/UserAgent` @@ -467,7 +467,7 @@ Returns the configurable Rate-Limits.
Returns -List of Rate-Limit-Names. + List of Rate-Limit-Names.
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Settings/RateLimit` @@ -477,7 +477,7 @@ Returns the current configuration of Rate-Limits for Requests.
Returns -Dictionary of `Rate-Limits` and `Requests per Minute` + Dictionary of `Rate-Limits` and `Requests per Minute`
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Settings/RateLimit` @@ -487,21 +487,21 @@ Sets the Rate-Limits for all Requests. If left empty, resets to default Rate-Lim
Request -For each Rate-Limit set as follows: - -| Parameter | Value | -|---------------------------------------|---------------------| -| [Type](#/v2/Settings/RateLimit/Types) | Requests per Minute | - -`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) + For each Rate-Limit set as follows: + + | Parameter | Value | + |------------------------------------|---------------------| + | [Type](#-v2settingsratelimittypes) | Requests per Minute | + + `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes)
Returns -| StatusCode | Meaning | -|------------|--------------------------------| -| 404 | Rate-Limit-Name does not exist | + | StatusCode | Meaning | + |------------|--------------------------------| + | 404 | Rate-Limit-Name does not exist |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Settings/RateLimit/` @@ -511,13 +511,13 @@ Returns the current Rate-Limit for the Request-Type.
Request -`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) + `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes)
Returns -Integer with Requests per Minute. + Integer with Requests per Minute.
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Settings/RateLimit/` @@ -527,19 +527,19 @@ Sets the Rate-Limit for the Request-Type in Requests per Minute.
Request -`Type` is returned by [GET /v2/Settings/RateLimit/Types](#/v2/Settings/RateLimit/Types) - -| Parameter | Value | -|-----------|---------------------| -| value | Requests per Minute | + `Type` is returned by [GET /v2/Settings/RateLimit/Types](#-v2settingsratelimittypes) + + | Parameter | Value | + |-----------|---------------------| + | value | Requests per Minute |
Returns -| StatusCode | Meaning | -|------------|--------------------------------| -| 404 | Rate-Limit-Name does not exist | -| 500 | Parsing Error | + | StatusCode | Meaning | + |------------|--------------------------------| + | 404 | Rate-Limit-Name does not exist | + | 500 | Parsing Error |
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Settings/AprilFoolsMode` @@ -549,7 +549,7 @@ Returns the current state of the April-Fools-Mode setting.
Returns -Boolean + Boolean
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Settings/ApriFoolsMode` @@ -559,18 +559,18 @@ Enables/Disables April-Fools-Mode.
Request -| Parameter | Value | -|-----------|------------| -| value | true/false | + | Parameter | Value | + |-----------|------------| + | value | true/false |
Returns -| StatusCode | Meaning | -|------------|--------------------------------| -| 404 | Rate-Limit-Name does not exist | -| 500 | Parsing Error | + | StatusCode | Meaning | + |------------|--------------------------------| + | 404 | Rate-Limit-Name does not exist | + | 500 | Parsing Error |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/Settings/DownloadLocation` @@ -580,20 +580,20 @@ Updates the default Download-Location.
Request -| Parameter | Value | -|-------------|------------------| -| location | New Folder-Path | -| *moveFiles* | __*true*__/false | + | Parameter | Value | + |-------------|------------------| + | location | New Folder-Path | + | *moveFiles* | __*true*__/false |
Returns -| StatusCode | Meaning | -|------------|--------------------------| -| 200 | Successfully changed | -| 500 | Files could not be moved | + | StatusCode | Meaning | + |------------|--------------------------| + | 200 | Successfully changed | + | 500 | Files could not be moved |
## Library Connectors [^top](#top) @@ -605,7 +605,7 @@ Returns the configured Library-Connectors.
Returns -List of [LibraryConnectors](Types.md#libraryconnector) + List of [LibraryConnectors](Types.md#libraryconnector)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/LibraryConnector/Types` @@ -615,7 +615,7 @@ Returns the available Library-Connector types.
Returns -List of String of Names. + List of String of Names.
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/LibraryConnector/` @@ -625,17 +625,17 @@ Returns the Library-Connector for the specified Type.
Request -`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) + `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
Returns -[LibraryConnector](Types.md#libraryconnector) - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 404 | Library Connector Type does not exist | + [LibraryConnector](Types.md#libraryconnector) + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 404 | Library Connector Type does not exist |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/LibraryConnector/` @@ -645,36 +645,36 @@ Creates a Library-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) - -| Parameter | Value | -|-------------|--------------------| -| URL | URL of the Library | - -#### Type specific Parameters (must be included for each) -* Komga - -| Parameter | Value | -|-----------|-------------------------------------------------------------------------------------------------------------------| -| auth | [Base64 encoded Basic-Authentication-String](https://datatracker.ietf.org/doc/html/rfc7617) (`username:password`) | - -* Kavita - -| Parameter | Value | -|-----------|-----------------| -| username | Kavita Username | -| password | Kavita Password | + `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes) + + | Parameter | Value | + |-------------|--------------------| + | URL | URL of the Library | + + #### Type specific Parameters (must be included for each) + * Komga + + | Parameter | Value | + |-----------|-------------------------------------------------------------------------------------------------------------------| + | auth | [Base64 encoded Basic-Authentication-String](https://datatracker.ietf.org/doc/html/rfc7617) (`username:password`) | + + * Kavita + + | Parameter | Value | + |-----------|-----------------| + | username | Kavita Username | + | password | Kavita Password |
Returns -[LibraryConnector](Types.md#libraryconnector) - -| StatusCode | Meaning | -|------------|----------------------------------| -| 404 | Library Connector does not exist | -| 500 | Parsing Error | + [LibraryConnector](Types.md#libraryconnector) + + | StatusCode | Meaning | + |------------|----------------------------------| + | 404 | Library Connector does not exist | + | 500 | Parsing Error |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/LibraryConnector//Test` @@ -684,36 +684,36 @@ Tests a Library-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) + `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes) + + | Parameter | Value | + |-------------|--------------------| + | URL | URL of the Library | -| Parameter | Value | -|-------------|--------------------| -| URL | URL of the Library | - -#### Type specific Parameters (must be included for each) -* Komga - -| Parameter | Value | -|-----------|-------------------------------------------------------------------------------------------------------------------| -| auth | [Base64 encoded Basic-Authentication-String](https://datatracker.ietf.org/doc/html/rfc7617) (`username:password`) | - -* Kavita - -| Parameter | Value | -|-----------|-----------------| -| username | Kavita Username | -| password | Kavita Password | -
- -
- Returns - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 200 | Test successful | -| 404 | Library Connector Type does not exist | -| 408 | Test failed | -| 500 | Parsing Error | + #### Type specific Parameters (must be included for each) + * Komga + + | Parameter | Value | + |-----------|-------------------------------------------------------------------------------------------------------------------| + | auth | [Base64 encoded Basic-Authentication-String](https://datatracker.ietf.org/doc/html/rfc7617) (`username:password`) | + + * Kavita + + | Parameter | Value | + |-----------|-----------------| + | username | Kavita Username | + | password | Kavita Password | +
+ +
+ Returns + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 200 | Test successful | + | 404 | Library Connector Type does not exist | + | 408 | Test failed | + | 500 | Parsing Error |
### ![DELETE](https://img.shields.io/badge/DELETE-f00) `/v2/LibraryConnector/` @@ -723,16 +723,16 @@ Deletes the Library-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/LibraryConnector/Types](#/v2/LibraryConnector/Types) + `Type` is returned by [GET /v2/LibraryConnector/Types](#-v2libraryconnectortypes)
Returns -| StatusCode | Meaning | -|------------|---------------------------------------| -| 200 | Deleted | -| 404 | Library Connector Type does not exist | + | StatusCode | Meaning | + |------------|---------------------------------------| + | 200 | Deleted | + | 404 | Library Connector Type does not exist |
## Notification Connectors [^top](#top) @@ -744,7 +744,7 @@ Returns the configured Notification-Connectors.
Returns -List of [NotificationConnectors](Types.md#notificationconnector) + List of [NotificationConnectors](Types.md#notificationconnector)
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/NotificationConnector/Types` @@ -753,22 +753,28 @@ Returns the available Notification-Connectors.
Returns - -List of String of Names. + + List of String of Names.
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/NotificationConnector/` Returns the configured Notification-Connector of the specified Type. +
+ Request + + `Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes) +
+
Returns -[Notification Connector](Types.md#notificationconnector) - -| StatusCode | Meaning | -|------------|---------------------------------------| -| 404 | Library Connector Type does not exist | + [Notification Connector](Types.md#notificationconnector) + + | StatusCode | Meaning | + |------------|---------------------------------------| + | 404 | Library Connector Type does not exist |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/NotificationConnector/` @@ -778,39 +784,39 @@ Creates a Notification-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) - -#### Type specific Parameters (must be included for each) -* Gotify - -| Parameter | Value | -|-----------|---------------------------------------| -| url | URL of the Gotify Instance | -| appToken | AppToken of the configured Gotify App | - -* LunaSea - -| Parameter | Value | -|-----------|-----------------| -| webhook | LunaSea Webhook | - -* Nty - -| Parameter | Value | -|-----------|--------------------------| -| url | URL of the Ntfy Instance | -| auth | Auth-String | + `Type` is returned by [GET /v2/NotificationConnector/Types](-v2notificationconnectortypes) + + #### Type specific Parameters (must be included for each) + * Gotify + + | Parameter | Value | + |-----------|---------------------------------------| + | url | URL of the Gotify Instance | + | appToken | AppToken of the configured Gotify App | + + * LunaSea + + | Parameter | Value | + |-----------|-----------------| + | webhook | LunaSea Webhook | + + * Nty + + | Parameter | Value | + |-----------|--------------------------| + | url | URL of the Ntfy Instance | + | auth | Auth-String |
Returns -[NotificationConnector](Types.md#notificationconnector) - -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 404 | Notification Connector Type does not exist | -| 500 | Parsing Error | + [NotificationConnector](Types.md#notificationconnector) + + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 404 | Notification Connector Type does not exist | + | 500 | Parsing Error |
### ![POST](https://img.shields.io/badge/POST-00f) `/v2/NotificationConnector//Test` @@ -820,39 +826,39 @@ Tests a Notification-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) - -#### Type specific Parameters (must be included for each) -* Gotify - -| Parameter | Value | -|-----------|---------------------------------------| -| url | URL of the Gotify Instance | -| appToken | AppToken of the configured Gotify App | - -* LunaSea - -| Parameter | Value | -|-----------|-----------------| -| webhook | LunaSea Webhook | - -* Ntfy - -| Parameter | Value | -|-----------|--------------------------| -| url | URL of the Ntfy Instance | -| auth | Auth-String | + `Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes) + + #### Type specific Parameters (must be included for each) + * Gotify + + | Parameter | Value | + |-----------|---------------------------------------| + | url | URL of the Gotify Instance | + | appToken | AppToken of the configured Gotify App | + + * LunaSea + + | Parameter | Value | + |-----------|-----------------| + | webhook | LunaSea Webhook | + + * Ntfy + + | Parameter | Value | + |-----------|--------------------------| + | url | URL of the Ntfy Instance | + | auth | Auth-String |
Returns -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 200 | Test successful | -| 404 | Notification Connector Type does not exist | -| 408 | Test failed | -| 500 | Parsing Error | + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 200 | Test successful | + | 404 | Notification Connector Type does not exist | + | 408 | Test failed | + | 500 | Parsing Error |
### ![DELETE](https://img.shields.io/badge/DELETE-f00) `/v2/NotificationConnector/` @@ -862,16 +868,16 @@ Deletes the Notification-Connector of the specified Type.
Request -`Type` is returned by [GET /v2/NotificationConnector/Types](#/v2/NotificationConnector/Types) + `Type` is returned by [GET /v2/NotificationConnector/Types](#-v2notificationconnectortypes)
Returns -| StatusCode | Meaning | -|------------|--------------------------------------------| -| 200 | Deleted | -| 404 | Notification Connector Type does not exist | + | StatusCode | Meaning | + |------------|--------------------------------------------| + | 200 | Deleted | + | 404 | Notification Connector Type does not exist |
## Miscellaneous [^top](#top) @@ -883,7 +889,7 @@ Returns the current log-file.
Returns -The Logfile as Stream. + The Logfile as Stream.
### ![GET](https://img.shields.io/badge/GET-0f0) `/v2/Ping`