You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Readarr/src/Readarr.Api.V1/openapi.json

13858 lines
329 KiB

{
"openapi": "3.0.1",
"info": {
"title": "Readarr",
"description": "Readarr API docs",
"license": {
"name": "GPL-3.0",
"url": "https://github.com/Readarr/Readarr/blob/develop/LICENSE"
},
"version": "1.0.0"
},
"servers": [
{
"url": "{protocol}://{hostpath}",
"variables": {
"protocol": {
"default": "http",
"enum": [
"http",
"https"
]
},
"hostpath": {
"default": "localhost:8787"
}
}
}
],
"paths": {
"/api": {
"get": {
"tags": [
"ApiInfo"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiInfoResource"
}
}
}
}
}
}
},
"/login": {
"post": {
"tags": [
"Authentication"
],
"parameters": [
{
"name": "returnUrl",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"rememberMe": {
"type": "string"
}
}
},
"encoding": {
"username": {
"style": "form"
},
"password": {
"style": "form"
},
"rememberMe": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"StaticResource"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/logout": {
"get": {
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/author": {
"get": {
"tags": [
"Author"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Author"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
}
}
}
},
"/api/v1/author/{id}": {
"put": {
"tags": [
"Author"
],
"parameters": [
{
"name": "moveFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Author"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "deleteFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "addImportListExclusion",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Author"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorResource"
}
}
}
}
}
}
},
"/api/v1/author/editor": {
"put": {
"tags": [
"AuthorEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"AuthorEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthorEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/author/lookup": {
"get": {
"tags": [
"AuthorLookup"
],
"parameters": [
{
"name": "term",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/backup": {
"get": {
"tags": [
"Backup"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BackupResource"
}
}
}
}
}
}
}
},
"/api/v1/system/backup/{id}": {
"delete": {
"tags": [
"Backup"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/backup/restore/{id}": {
"post": {
"tags": [
"Backup"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/backup/restore/upload": {
"post": {
"tags": [
"Backup"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/blocklist": {
"get": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/blocklist/{id}": {
"delete": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/blocklist/bulk": {
"delete": {
"tags": [
"Blocklist"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/book": {
"get": {
"tags": [
"Book"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "titleSlug",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "includeAllAuthorBooks",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Book"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"/api/v1/book/{id}/overview": {
"get": {
"tags": [
"Book"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/book/{id}": {
"put": {
"tags": [
"Book"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Book"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "deleteFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "addImportListExclusion",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Book"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"/api/v1/book/monitor": {
"put": {
"tags": [
"Book"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooksMonitoredResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BooksMonitoredResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BooksMonitoredResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/book/editor": {
"put": {
"tags": [
"BookEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"BookEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookEditorResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/bookfile": {
"get": {
"tags": [
"BookFile"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookFileIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "unmapped",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookFileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookFileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookFileResource"
}
}
}
}
}
}
}
},
"/api/v1/bookfile/{id}": {
"put": {
"tags": [
"BookFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
}
}
}
}
},
"delete": {
"tags": [
"BookFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"BookFile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFileResource"
}
}
}
}
}
}
},
"/api/v1/bookfile/editor": {
"put": {
"tags": [
"BookFile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/bookfile/bulk": {
"delete": {
"tags": [
"BookFile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookFileListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/book/lookup": {
"get": {
"tags": [
"BookLookup"
],
"parameters": [
{
"name": "term",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/bookshelf": {
"post": {
"tags": [
"Bookshelf"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookshelfResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookshelfResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BookshelfResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/calendar": {
"get": {
"tags": [
"Calendar"
],
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "end",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "unmonitored",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
}
},
"/api/v1/calendar/{id}": {
"get": {
"tags": [
"Calendar"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"/feed/v1/calendar/readarr.ics": {
"get": {
"tags": [
"CalendarFeed"
],
"parameters": [
{
"name": "pastDays",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 7
}
},
{
"name": "futureDays",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 28
}
},
{
"name": "tagList",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "unmonitored",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/command": {
"post": {
"tags": [
"Command"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
},
"get": {
"tags": [
"Command"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommandResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommandResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
}
}
},
"/api/v1/command/{id}": {
"delete": {
"tags": [
"Command"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Command"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommandResource"
}
}
}
}
}
}
},
"/api/v1/customfilter": {
"get": {
"tags": [
"CustomFilter"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"CustomFilter"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"/api/v1/customfilter/{id}": {
"put": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"CustomFilter"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFilterResource"
}
}
}
}
}
}
},
"/api/v1/customformat": {
"post": {
"tags": [
"CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
}
},
"/api/v1/customformat/{id}": {
"put": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
},
"/api/v1/customformat/schema": {
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/wanted/cutoff": {
"get": {
"tags": [
"Cutoff"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/wanted/cutoff/{id}": {
"get": {
"tags": [
"Cutoff"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"/api/v1/delayprofile": {
"post": {
"tags": [
"DelayProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"DelayProfile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
}
}
},
"/api/v1/delayprofile/{id}": {
"delete": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DelayProfileResource"
}
}
}
}
}
}
},
"/api/v1/delayprofile/reorder/{id}": {
"put": {
"tags": [
"DelayProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "afterId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/config/development": {
"get": {
"tags": [
"DevelopmentConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/development/{id}": {
"put": {
"tags": [
"DevelopmentConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"DevelopmentConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevelopmentConfigResource"
}
}
}
}
}
}
},
"/api/v1/diskspace": {
"get": {
"tags": [
"DiskSpace"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiskSpaceResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiskSpaceResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiskSpaceResource"
}
}
}
}
}
}
}
},
"/api/v1/downloadclient": {
"get": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"/api/v1/downloadclient/{id}": {
"put": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
},
"delete": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
},
"/api/v1/downloadclient/bulk": {
"put": {
"tags": [
"DownloadClient"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
},
"delete": {
"tags": [
"DownloadClient"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/downloadclient/schema": {
"get": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
}
}
}
}
},
"/api/v1/downloadclient/test": {
"post": {
"tags": [
"DownloadClient"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/downloadclient/testall": {
"post": {
"tags": [
"DownloadClient"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/downloadclient/action/{name}": {
"post": {
"tags": [
"DownloadClient"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/config/downloadclient": {
"get": {
"tags": [
"DownloadClientConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/downloadclient/{id}": {
"put": {
"tags": [
"DownloadClientConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"DownloadClientConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadClientConfigResource"
}
}
}
}
}
}
},
"/api/v1/edition": {
"get": {
"tags": [
"Edition"
],
"parameters": [
{
"name": "bookId",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditionResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditionResource"
}
}
}
}
}
}
}
},
"/api/v1/filesystem": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "includeFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "allowFoldersWithoutTrailingSlashes",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/filesystem/type": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/filesystem/mediafiles": {
"get": {
"tags": [
"FileSystem"
],
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/health": {
"get": {
"tags": [
"Health"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResource"
}
}
}
}
}
}
}
},
"/api/v1/history": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "includeBook",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/history/since": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "date",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EntityHistoryEventType"
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeBook",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v1/history/author": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EntityHistoryEventType"
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeBook",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v1/history/failed/{id}": {
"post": {
"tags": [
"History"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/config/host": {
"get": {
"tags": [
"HostConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/host/{id}": {
"put": {
"tags": [
"HostConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"HostConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostConfigResource"
}
}
}
}
}
}
},
"/api/v1/importlist": {
"get": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"/api/v1/importlist/{id}": {
"put": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
},
"/api/v1/importlist/bulk": {
"put": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/importlist/schema": {
"get": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
}
}
}
}
},
"/api/v1/importlist/test": {
"post": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/importlist/testall": {
"post": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/importlist/action/{name}": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/importlistexclusion": {
"get": {
"tags": [
"ImportListExclusion"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"/api/v1/importlistexclusion/{id}": {
"put": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"/api/v1/indexer": {
"get": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"/api/v1/indexer/{id}": {
"put": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
},
"/api/v1/indexer/bulk": {
"put": {
"tags": [
"Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/indexer/schema": {
"get": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
}
}
}
}
},
"/api/v1/indexer/test": {
"post": {
"tags": [
"Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/indexer/testall": {
"post": {
"tags": [
"Indexer"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/indexer/action/{name}": {
"post": {
"tags": [
"Indexer"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/config/indexer": {
"get": {
"tags": [
"IndexerConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/indexer/{id}": {
"put": {
"tags": [
"IndexerConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"IndexerConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexerConfigResource"
}
}
}
}
}
}
},
"/api/v1/indexerflag": {
"get": {
"tags": [
"IndexerFlag"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerFlagResource"
}
}
}
}
}
}
}
},
"/api/v1/language": {
"get": {
"tags": [
"Language"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
}
}
}
}
}
}
},
"/api/v1/language/{id}": {
"get": {
"tags": [
"Language"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageResource"
}
}
}
}
}
}
},
"/api/v1/localization": {
"get": {
"tags": [
"Localization"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v1/log": {
"get": {
"tags": [
"Log"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "level",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/log/file": {
"get": {
"tags": [
"LogFile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v1/log/file/{filename}": {
"get": {
"tags": [
"LogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/manualimport": {
"post": {
"tags": [
"ManualImport"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportUpdateResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportUpdateResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportUpdateResource"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"ManualImport"
],
"parameters": [
{
"name": "folder",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filterExistingFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "replaceExistingFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualImportResource"
}
}
}
}
}
}
}
},
"/api/v1/mediacover/author/{authorId}/{filename}": {
"get": {
"tags": [
"MediaCover"
],
"parameters": [
{
"name": "authorId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "(.+)\\.(jpg|png|gif)",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/mediacover/book/{bookId}/{filename}": {
"get": {
"tags": [
"MediaCover"
],
"parameters": [
{
"name": "bookId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "(.+)\\.(jpg|png|gif)",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/config/mediamanagement": {
"get": {
"tags": [
"MediaManagementConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/mediamanagement/{id}": {
"put": {
"tags": [
"MediaManagementConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"MediaManagementConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementConfigResource"
}
}
}
}
}
}
},
"/api/v1/metadata": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v1/metadata/{id}": {
"put": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v1/metadata/schema": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
}
},
"/api/v1/metadata/test": {
"post": {
"tags": [
"Metadata"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/metadata/testall": {
"post": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/metadata/action/{name}": {
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/metadataprofile": {
"post": {
"tags": [
"MetadataProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"MetadataProfile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
}
}
}
}
},
"/api/v1/metadataprofile/{id}": {
"delete": {
"tags": [
"MetadataProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"MetadataProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"MetadataProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
}
}
}
},
"/api/v1/metadataprofile/schema": {
"get": {
"tags": [
"MetadataProfileSchema"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProfileResource"
}
}
}
}
}
}
},
"/api/v1/config/metadataprovider": {
"get": {
"tags": [
"MetadataProviderConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/metadataprovider/{id}": {
"put": {
"tags": [
"MetadataProviderConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"MetadataProviderConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataProviderConfigResource"
}
}
}
}
}
}
},
"/api/v1/wanted/missing": {
"get": {
"tags": [
"Missing"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BookResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/wanted/missing/{id}": {
"get": {
"tags": [
"Missing"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResource"
}
}
}
}
}
}
},
"/api/v1/config/naming": {
"get": {
"tags": [
"NamingConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/naming/{id}": {
"put": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamingConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/naming/examples": {
"get": {
"tags": [
"NamingConfig"
],
"parameters": [
{
"name": "renameBooks",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "replaceIllegalCharacters",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "colonReplacementFormat",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "standardBookFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "authorFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "includeAuthorName",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "includeBookTitle",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "includeQuality",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "replaceSpaces",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "separator",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "numberStyle",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "resourceName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/notification": {
"get": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"/api/v1/notification/{id}": {
"put": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
},
"/api/v1/notification/schema": {
"get": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
}
}
}
}
},
"/api/v1/notification/test": {
"post": {
"tags": [
"Notification"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/notification/testall": {
"post": {
"tags": [
"Notification"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/notification/action/{name}": {
"post": {
"tags": [
"Notification"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/parse": {
"get": {
"tags": [
"Parse"
],
"parameters": [
{
"name": "title",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ParseResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParseResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ParseResource"
}
}
}
}
}
}
},
"/ping": {
"get": {
"tags": [
"Ping"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResource"
}
}
}
}
}
},
"head": {
"tags": [
"Ping"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResource"
}
}
}
}
}
}
},
"/api/v1/qualitydefinition/{id}": {
"put": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
},
"/api/v1/qualitydefinition": {
"get": {
"tags": [
"QualityDefinition"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
}
},
"/api/v1/qualitydefinition/update": {
"put": {
"tags": [
"QualityDefinition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/qualityprofile": {
"post": {
"tags": [
"QualityProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
}
},
"/api/v1/qualityprofile/{id}": {
"delete": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v1/qualityprofile/schema": {
"get": {
"tags": [
"QualityProfileSchema"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v1/queue/{id}": {
"delete": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "removeFromClient",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skipRedownload",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "changeCategory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/queue/bulk": {
"delete": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "removeFromClient",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skipRedownload",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "changeCategory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/queue": {
"get": {
"tags": [
"Queue"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "includeUnknownAuthorItems",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeBook",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueResourcePagingResource"
}
}
}
}
}
}
},
"/api/v1/queue/grab/{id}": {
"post": {
"tags": [
"QueueAction"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/queue/grab/bulk": {
"post": {
"tags": [
"QueueAction"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/queue/details": {
"get": {
"tags": [
"QueueDetails"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "includeAuthor",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeBook",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
}
}
}
}
}
}
}
},
"/api/v1/queue/status": {
"get": {
"tags": [
"QueueStatus"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QueueStatusResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueStatusResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QueueStatusResource"
}
}
}
}
}
}
},
"/api/v1/release": {
"post": {
"tags": [
"Release"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
}
}
},
"get": {
"tags": [
"Release"
],
"parameters": [
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
}
}
}
}
},
"/api/v1/releaseprofile": {
"get": {
"tags": [
"ReleaseProfile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"ReleaseProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
},
"/api/v1/releaseprofile/{id}": {
"put": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
},
"/api/v1/release/push": {
"post": {
"tags": [
"ReleasePush"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseResource"
}
}
}
}
}
}
},
"/api/v1/remotepathmapping": {
"post": {
"tags": [
"RemotePathMapping"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
},
"get": {
"tags": [
"RemotePathMapping"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
}
}
},
"/api/v1/remotepathmapping/{id}": {
"delete": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
},
"get": {
"tags": [
"RemotePathMapping"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemotePathMappingResource"
}
}
}
}
}
}
},
"/api/v1/rename": {
"get": {
"tags": [
"RenameBook"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenameBookResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenameBookResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenameBookResource"
}
}
}
}
}
}
}
},
"/api/v1/retag": {
"get": {
"tags": [
"RetagBook"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetagBookResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetagBookResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetagBookResource"
}
}
}
}
}
}
}
},
"/api/v1/rootfolder": {
"post": {
"tags": [
"RootFolder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
},
"get": {
"tags": [
"RootFolder"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
}
}
},
"/api/v1/rootfolder/{id}": {
"put": {
"tags": [
"RootFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
},
"delete": {
"tags": [
"RootFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"RootFolder"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RootFolderResource"
}
}
}
}
}
}
},
"/api/v1/search": {
"get": {
"tags": [
"Search"
],
"parameters": [
{
"name": "term",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/series": {
"get": {
"tags": [
"Series"
],
"parameters": [
{
"name": "authorId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
}
},
"/content/{path}": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"pattern": "^(?!/*api/).*",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/{path}": {
"get": {
"tags": [
"StaticResource"
],
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"pattern": "^(?!(api|feed)/).*",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/status": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SystemResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SystemResource"
}
}
}
}
}
}
},
"/api/v1/system/routes": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/routes/duplicate": {
"get": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/shutdown": {
"post": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/system/restart": {
"post": {
"tags": [
"System"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/tag": {
"get": {
"tags": [
"Tag"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Tag"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"/api/v1/tag/{id}": {
"put": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"Tag"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResource"
}
}
}
}
}
}
},
"/api/v1/tag/detail": {
"get": {
"tags": [
"TagDetails"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
}
}
}
}
}
},
"/api/v1/tag/detail/{id}": {
"get": {
"tags": [
"TagDetails"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagDetailsResource"
}
}
}
}
}
}
},
"/api/v1/system/task": {
"get": {
"tags": [
"Task"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
}
}
}
}
}
}
},
"/api/v1/system/task/{id}": {
"get": {
"tags": [
"Task"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskResource"
}
}
}
}
}
}
},
"/api/v1/config/ui/{id}": {
"put": {
"tags": [
"UiConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"UiConfig"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
}
},
"/api/v1/config/ui": {
"get": {
"tags": [
"UiConfig"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UiConfigResource"
}
}
}
}
}
}
},
"/api/v1/update": {
"get": {
"tags": [
"Update"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateResource"
}
}
}
}
}
}
}
},
"/api/v1/log/file/update": {
"get": {
"tags": [
"UpdateLogFile"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v1/log/file/update/{filename}": {
"get": {
"tags": [
"UpdateLogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
}
},
"components": {
"schemas": {
"AddAuthorOptions": {
"type": "object",
"properties": {
"monitor": {
"$ref": "#/components/schemas/MonitorTypes"
},
"booksToMonitor": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"monitored": {
"type": "boolean"
},
"searchForMissingBooks": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AddBookOptions": {
"type": "object",
"properties": {
"addType": {
"$ref": "#/components/schemas/BookAddType"
},
"searchForNewBook": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AllowFingerprinting": {
"enum": [
"never",
"newFiles",
"allFiles"
],
"type": "string"
},
"ApiInfoResource": {
"type": "object",
"properties": {
"current": {
"type": "string",
"nullable": true
},
"deprecated": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ApplyTags": {
"enum": [
"add",
"remove",
"replace"
],
"type": "string"
},
"AuthenticationType": {
"enum": [
"none",
"basic",
"forms"
],
"type": "string"
},
"Author": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorMetadataId": {
"type": "integer",
"format": "int32"
},
"cleanName": {
"type": "string",
"nullable": true
},
"monitored": {
"type": "boolean"
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"lastInfoSync": {
"type": "string",
"format": "date-time",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"added": {
"type": "string",
"format": "date-time"
},
"qualityProfileId": {
"type": "integer",
"format": "int32"
},
"metadataProfileId": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"addOptions": {
"$ref": "#/components/schemas/AddAuthorOptions"
},
"metadata": {
"$ref": "#/components/schemas/AuthorMetadataLazyLoaded"
},
"qualityProfile": {
"$ref": "#/components/schemas/QualityProfileLazyLoaded"
},
"metadataProfile": {
"$ref": "#/components/schemas/MetadataProfileLazyLoaded"
},
"books": {
"$ref": "#/components/schemas/BookListLazyLoaded"
},
"series": {
"$ref": "#/components/schemas/SeriesListLazyLoaded"
},
"name": {
"type": "string",
"nullable": true
},
"foreignAuthorId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AuthorEditorResource": {
"type": "object",
"properties": {
"authorIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"monitored": {
"type": "boolean",
"nullable": true
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"metadataProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"moveFiles": {
"type": "boolean"
},
"deleteFiles": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AuthorLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Author"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"AuthorMetadata": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"foreignAuthorId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"sortName": {
"type": "string",
"nullable": true
},
"nameLastFirst": {
"type": "string",
"nullable": true
},
"sortNameLastFirst": {
"type": "string",
"nullable": true
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"disambiguation": {
"type": "string",
"nullable": true
},
"gender": {
"type": "string",
"nullable": true
},
"hometown": {
"type": "string",
"nullable": true
},
"born": {
"type": "string",
"format": "date-time",
"nullable": true
},
"died": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/AuthorStatusType"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
}
},
"additionalProperties": false
},
"AuthorMetadataLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/AuthorMetadata"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"AuthorResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorMetadataId": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/components/schemas/AuthorStatusType"
},
"ended": {
"type": "boolean",
"readOnly": true
},
"authorName": {
"type": "string",
"nullable": true
},
"authorNameLastFirst": {
"type": "string",
"nullable": true
},
"foreignAuthorId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"disambiguation": {
"type": "string",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"nextBook": {
"$ref": "#/components/schemas/Book"
},
"lastBook": {
"$ref": "#/components/schemas/Book"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"remotePoster": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32"
},
"metadataProfileId": {
"type": "integer",
"format": "int32"
},
"monitored": {
"type": "boolean"
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"cleanName": {
"type": "string",
"nullable": true
},
"sortName": {
"type": "string",
"nullable": true
},
"sortNameLastFirst": {
"type": "string",
"nullable": true
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"added": {
"type": "string",
"format": "date-time"
},
"addOptions": {
"$ref": "#/components/schemas/AddAuthorOptions"
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"statistics": {
"$ref": "#/components/schemas/AuthorStatisticsResource"
}
},
"additionalProperties": false
},
"AuthorStatisticsResource": {
"type": "object",
"properties": {
"bookFileCount": {
"type": "integer",
"format": "int32"
},
"bookCount": {
"type": "integer",
"format": "int32"
},
"availableBookCount": {
"type": "integer",
"format": "int32"
},
"totalBookCount": {
"type": "integer",
"format": "int32"
},
"sizeOnDisk": {
"type": "integer",
"format": "int64"
},
"percentOfBooks": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"AuthorStatusType": {
"enum": [
"continuing",
"ended"
],
"type": "string"
},
"AuthorTitleInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"titleWithoutYear": {
"type": "string",
"nullable": true
},
"year": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"BackupResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/BackupType"
},
"size": {
"type": "integer",
"format": "int64"
},
"time": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"BackupType": {
"enum": [
"scheduled",
"manual",
"update"
],
"type": "string"
},
"BlocklistBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"BlocklistResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32"
},
"bookIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sourceTitle": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"indexer": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"additionalProperties": false
},
"BlocklistResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlocklistResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"Book": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorMetadataId": {
"type": "integer",
"format": "int32"
},
"foreignBookId": {
"type": "string",
"nullable": true
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"releaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"relatedBooks": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"lastSearchTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"cleanTitle": {
"type": "string",
"nullable": true
},
"monitored": {
"type": "boolean"
},
"anyEditionOk": {
"type": "boolean"
},
"lastInfoSync": {
"type": "string",
"format": "date-time",
"nullable": true
},
"added": {
"type": "string",
"format": "date-time"
},
"addOptions": {
"$ref": "#/components/schemas/AddBookOptions"
},
"authorMetadata": {
"$ref": "#/components/schemas/AuthorMetadataLazyLoaded"
},
"author": {
"$ref": "#/components/schemas/AuthorLazyLoaded"
},
"editions": {
"$ref": "#/components/schemas/EditionListLazyLoaded"
},
"bookFiles": {
"$ref": "#/components/schemas/BookFileListLazyLoaded"
},
"seriesLinks": {
"$ref": "#/components/schemas/SeriesBookLinkListLazyLoaded"
}
},
"additionalProperties": false
},
"BookAddType": {
"enum": [
"automatic",
"manual"
],
"type": "string"
},
"BookEditorResource": {
"type": "object",
"properties": {
"bookIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"monitored": {
"type": "boolean",
"nullable": true
},
"deleteFiles": {
"type": "boolean",
"nullable": true
},
"addImportListExclusion": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"BookFile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64"
},
"modified": {
"type": "string",
"format": "date-time"
},
"dateAdded": {
"type": "string",
"format": "date-time"
},
"originalFilePath": {
"type": "string",
"nullable": true
},
"sceneName": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"indexerFlags": {
"$ref": "#/components/schemas/IndexerFlags"
},
"mediaInfo": {
"$ref": "#/components/schemas/MediaInfoModel"
},
"editionId": {
"type": "integer",
"format": "int32"
},
"calibreId": {
"type": "integer",
"format": "int32"
},
"part": {
"type": "integer",
"format": "int32"
},
"author": {
"$ref": "#/components/schemas/AuthorLazyLoaded"
},
"edition": {
"$ref": "#/components/schemas/EditionLazyLoaded"
},
"partCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"BookFileListLazyLoaded": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookFile"
},
"nullable": true,
"readOnly": true
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"BookFileListResource": {
"type": "object",
"properties": {
"bookFileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
}
},
"additionalProperties": false
},
"BookFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64"
},
"dateAdded": {
"type": "string",
"format": "date-time"
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"qualityWeight": {
"type": "integer",
"format": "int32"
},
"indexerFlags": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mediaInfo": {
"$ref": "#/components/schemas/MediaInfoResource"
},
"qualityCutoffNotMet": {
"type": "boolean"
},
"audioTags": {
"$ref": "#/components/schemas/ParsedTrackInfo"
}
},
"additionalProperties": false
},
"BookLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Book"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"BookListLazyLoaded": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Book"
},
"nullable": true,
"readOnly": true
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"BookResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"authorTitle": {
"type": "string",
"nullable": true
},
"seriesTitle": {
"type": "string",
"nullable": true
},
"disambiguation": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"authorId": {
"type": "integer",
"format": "int32"
},
"foreignBookId": {
"type": "string",
"nullable": true
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"monitored": {
"type": "boolean"
},
"anyEditionOk": {
"type": "boolean"
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"releaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"pageCount": {
"type": "integer",
"format": "int32"
},
"genres": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"statistics": {
"$ref": "#/components/schemas/BookStatisticsResource"
},
"added": {
"type": "string",
"format": "date-time",
"nullable": true
},
"addOptions": {
"$ref": "#/components/schemas/AddBookOptions"
},
"remoteCover": {
"type": "string",
"nullable": true
},
"editions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditionResource"
},
"nullable": true
},
"grabbed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"BookResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"BookStatisticsResource": {
"type": "object",
"properties": {
"bookFileCount": {
"type": "integer",
"format": "int32"
},
"bookCount": {
"type": "integer",
"format": "int32"
},
"totalBookCount": {
"type": "integer",
"format": "int32"
},
"sizeOnDisk": {
"type": "integer",
"format": "int64"
},
"percentOfBooks": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"BooksMonitoredResource": {
"type": "object",
"properties": {
"bookIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"monitored": {
"type": "boolean"
}
},
"additionalProperties": false
},
"BookshelfAuthorResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"monitored": {
"type": "boolean",
"nullable": true
},
"books": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"BookshelfResource": {
"type": "object",
"properties": {
"authors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookshelfAuthorResource"
},
"nullable": true
},
"monitoringOptions": {
"$ref": "#/components/schemas/MonitoringOptions"
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
}
},
"additionalProperties": false
},
"CertificateValidationType": {
"enum": [
"enabled",
"disabledForLocalAddresses",
"disabled"
],
"type": "string"
},
"Command": {
"type": "object",
"properties": {
"sendUpdatesToClient": {
"type": "boolean"
},
"updateScheduledTask": {
"type": "boolean",
"readOnly": true
},
"completionMessage": {
"type": "string",
"nullable": true,
"readOnly": true
},
"requiresDiskAccess": {
"type": "boolean",
"readOnly": true
},
"isExclusive": {
"type": "boolean",
"readOnly": true
},
"isTypeExclusive": {
"type": "boolean",
"readOnly": true
},
"isLongRunning": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastStartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"trigger": {
"$ref": "#/components/schemas/CommandTrigger"
},
"suppressMessages": {
"type": "boolean"
},
"clientUserAgent": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CommandPriority": {
"enum": [
"normal",
"high",
"low"
],
"type": "string"
},
"CommandResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"commandName": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"body": {
"$ref": "#/components/schemas/Command"
},
"priority": {
"$ref": "#/components/schemas/CommandPriority"
},
"status": {
"$ref": "#/components/schemas/CommandStatus"
},
"result": {
"$ref": "#/components/schemas/CommandResult"
},
"queued": {
"type": "string",
"format": "date-time"
},
"started": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ended": {
"type": "string",
"format": "date-time",
"nullable": true
},
"duration": {
"$ref": "#/components/schemas/TimeSpan"
},
"exception": {
"type": "string",
"nullable": true
},
"trigger": {
"$ref": "#/components/schemas/CommandTrigger"
},
"clientUserAgent": {
"type": "string",
"nullable": true
},
"stateChangeTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sendUpdatesToClient": {
"type": "boolean"
},
"updateScheduledTask": {
"type": "boolean"
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CommandResult": {
"enum": [
"unknown",
"successful",
"unsuccessful"
],
"type": "string"
},
"CommandStatus": {
"enum": [
"queued",
"started",
"completed",
"failed",
"aborted",
"cancelled",
"orphaned"
],
"type": "string"
},
"CommandTrigger": {
"enum": [
"unspecified",
"manual",
"scheduled"
],
"type": "string"
},
"CustomFilterResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormat": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean"
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ICustomFormatSpecification"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean",
"nullable": true
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatSpecificationSchema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"DatabaseType": {
"enum": [
"sqLite",
"postgreSQL"
],
"type": "string"
},
"DelayProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"enableUsenet": {
"type": "boolean"
},
"enableTorrent": {
"type": "boolean"
},
"preferredProtocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"usenetDelay": {
"type": "integer",
"format": "int32"
},
"torrentDelay": {
"type": "integer",
"format": "int32"
},
"bypassIfHighestQuality": {
"type": "boolean"
},
"bypassIfAboveCustomFormatScore": {
"type": "boolean"
},
"minimumCustomFormatScore": {
"type": "integer",
"format": "int32"
},
"order": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"DevelopmentConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"metadataSource": {
"type": "string",
"nullable": true
},
"consoleLogLevel": {
"type": "string",
"nullable": true
},
"logSql": {
"type": "boolean"
},
"logRotate": {
"type": "integer",
"format": "int32"
},
"filterSentryEvents": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DiskSpaceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"freeSpace": {
"type": "integer",
"format": "int64"
},
"totalSpace": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"DownloadClientBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enable": {
"type": "boolean",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true
},
"removeCompletedDownloads": {
"type": "boolean",
"nullable": true
},
"removeFailedDownloads": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DownloadClientConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"downloadClientWorkingFolders": {
"type": "string",
"nullable": true
},
"enableCompletedDownloadHandling": {
"type": "boolean"
},
"autoRedownloadFailed": {
"type": "boolean"
},
"autoRedownloadFailedFromInteractiveSearch": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DownloadClientResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadClientResource"
},
"nullable": true
},
"enable": {
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"priority": {
"type": "integer",
"format": "int32"
},
"removeCompletedDownloads": {
"type": "boolean"
},
"removeFailedDownloads": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DownloadProtocol": {
"enum": [
"unknown",
"usenet",
"torrent"
],
"type": "string"
},
"Edition": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"isbn13": {
"type": "string",
"nullable": true
},
"asin": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"format": {
"type": "string",
"nullable": true
},
"isEbook": {
"type": "boolean"
},
"disambiguation": {
"type": "string",
"nullable": true
},
"publisher": {
"type": "string",
"nullable": true
},
"pageCount": {
"type": "integer",
"format": "int32"
},
"releaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"monitored": {
"type": "boolean"
},
"manualAdd": {
"type": "boolean"
},
"book": {
"$ref": "#/components/schemas/BookLazyLoaded"
},
"bookFiles": {
"$ref": "#/components/schemas/BookFileListLazyLoaded"
}
},
"additionalProperties": false
},
"EditionLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Edition"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"EditionListLazyLoaded": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Edition"
},
"nullable": true,
"readOnly": true
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"EditionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"titleSlug": {
"type": "string",
"nullable": true
},
"isbn13": {
"type": "string",
"nullable": true
},
"asin": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"overview": {
"type": "string",
"nullable": true
},
"format": {
"type": "string",
"nullable": true
},
"isEbook": {
"type": "boolean"
},
"disambiguation": {
"type": "string",
"nullable": true
},
"publisher": {
"type": "string",
"nullable": true
},
"pageCount": {
"type": "integer",
"format": "int32"
},
"releaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Links"
},
"nullable": true
},
"ratings": {
"$ref": "#/components/schemas/Ratings"
},
"monitored": {
"type": "boolean"
},
"manualAdd": {
"type": "boolean"
},
"remoteCover": {
"type": "string",
"nullable": true
},
"grabbed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EntityHistoryEventType": {
"enum": [
"unknown",
"grabbed",
"bookFileImported",
"downloadFailed",
"bookFileDeleted",
"bookFileRenamed",
"bookImportIncomplete",
"downloadImported",
"bookFileRetagged",
"downloadIgnored"
],
"type": "string"
},
"Field": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"unit": {
"type": "string",
"nullable": true
},
"helpText": {
"type": "string",
"nullable": true
},
"helpTextWarning": {
"type": "string",
"nullable": true
},
"helpLink": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"advanced": {
"type": "boolean"
},
"selectOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SelectOption"
},
"nullable": true
},
"selectOptionsProviderAction": {
"type": "string",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"hidden": {
"type": "string",
"nullable": true
},
"placeholder": {
"type": "string",
"nullable": true
},
"isFloat": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FileDateType": {
"enum": [
"none",
"bookReleaseDate"
],
"type": "string"
},
"HealthCheckResult": {
"enum": [
"ok",
"notice",
"warning",
"error"
],
"type": "string"
},
"HealthResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"source": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/HealthCheckResult"
},
"message": {
"type": "string",
"nullable": true
},
"wikiUrl": {
"$ref": "#/components/schemas/HttpUri"
}
},
"additionalProperties": false
},
"HistoryResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32"
},
"sourceTitle": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"qualityCutoffNotMet": {
"type": "boolean"
},
"date": {
"type": "string",
"format": "date-time"
},
"downloadId": {
"type": "string",
"nullable": true
},
"eventType": {
"$ref": "#/components/schemas/EntityHistoryEventType"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"book": {
"$ref": "#/components/schemas/BookResource"
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"additionalProperties": false
},
"HistoryResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"HostConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"bindAddress": {
"type": "string",
"nullable": true
},
"port": {
"type": "integer",
"format": "int32"
},
"sslPort": {
"type": "integer",
"format": "int32"
},
"enableSsl": {
"type": "boolean"
},
"launchBrowser": {
"type": "boolean"
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationType"
},
"analyticsEnabled": {
"type": "boolean"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"logLevel": {
"type": "string",
"nullable": true
},
"consoleLogLevel": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
},
"sslCertPath": {
"type": "string",
"nullable": true
},
"sslCertPassword": {
"type": "string",
"nullable": true
},
"urlBase": {
"type": "string",
"nullable": true
},
"instanceName": {
"type": "string",
"nullable": true
},
"applicationUrl": {
"type": "string",
"nullable": true
},
"updateAutomatically": {
"type": "boolean"
},
"updateMechanism": {
"$ref": "#/components/schemas/UpdateMechanism"
},
"updateScriptPath": {
"type": "string",
"nullable": true
},
"proxyEnabled": {
"type": "boolean"
},
"proxyType": {
"$ref": "#/components/schemas/ProxyType"
},
"proxyHostname": {
"type": "string",
"nullable": true
},
"proxyPort": {
"type": "integer",
"format": "int32"
},
"proxyUsername": {
"type": "string",
"nullable": true
},
"proxyPassword": {
"type": "string",
"nullable": true
},
"proxyBypassFilter": {
"type": "string",
"nullable": true
},
"proxyBypassLocalAddresses": {
"type": "boolean"
},
"certificateValidation": {
"$ref": "#/components/schemas/CertificateValidationType"
},
"backupFolder": {
"type": "string",
"nullable": true
},
"backupInterval": {
"type": "integer",
"format": "int32"
},
"backupRetention": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"HttpUri": {
"type": "object",
"properties": {
"fullUri": {
"type": "string",
"nullable": true,
"readOnly": true
},
"scheme": {
"type": "string",
"nullable": true,
"readOnly": true
},
"host": {
"type": "string",
"nullable": true,
"readOnly": true
},
"port": {
"type": "integer",
"format": "int32",
"nullable": true,
"readOnly": true
},
"path": {
"type": "string",
"nullable": true,
"readOnly": true
},
"query": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fragment": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ICustomFormatSpecification": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"infoLink": {
"type": "string",
"nullable": true,
"readOnly": true
},
"implementationName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ImportListBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enableAutomaticAdd": {
"type": "boolean",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"metadataProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ImportListExclusionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"foreignId": {
"type": "string",
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportListMonitorType": {
"enum": [
"none",
"specificBook",
"entireAuthor"
],
"type": "string"
},
"ImportListResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
},
"nullable": true
},
"enableAutomaticAdd": {
"type": "boolean"
},
"shouldMonitor": {
"$ref": "#/components/schemas/ImportListMonitorType"
},
"shouldMonitorExisting": {
"type": "boolean"
},
"shouldSearch": {
"type": "boolean"
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"monitorNewItems": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"qualityProfileId": {
"type": "integer",
"format": "int32"
},
"metadataProfileId": {
"type": "integer",
"format": "int32"
},
"listType": {
"$ref": "#/components/schemas/ImportListType"
},
"listOrder": {
"type": "integer",
"format": "int32"
},
"minRefreshInterval": {
"$ref": "#/components/schemas/TimeSpan"
}
},
"additionalProperties": false
},
"ImportListType": {
"enum": [
"program",
"goodreads",
"other"
],
"type": "string"
},
"IndexerBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enableRss": {
"type": "boolean",
"nullable": true
},
"enableAutomaticSearch": {
"type": "boolean",
"nullable": true
},
"enableInteractiveSearch": {
"type": "boolean",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"IndexerConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"minimumAge": {
"type": "integer",
"format": "int32"
},
"maximumSize": {
"type": "integer",
"format": "int32"
},
"retention": {
"type": "integer",
"format": "int32"
},
"rssSyncInterval": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IndexerFlagResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"nameLower": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"IndexerFlags": {
"enum": [
"freeleech",
"halfleech",
"doubleUpload",
"internal",
"scene",
"freeleech75",
"freeleech25"
],
"type": "string"
},
"IndexerResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexerResource"
},
"nullable": true
},
"enableRss": {
"type": "boolean"
},
"enableAutomaticSearch": {
"type": "boolean"
},
"enableInteractiveSearch": {
"type": "boolean"
},
"supportsRss": {
"type": "boolean"
},
"supportsSearch": {
"type": "boolean"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"priority": {
"type": "integer",
"format": "int32"
},
"downloadClientId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IsoCountry": {
"type": "object",
"properties": {
"twoLetterCode": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LanguageResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"nameLower": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Links": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"filename": {
"type": "string",
"nullable": true
},
"lastWriteTime": {
"type": "string",
"format": "date-time"
},
"contentsUrl": {
"type": "string",
"nullable": true
},
"downloadUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"time": {
"type": "string",
"format": "date-time"
},
"exception": {
"type": "string",
"nullable": true
},
"exceptionType": {
"type": "string",
"nullable": true
},
"level": {
"type": "string",
"nullable": true
},
"logger": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"method": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManualImportResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64"
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
},
"book": {
"$ref": "#/components/schemas/BookResource"
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"qualityWeight": {
"type": "integer",
"format": "int32"
},
"downloadId": {
"type": "string",
"nullable": true
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"rejections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rejection"
},
"nullable": true
},
"audioTags": {
"$ref": "#/components/schemas/ParsedTrackInfo"
},
"additionalFile": {
"type": "boolean"
},
"replaceExistingFiles": {
"type": "boolean"
},
"disableReleaseSwitching": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ManualImportUpdateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"authorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bookId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"foreignEditionId": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"downloadId": {
"type": "string",
"nullable": true
},
"additionalFile": {
"type": "boolean"
},
"replaceExistingFiles": {
"type": "boolean"
},
"disableReleaseSwitching": {
"type": "boolean"
},
"rejections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rejection"
},
"nullable": true
}
},
"additionalProperties": false
},
"MediaCover": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
},
"coverType": {
"$ref": "#/components/schemas/MediaCoverTypes"
},
"extension": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"MediaCoverTypes": {
"enum": [
"unknown",
"poster",
"banner",
"fanart",
"screenshot",
"headshot",
"cover",
"disc",
"logo",
"clearlogo"
],
"type": "string"
},
"MediaInfoModel": {
"type": "object",
"properties": {
"audioFormat": {
"type": "string",
"nullable": true
},
"audioBitrate": {
"type": "integer",
"format": "int32"
},
"audioChannels": {
"type": "integer",
"format": "int32"
},
"audioBits": {
"type": "integer",
"format": "int32"
},
"audioSampleRate": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"MediaInfoResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"audioChannels": {
"type": "number",
"format": "double"
},
"audioBitRate": {
"type": "string",
"nullable": true
},
"audioCodec": {
"type": "string",
"nullable": true
},
"audioBits": {
"type": "string",
"nullable": true
},
"audioSampleRate": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MediaManagementConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"autoUnmonitorPreviouslyDownloadedBooks": {
"type": "boolean"
},
"recycleBin": {
"type": "string",
"nullable": true
},
"recycleBinCleanupDays": {
"type": "integer",
"format": "int32"
},
"downloadPropersAndRepacks": {
"$ref": "#/components/schemas/ProperDownloadTypes"
},
"createEmptyAuthorFolders": {
"type": "boolean"
},
"deleteEmptyFolders": {
"type": "boolean"
},
"fileDate": {
"$ref": "#/components/schemas/FileDateType"
},
"watchLibraryForChanges": {
"type": "boolean"
},
"rescanAfterRefresh": {
"$ref": "#/components/schemas/RescanAfterRefreshType"
},
"allowFingerprinting": {
"$ref": "#/components/schemas/AllowFingerprinting"
},
"setPermissionsLinux": {
"type": "boolean"
},
"chmodFolder": {
"type": "string",
"nullable": true
},
"chownGroup": {
"type": "string",
"nullable": true
},
"skipFreeSpaceCheckWhenImporting": {
"type": "boolean"
},
"minimumFreeSpaceWhenImporting": {
"type": "integer",
"format": "int32"
},
"copyUsingHardlinks": {
"type": "boolean"
},
"importExtraFiles": {
"type": "boolean"
},
"extraFileExtensions": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MetadataProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"minPopularity": {
"type": "number",
"format": "double"
},
"skipMissingDate": {
"type": "boolean"
},
"skipMissingIsbn": {
"type": "boolean"
},
"skipPartsAndSets": {
"type": "boolean"
},
"skipSeriesSecondary": {
"type": "boolean"
},
"allowedLanguages": {
"type": "string",
"nullable": true
},
"minPages": {
"type": "integer",
"format": "int32"
},
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"MetadataProfileLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/MetadataProfile"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"MetadataProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"minPopularity": {
"type": "number",
"format": "double"
},
"skipMissingDate": {
"type": "boolean"
},
"skipMissingIsbn": {
"type": "boolean"
},
"skipPartsAndSets": {
"type": "boolean"
},
"skipSeriesSecondary": {
"type": "boolean"
},
"allowedLanguages": {
"type": "string",
"nullable": true
},
"minPages": {
"type": "integer",
"format": "int32"
},
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"MetadataProviderConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"writeAudioTags": {
"$ref": "#/components/schemas/WriteAudioTagsType"
},
"scrubAudioTags": {
"type": "boolean"
},
"writeBookTags": {
"$ref": "#/components/schemas/WriteBookTagsType"
},
"updateCovers": {
"type": "boolean"
},
"embedMetadata": {
"type": "boolean"
}
},
"additionalProperties": false
},
"MetadataResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
},
"nullable": true
},
"enable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"MonitorTypes": {
"enum": [
"all",
"future",
"missing",
"existing",
"latest",
"first",
"none",
"unknown"
],
"type": "string"
},
"MonitoringOptions": {
"type": "object",
"properties": {
"monitor": {
"$ref": "#/components/schemas/MonitorTypes"
},
"booksToMonitor": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"monitored": {
"type": "boolean"
}
},
"additionalProperties": false
},
"NamingConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"renameBooks": {
"type": "boolean"
},
"replaceIllegalCharacters": {
"type": "boolean"
},
"colonReplacementFormat": {
"type": "integer",
"format": "int32"
},
"standardBookFormat": {
"type": "string",
"nullable": true
},
"authorFolderFormat": {
"type": "string",
"nullable": true
},
"includeAuthorName": {
"type": "boolean"
},
"includeBookTitle": {
"type": "boolean"
},
"includeQuality": {
"type": "boolean"
},
"replaceSpaces": {
"type": "boolean"
},
"separator": {
"type": "string",
"nullable": true
},
"numberStyle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NewItemMonitorTypes": {
"enum": [
"all",
"none",
"new"
],
"type": "string"
},
"NotificationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
},
"nullable": true
},
"link": {
"type": "string",
"nullable": true
},
"onGrab": {
"type": "boolean"
},
"onReleaseImport": {
"type": "boolean"
},
"onUpgrade": {
"type": "boolean"
},
"onRename": {
"type": "boolean"
},
"onAuthorAdded": {
"type": "boolean"
},
"onAuthorDelete": {
"type": "boolean"
},
"onBookDelete": {
"type": "boolean"
},
"onBookFileDelete": {
"type": "boolean"
},
"onBookFileDeleteForUpgrade": {
"type": "boolean"
},
"onHealthIssue": {
"type": "boolean"
},
"onDownloadFailure": {
"type": "boolean"
},
"onImportFailure": {
"type": "boolean"
},
"onBookRetag": {
"type": "boolean"
},
"onApplicationUpdate": {
"type": "boolean"
},
"supportsOnGrab": {
"type": "boolean"
},
"supportsOnReleaseImport": {
"type": "boolean"
},
"supportsOnUpgrade": {
"type": "boolean"
},
"supportsOnRename": {
"type": "boolean"
},
"supportsOnAuthorAdded": {
"type": "boolean"
},
"supportsOnAuthorDelete": {
"type": "boolean"
},
"supportsOnBookDelete": {
"type": "boolean"
},
"supportsOnBookFileDelete": {
"type": "boolean"
},
"supportsOnBookFileDeleteForUpgrade": {
"type": "boolean"
},
"supportsOnHealthIssue": {
"type": "boolean"
},
"includeHealthWarnings": {
"type": "boolean"
},
"supportsOnDownloadFailure": {
"type": "boolean"
},
"supportsOnImportFailure": {
"type": "boolean"
},
"supportsOnBookRetag": {
"type": "boolean"
},
"supportsOnApplicationUpdate": {
"type": "boolean"
},
"testCommand": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParseResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"parsedBookInfo": {
"$ref": "#/components/schemas/ParsedBookInfo"
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
},
"books": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"ParsedBookInfo": {
"type": "object",
"properties": {
"bookTitle": {
"type": "string",
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
},
"authorTitleInfo": {
"$ref": "#/components/schemas/AuthorTitleInfo"
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"releaseDate": {
"type": "string",
"nullable": true
},
"discography": {
"type": "boolean"
},
"discographyStart": {
"type": "integer",
"format": "int32"
},
"discographyEnd": {
"type": "integer",
"format": "int32"
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"releaseHash": {
"type": "string",
"nullable": true
},
"releaseVersion": {
"type": "string",
"nullable": true
},
"releaseTitle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParsedTrackInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"cleanTitle": {
"type": "string",
"nullable": true
},
"authors": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"authorTitle": {
"type": "string",
"nullable": true,
"readOnly": true
},
"bookTitle": {
"type": "string",
"nullable": true
},
"seriesTitle": {
"type": "string",
"nullable": true
},
"seriesIndex": {
"type": "string",
"nullable": true
},
"isbn": {
"type": "string",
"nullable": true
},
"asin": {
"type": "string",
"nullable": true
},
"goodreadsId": {
"type": "string",
"nullable": true
},
"authorMBId": {
"type": "string",
"nullable": true
},
"bookMBId": {
"type": "string",
"nullable": true
},
"releaseMBId": {
"type": "string",
"nullable": true
},
"recordingMBId": {
"type": "string",
"nullable": true
},
"trackMBId": {
"type": "string",
"nullable": true
},
"discNumber": {
"type": "integer",
"format": "int32"
},
"discCount": {
"type": "integer",
"format": "int32"
},
"country": {
"$ref": "#/components/schemas/IsoCountry"
},
"year": {
"type": "integer",
"format": "int32"
},
"publisher": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"catalogNumber": {
"type": "string",
"nullable": true
},
"disambiguation": {
"type": "string",
"nullable": true
},
"duration": {
"$ref": "#/components/schemas/TimeSpan"
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"mediaInfo": {
"$ref": "#/components/schemas/MediaInfoModel"
},
"trackNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"releaseHash": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PingResource": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProfileFormatItem": {
"type": "object",
"properties": {
"format": {
"$ref": "#/components/schemas/CustomFormat"
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProfileFormatItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"format": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProperDownloadTypes": {
"enum": [
"preferAndUpgrade",
"doNotUpgrade",
"doNotPrefer"
],
"type": "string"
},
"ProviderMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ProviderMessageType"
}
},
"additionalProperties": false
},
"ProviderMessageType": {
"enum": [
"info",
"warning",
"error"
],
"type": "string"
},
"ProxyType": {
"enum": [
"http",
"socks4",
"socks5"
],
"type": "string"
},
"Quality": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"QualityDefinitionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"title": {
"type": "string",
"nullable": true
},
"weight": {
"type": "integer",
"format": "int32"
},
"minSize": {
"type": "number",
"format": "double",
"nullable": true
},
"maxSize": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"QualityModel": {
"type": "object",
"properties": {
"quality": {
"$ref": "#/components/schemas/Quality"
},
"revision": {
"$ref": "#/components/schemas/Revision"
}
},
"additionalProperties": false
},
"QualityProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"upgradeAllowed": {
"type": "boolean"
},
"cutoff": {
"type": "integer",
"format": "int32"
},
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItem"
},
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"QualityProfileLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/QualityProfile"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"QualityProfileQualityItem": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItem"
},
"nullable": true
},
"allowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"QualityProfileQualityItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"allowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"QualityProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"upgradeAllowed": {
"type": "boolean"
},
"cutoff": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItemResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"QueueBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"QueueResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bookId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
},
"book": {
"$ref": "#/components/schemas/BookResource"
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "number",
"format": "double"
},
"title": {
"type": "string",
"nullable": true
},
"sizeleft": {
"type": "number",
"format": "double"
},
"timeleft": {
"$ref": "#/components/schemas/TimeSpan"
},
"estimatedCompletionTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"trackedDownloadStatus": {
"$ref": "#/components/schemas/TrackedDownloadStatus"
},
"trackedDownloadState": {
"$ref": "#/components/schemas/TrackedDownloadState"
},
"statusMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackedDownloadStatusMessage"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"downloadId": {
"type": "string",
"nullable": true
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"downloadClient": {
"type": "string",
"nullable": true
},
"downloadClientHasPostImportCategory": {
"type": "boolean"
},
"indexer": {
"type": "string",
"nullable": true
},
"outputPath": {
"type": "string",
"nullable": true
},
"downloadForced": {
"type": "boolean"
}
},
"additionalProperties": false
},
"QueueResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"QueueStatusResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
},
"unknownCount": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "boolean"
},
"warnings": {
"type": "boolean"
},
"unknownErrors": {
"type": "boolean"
},
"unknownWarnings": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Ratings": {
"type": "object",
"properties": {
"votes": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "double"
},
"popularity": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"Rejection": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/RejectionType"
}
},
"additionalProperties": false
},
"RejectionType": {
"enum": [
"permanent",
"temporary"
],
"type": "string"
},
"ReleaseProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"indexerId": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"guid": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"qualityWeight": {
"type": "integer",
"format": "int32"
},
"age": {
"type": "integer",
"format": "int32"
},
"ageHours": {
"type": "number",
"format": "double"
},
"ageMinutes": {
"type": "number",
"format": "double"
},
"size": {
"type": "integer",
"format": "int64"
},
"indexerId": {
"type": "integer",
"format": "int32"
},
"indexer": {
"type": "string",
"nullable": true
},
"releaseGroup": {
"type": "string",
"nullable": true
},
"subGroup": {
"type": "string",
"nullable": true
},
"releaseHash": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"discography": {
"type": "boolean"
},
"sceneSource": {
"type": "boolean"
},
"airDate": {
"type": "string",
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
},
"bookTitle": {
"type": "string",
"nullable": true
},
"approved": {
"type": "boolean"
},
"temporarilyRejected": {
"type": "boolean"
},
"rejected": {
"type": "boolean"
},
"rejections": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"publishDate": {
"type": "string",
"format": "date-time"
},
"commentUrl": {
"type": "string",
"nullable": true
},
"downloadUrl": {
"type": "string",
"nullable": true
},
"infoUrl": {
"type": "string",
"nullable": true
},
"downloadAllowed": {
"type": "boolean"
},
"releaseWeight": {
"type": "integer",
"format": "int32"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"magnetUrl": {
"type": "string",
"nullable": true
},
"infoHash": {
"type": "string",
"nullable": true
},
"seeders": {
"type": "integer",
"format": "int32",
"nullable": true
},
"leechers": {
"type": "integer",
"format": "int32",
"nullable": true
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"indexerFlags": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bookId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"downloadClientId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"downloadClient": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RemotePathMappingResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"host": {
"type": "string",
"nullable": true
},
"remotePath": {
"type": "string",
"nullable": true
},
"localPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RenameBookResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"bookFileId": {
"type": "integer",
"format": "int32"
},
"existingPath": {
"type": "string",
"nullable": true
},
"newPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RescanAfterRefreshType": {
"enum": [
"always",
"afterManual",
"never"
],
"type": "string"
},
"RetagBookResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"authorId": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"trackNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"bookFileId": {
"type": "integer",
"format": "int32"
},
"path": {
"type": "string",
"nullable": true
},
"changes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDifference"
},
"nullable": true
}
},
"additionalProperties": false
},
"Revision": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"format": "int32"
},
"real": {
"type": "integer",
"format": "int32"
},
"isRepack": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RootFolderResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"defaultMetadataProfileId": {
"type": "integer",
"format": "int32"
},
"defaultQualityProfileId": {
"type": "integer",
"format": "int32"
},
"defaultMonitorOption": {
"$ref": "#/components/schemas/MonitorTypes"
},
"defaultNewItemMonitorOption": {
"$ref": "#/components/schemas/NewItemMonitorTypes"
},
"defaultTags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"isCalibreLibrary": {
"type": "boolean"
},
"host": {
"type": "string",
"nullable": true
},
"port": {
"type": "integer",
"format": "int32"
},
"urlBase": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"library": {
"type": "string",
"nullable": true
},
"outputFormat": {
"type": "string",
"nullable": true
},
"outputProfile": {
"type": "string",
"nullable": true
},
"useSsl": {
"type": "boolean"
},
"accessible": {
"type": "boolean"
},
"freeSpace": {
"type": "integer",
"format": "int64",
"nullable": true
},
"totalSpace": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"RuntimeMode": {
"enum": [
"console",
"service",
"tray"
],
"type": "string"
},
"SelectOption": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"hint": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Series": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"foreignSeriesId": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"numbered": {
"type": "boolean"
},
"workCount": {
"type": "integer",
"format": "int32"
},
"primaryWorkCount": {
"type": "integer",
"format": "int32"
},
"linkItems": {
"$ref": "#/components/schemas/SeriesBookLinkListLazyLoaded"
},
"books": {
"$ref": "#/components/schemas/BookListLazyLoaded"
},
"foreignAuthorId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SeriesBookLink": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"position": {
"type": "string",
"nullable": true
},
"seriesPosition": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
},
"isPrimary": {
"type": "boolean"
},
"series": {
"$ref": "#/components/schemas/SeriesLazyLoaded"
},
"book": {
"$ref": "#/components/schemas/BookLazyLoaded"
}
},
"additionalProperties": false
},
"SeriesBookLinkListLazyLoaded": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesBookLink"
},
"nullable": true,
"readOnly": true
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"SeriesBookLinkResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"position": {
"type": "string",
"nullable": true
},
"seriesPosition": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"bookId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SeriesLazyLoaded": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Series"
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"SeriesListLazyLoaded": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"nullable": true,
"readOnly": true
},
"isLoaded": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"SeriesResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesBookLinkResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"SortDirection": {
"enum": [
"default",
"ascending",
"descending"
],
"type": "string"
},
"SystemResource": {
"type": "object",
"properties": {
"appName": {
"type": "string",
"nullable": true
},
"instanceName": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"buildTime": {
"type": "string",
"format": "date-time"
},
"isDebug": {
"type": "boolean"
},
"isProduction": {
"type": "boolean"
},
"isAdmin": {
"type": "boolean"
},
"isUserInteractive": {
"type": "boolean"
},
"startupPath": {
"type": "string",
"nullable": true
},
"appData": {
"type": "string",
"nullable": true
},
"osName": {
"type": "string",
"nullable": true
},
"osVersion": {
"type": "string",
"nullable": true
},
"isNetCore": {
"type": "boolean"
},
"isLinux": {
"type": "boolean"
},
"isOsx": {
"type": "boolean"
},
"isWindows": {
"type": "boolean"
},
"isDocker": {
"type": "boolean"
},
"mode": {
"$ref": "#/components/schemas/RuntimeMode"
},
"branch": {
"type": "string",
"nullable": true
},
"databaseType": {
"$ref": "#/components/schemas/DatabaseType"
},
"databaseVersion": {
"$ref": "#/components/schemas/Version"
},
"authentication": {
"$ref": "#/components/schemas/AuthenticationType"
},
"migrationVersion": {
"type": "integer",
"format": "int32"
},
"urlBase": {
"type": "string",
"nullable": true
},
"runtimeVersion": {
"$ref": "#/components/schemas/Version"
},
"runtimeName": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"packageVersion": {
"type": "string",
"nullable": true
},
"packageAuthor": {
"type": "string",
"nullable": true
},
"packageUpdateMechanism": {
"$ref": "#/components/schemas/UpdateMechanism"
},
"packageUpdateMechanismMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TagDetailsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"label": {
"type": "string",
"nullable": true
},
"delayProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"importListIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"notificationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"restrictionIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"indexerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"downloadClientIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"authorIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"TagDifference": {
"type": "object",
"properties": {
"field": {
"type": "string",
"nullable": true
},
"oldValue": {
"type": "string",
"nullable": true
},
"newValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TagResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"label": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TaskResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"taskName": {
"type": "string",
"nullable": true
},
"interval": {
"type": "integer",
"format": "int32"
},
"lastExecution": {
"type": "string",
"format": "date-time"
},
"lastStartTime": {
"type": "string",
"format": "date-time"
},
"nextExecution": {
"type": "string",
"format": "date-time"
},
"lastDuration": {
"$ref": "#/components/schemas/TimeSpan"
}
},
"additionalProperties": false
},
"TimeSpan": {
"type": "object",
"properties": {
"ticks": {
"type": "integer",
"format": "int64"
},
"days": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"hours": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"milliseconds": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"minutes": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"seconds": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"totalDays": {
"type": "number",
"format": "double",
"readOnly": true
},
"totalHours": {
"type": "number",
"format": "double",
"readOnly": true
},
"totalMilliseconds": {
"type": "number",
"format": "double",
"readOnly": true
},
"totalMinutes": {
"type": "number",
"format": "double",
"readOnly": true
},
"totalSeconds": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"additionalProperties": false
},
"TrackedDownloadState": {
"enum": [
"downloading",
"downloadFailed",
"downloadFailedPending",
"importPending",
"importing",
"importFailed",
"imported",
"ignored"
],
"type": "string"
},
"TrackedDownloadStatus": {
"enum": [
"ok",
"warning",
"error"
],
"type": "string"
},
"TrackedDownloadStatusMessage": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"UiConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"firstDayOfWeek": {
"type": "integer",
"format": "int32"
},
"calendarWeekColumnHeader": {
"type": "string",
"nullable": true
},
"shortDateFormat": {
"type": "string",
"nullable": true
},
"longDateFormat": {
"type": "string",
"nullable": true
},
"timeFormat": {
"type": "string",
"nullable": true
},
"showRelativeDates": {
"type": "boolean"
},
"enableColorImpairedMode": {
"type": "boolean"
},
"uiLanguage": {
"type": "integer",
"format": "int32"
},
"theme": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateChanges": {
"type": "object",
"properties": {
"new": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fixed": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateMechanism": {
"enum": [
"builtIn",
"script",
"external",
"apt",
"docker"
],
"type": "string"
},
"UpdateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"version": {
"$ref": "#/components/schemas/Version"
},
"branch": {
"type": "string",
"nullable": true
},
"releaseDate": {
"type": "string",
"format": "date-time"
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"installed": {
"type": "boolean"
},
"installedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"installable": {
"type": "boolean"
},
"latest": {
"type": "boolean"
},
"changes": {
"$ref": "#/components/schemas/UpdateChanges"
},
"hash": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Version": {
"type": "object",
"properties": {
"major": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"minor": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"build": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"revision": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"majorRevision": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"minorRevision": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"WriteAudioTagsType": {
"enum": [
"no",
"newFiles",
"allFiles",
"sync"
],
"type": "string"
},
"WriteBookTagsType": {
"enum": [
"newFiles",
"allFiles",
"sync"
],
"type": "string"
}
},
"securitySchemes": {
"X-Api-Key": {
"type": "apiKey",
"description": "Apikey passed as header",
"name": "X-Api-Key",
"in": "header"
},
"apikey": {
"type": "apiKey",
"description": "Apikey passed as header",
"name": "apikey",
"in": "query"
}
}
},
"security": [
{
"X-Api-Key": [ ]
},
{
"apikey": [ ]
}
]
}