{ "openapi": "3.1.0", "info": { "title": "grimmory-proxy API", "description": "Complete Komga v1.12.0 and Admin WebUI API specification for grimmory-proxy.", "version": "1.12.2" }, "paths": { "/actuator/info": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Actuator Info", "operationId": "actuator_info_actuator_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Response Actuator Info Actuator Info Get" } } } } } } }, "/api/v1/claim": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Get Claim Status", "description": "KMreader & Komga client claim check. Returns isClaimed=True.", "operationId": "get_claim_status_api_v1_claim_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimStatusDto" } } } } } }, "post": { "tags": [ "Komga Auth & System" ], "summary": "Claim Server", "description": "Attempting to claim an already claimed server returns 400 Bad Request.", "operationId": "claim_server_api_v1_claim_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/oauth2/providers": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Get Oauth2 Providers", "description": "Returns available OAuth2 providers (empty list for proxy).", "operationId": "get_oauth2_providers_api_v1_oauth2_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OAuth2ClientDto" }, "type": "array", "title": "Response Get Oauth2 Providers Api V1 Oauth2 Providers Get" } } } } } } }, "/api/v1/users/me": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Get Current User V1", "operationId": "get_current_user_v1_api_v1_users_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } } }, "/api/v2/users/me": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Get Current User V2", "operationId": "get_current_user_v2_api_v2_users_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } } }, "/api/v2/users/me/api-keys": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Get Current User Api Keys", "description": "Returns user API keys.", "operationId": "get_current_user_api_keys_api_v2_users_me_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiKeyDto" }, "type": "array", "title": "Response Get Current User Api Keys Api V2 Users Me Api Keys Get" } } } } } }, "post": { "tags": [ "Komga Auth & System" ], "summary": "Create User Api Key", "description": "Creates a new API key for KMreader / client integrations.", "operationId": "create_user_api_key_api_v2_users_me_api_keys_post", "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyDto" } } } } } } }, "/api/v2/users/me/api-keys/{key_id}": { "delete": { "tags": [ "Komga Auth & System" ], "summary": "Delete User Api Key", "operationId": "delete_user_api_key_api_v2_users_me_api_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sse/v1/events": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Sse Events", "description": "Server-Sent Events endpoint for real-time clients like KMreader.", "operationId": "sse_events_sse_v1_events_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/login/set-cookie": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Set Cookie Login", "operationId": "set_cookie_login_api_v1_login_set_cookie_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } } }, "/api/logout": { "get": { "tags": [ "Komga Auth & System" ], "summary": "Logout", "operationId": "logout_get", "responses": { "204": { "description": "Successful Response" } } }, "post": { "tags": [ "Komga Auth & System" ], "summary": "Logout Post", "operationId": "logout_post", "responses": { "204": { "description": "Successful Response" } } } }, "/api/v1/client-settings/global": { "get": { "tags": [ "Komga Client Settings" ], "summary": "Get Global Client Settings", "operationId": "get_global_client_settings_api_v1_client_settings_global_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingDto" }, "type": "object", "title": "Response Get Global Client Settings Api V1 Client Settings Global Get" } } } } } }, "delete": { "tags": [ "Komga Client Settings" ], "summary": "Delete Global Client Settings", "operationId": "delete_global_client_settings_api_v1_client_settings_global_delete", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Names", "default": [] } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Komga Client Settings" ], "summary": "Update Global Client Settings", "operationId": "update_global_client_settings_api_v1_client_settings_global_patch", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingGlobalUpdateDto" }, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/client-settings/global/list": { "get": { "tags": [ "Komga Client Settings" ], "summary": "Get Global Client Settings", "operationId": "get_global_client_settings_api_v1_client_settings_global_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingDto" }, "type": "object", "title": "Response Get Global Client Settings Api V1 Client Settings Global List Get" } } } } } } }, "/api/v1/client-settings/user": { "get": { "tags": [ "Komga Client Settings" ], "summary": "Get User Client Settings", "operationId": "get_user_client_settings_api_v1_client_settings_user_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingDto" }, "type": "object", "title": "Response Get User Client Settings Api V1 Client Settings User Get" } } } } } }, "delete": { "tags": [ "Komga Client Settings" ], "summary": "Delete User Client Settings", "operationId": "delete_user_client_settings_api_v1_client_settings_user_delete", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Names", "default": [] } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Komga Client Settings" ], "summary": "Update User Client Settings", "operationId": "update_user_client_settings_api_v1_client_settings_user_patch", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingUserUpdateDto" }, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/client-settings/user/list": { "get": { "tags": [ "Komga Client Settings" ], "summary": "Get User Client Settings", "operationId": "get_user_client_settings_api_v1_client_settings_user_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ClientSettingDto" }, "type": "object", "title": "Response Get User Client Settings Api V1 Client Settings User List Get" } } } } } } }, "/api/v1/libraries": { "get": { "tags": [ "Komga Libraries" ], "summary": "Get All Libraries", "operationId": "get_all_libraries_api_v1_libraries_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LibraryDto" }, "type": "array", "title": "Response Get All Libraries Api V1 Libraries Get" } } } } } } }, "/api/v1/libraries/{library_id}": { "get": { "tags": [ "Komga Libraries" ], "summary": "Get Library By Id", "operationId": "get_library_by_id_api_v1_libraries__library_id__get", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Library Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibraryDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series": { "get": { "tags": [ "Komga Series" ], "summary": "Get All Series", "operationId": "get_all_series_api_v1_series_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "title,asc", "title": "Sort" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/list": { "post": { "tags": [ "Komga Series" ], "summary": "List Series Post", "operationId": "list_series_post_api_v1_series_list_post", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "title,asc", "title": "Sort" } }, { "name": "body", "in": "query", "required": false, "schema": { "anyOf": [ {}, { "type": "null" } ], "title": "Body" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/latest": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Latest", "operationId": "get_series_latest_api_v1_series_latest_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/new": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series New", "operationId": "get_series_new_api_v1_series_new_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/updated": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Updated", "operationId": "get_series_updated_api_v1_series_updated_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/alphabetical-groups": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Alphabetical Groups", "operationId": "get_series_alphabetical_groups_api_v1_series_alphabetical_groups_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Response Get Series Alphabetical Groups Api V1 Series Alphabetical Groups Get" } } } } } } }, "/api/v1/series/genres": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Genres", "operationId": "get_series_genres_api_v1_series_genres_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Response Get Series Genres Api V1 Series Genres Get" } } } } } } }, "/api/v1/series/release-dates": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Release Dates", "operationId": "get_series_release_dates_api_v1_series_release_dates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Response Get Series Release Dates Api V1 Series Release Dates Get" } } } } } } }, "/api/v1/series/{series_id}": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series By Id", "operationId": "get_series_by_id_api_v1_series__series_id__get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeriesDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/{series_id}/collections": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Collections", "operationId": "get_series_collections_api_v1_series__series_id__collections_get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionDto" }, "title": "Response Get Series Collections Api V1 Series Series Id Collections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/{series_id}/books": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Books", "operationId": "get_series_books_api_v1_series__series_id__books_get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "number,asc", "title": "Sort" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/{series_id}/thumbnail": { "get": { "tags": [ "Komga Series" ], "summary": "Get Series Thumbnail", "operationId": "get_series_thumbnail_api_v1_series__series_id__thumbnail_get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books": { "get": { "tags": [ "Komga Books" ], "summary": "Get All Books", "operationId": "get_all_books_api_v1_books_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "number,asc", "title": "Sort" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/list": { "post": { "tags": [ "Komga Books" ], "summary": "List Books Post", "operationId": "list_books_post_api_v1_books_list_post", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "number,asc", "title": "Sort" } }, { "name": "body", "in": "query", "required": false, "schema": { "anyOf": [ {}, { "type": "null" } ], "title": "Body" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/ondeck": { "get": { "tags": [ "Komga Books" ], "summary": "Get Books Ondeck", "operationId": "get_books_ondeck", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Komga Books" ], "summary": "Get Books Ondeck Post", "operationId": "get_books_ondeck_post", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/latest": { "get": { "tags": [ "Komga Books" ], "summary": "Get Books Latest", "operationId": "get_books_latest", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Komga Books" ], "summary": "Get Books Latest Post", "operationId": "get_books_latest_post", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/released": { "get": { "tags": [ "Komga Books" ], "summary": "Get Books Released", "operationId": "get_books_released", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Komga Books" ], "summary": "Get Books Released Post", "operationId": "get_books_released_post", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book By Id", "operationId": "get_book_by_id_api_v1_books__book_id__get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/previous": { "get": { "tags": [ "Komga Books" ], "summary": "Get Previous Book", "operationId": "get_previous_book_api_v1_books__book_id__previous_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/next": { "get": { "tags": [ "Komga Books" ], "summary": "Get Next Book", "operationId": "get_next_book_api_v1_books__book_id__next_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/thumbnail": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Thumbnail", "operationId": "get_book_thumbnail_api_v1_books__book_id__thumbnail_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/pages": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Pages", "operationId": "get_book_pages_api_v1_books__book_id__pages_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageDto" }, "title": "Response Get Book Pages Api V1 Books Book Id Pages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/pages/{page_number}": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Page Image", "operationId": "get_book_page_image_api_v1_books__book_id__pages__page_number__get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } }, { "name": "page_number", "in": "path", "required": true, "schema": { "type": "integer", "title": "Page Number" } }, { "name": "convert", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Convert" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/pages/{page_number}/thumbnail": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Page Thumbnail", "operationId": "get_book_page_thumbnail_api_v1_books__book_id__pages__page_number__thumbnail_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } }, { "name": "page_number", "in": "path", "required": true, "schema": { "type": "integer", "title": "Page Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/file": { "get": { "tags": [ "Komga Books" ], "summary": "Download Book File", "operationId": "download_book_file_api_v1_books__book_id__file_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/manifest/divina": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Manifest", "operationId": "get_book_manifest_api_v1_books__book_id__manifest_divina_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Book Manifest Api V1 Books Book Id Manifest Divina Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/manifest": { "get": { "tags": [ "Komga Books" ], "summary": "Get Book Manifest", "operationId": "get_book_manifest_api_v1_books__book_id__manifest_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Book Manifest Api V1 Books Book Id Manifest Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/read-progress": { "get": { "tags": [ "Komga Reading Progress" ], "summary": "Get Read Progress", "operationId": "get_read_progress_api_v1_books__book_id__read_progress_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadProgressDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Komga Reading Progress" ], "summary": "Update Read Progress", "operationId": "update_read_progress_api_v1_books__book_id__read_progress_put", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Komga Reading Progress" ], "summary": "Update Read Progress", "operationId": "update_read_progress_api_v1_books__book_id__read_progress_post", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Komga Reading Progress" ], "summary": "Update Read Progress", "operationId": "update_read_progress_api_v1_books__book_id__read_progress_patch", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Komga Reading Progress" ], "summary": "Delete Read Progress", "operationId": "delete_read_progress_api_v1_books__book_id__read_progress_delete", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/{series_id}/read-progress": { "patch": { "tags": [ "Komga Reading Progress" ], "summary": "Mark Series Read Progress", "description": "Mark all books for a series as read (or unread if completed=False).", "operationId": "mark_series_read_progress_api_v1_series__series_id__read_progress_patch", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Komga Reading Progress" ], "summary": "Mark Series Read Progress", "description": "Mark all books for a series as read (or unread if completed=False).", "operationId": "mark_series_read_progress_api_v1_series__series_id__read_progress_put", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Komga Reading Progress" ], "summary": "Mark Series Read Progress", "description": "Mark all books for a series as read (or unread if completed=False).", "operationId": "mark_series_read_progress_api_v1_series__series_id__read_progress_post", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressUpdateDto" }, { "type": "null" } ], "title": "Update Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Komga Reading Progress" ], "summary": "Mark Series As Unread", "description": "Mark all books in a series as unread.", "operationId": "mark_series_as_unread_api_v1_series__series_id__read_progress_delete", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/series/{series_id}/read-progress/tachiyomi": { "get": { "tags": [ "Komga Reading Progress" ], "summary": "Get Tachiyomi Series Progress", "operationId": "get_tachiyomi_series_progress_api_v1_series__series_id__read_progress_tachiyomi_get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachiyomiReadProgressV2Dto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Komga Reading Progress" ], "summary": "Update Tachiyomi Series Progress", "operationId": "update_tachiyomi_series_progress_api_v1_series__series_id__read_progress_tachiyomi_put", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachiyomiReadProgressUpdateV2Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/series/{series_id}/read-progress/tachiyomi": { "get": { "tags": [ "Komga Reading Progress" ], "summary": "Get Tachiyomi Series Progress", "operationId": "get_tachiyomi_series_progress_api_v2_series__series_id__read_progress_tachiyomi_get", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachiyomiReadProgressV2Dto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Komga Reading Progress" ], "summary": "Update Tachiyomi Series Progress", "operationId": "update_tachiyomi_series_progress_api_v2_series__series_id__read_progress_tachiyomi_put", "parameters": [ { "name": "series_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Series Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachiyomiReadProgressUpdateV2Dto" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/books/{book_id}/progression": { "get": { "tags": [ "Komga Reading Progress" ], "summary": "Get Book Progression", "description": "Retrieves Readium (R2) progression JSON for a book.\nReturns 200 with stored JSON, or 204 No Content if not found.", "operationId": "get_book_progression_api_v1_books__book_id__progression_get", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Komga Reading Progress" ], "summary": "Update Book Progression", "description": "Saves Readium (R2) progression JSON from reader applications (Komic, etc.)\nand synchronizes progress back to Grimmory.", "operationId": "update_book_progression_api_v1_books__book_id__progression_put", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Komga Reading Progress" ], "summary": "Delete Book Progression", "operationId": "delete_book_progression_api_v1_books__book_id__progression_delete", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/collections": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Collections", "operationId": "get_collections_api_v1_collections_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_CollectionDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/collections/{collection_id}": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Collection By Id", "operationId": "get_collection_by_id_api_v1_collections__collection_id__get", "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/collections/{collection_id}/series": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Collection Series", "operationId": "get_collection_series_api_v1_collections__collection_id__series_get", "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_SeriesDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/collections/{collection_id}/books": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Collection Books", "operationId": "get_collection_books_api_v1_collections__collection_id__books_get", "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "number,asc", "title": "Sort" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_BookDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/collections/{collection_id}/thumbnail": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Collection Thumbnail", "operationId": "get_collection_thumbnail_api_v1_collections__collection_id__thumbnail_get", "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/readlists": { "get": { "tags": [ "Komga Collections & ReadLists" ], "summary": "Get Readlists", "operationId": "get_readlists_api_v1_readlists_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_ReadListDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/authors": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Authors V1", "operationId": "get_authors_v1_api_v1_authors_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Series Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorDto" }, "title": "Response Get Authors V1 Api V1 Authors Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authors": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Authors V2", "operationId": "get_authors_v2_api_v2_authors_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Series Id" } }, { "name": "readlist_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Readlist Id" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_AuthorDto_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/authors/names": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Author Names V1", "operationId": "get_author_names_v1_api_v1_authors_names_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Library Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Author Names V1 Api V1 Authors Names Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authors/names": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Author Names V2", "operationId": "get_author_names_v2_api_v2_authors_names_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Series Id" } }, { "name": "readlist_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Readlist Id" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_str_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/authors/roles": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Author Roles V1", "operationId": "get_author_roles_v1_api_v1_authors_roles_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Response Get Author Roles V1 Api V1 Authors Roles Get" } } } } } } }, "/api/v2/authors/roles": { "get": { "tags": [ "Komga Authors" ], "summary": "Get Author Roles V2", "operationId": "get_author_roles_v2_api_v2_authors_roles_get", "parameters": [ { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_str_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/genres": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Genres V1", "operationId": "get_genres_v1_api_v1_genres_get", "parameters": [ { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Genres V1 Api V1 Genres Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/genres": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Genres V2", "operationId": "get_genres_v2_api_v2_genres_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_str_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/publishers": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Publishers V1", "operationId": "get_publishers_v1_api_v1_publishers_get", "parameters": [ { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Publishers V1 Api V1 Publishers Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/publishers": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Publishers V2", "operationId": "get_publishers_v2_api_v2_publishers_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_str_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tags": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Tags V1", "operationId": "get_tags_v1_api_v1_tags_get", "parameters": [ { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Tags V1 Api V1 Tags Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/tags": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Tags V2", "operationId": "get_tags_v2_api_v2_tags_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Collection Id" } }, { "name": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Series Id" } }, { "name": "readlist_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Readlist Id" } }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Include" } }, { "name": "unpaged", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unpaged" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 20, "title": "Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableDto_str_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tags/book": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Book Tags V1", "operationId": "get_book_tags_v1_api_v1_tags_book_get", "parameters": [ { "name": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Series Id" } }, { "name": "readlist_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Readlist Id" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Library Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Book Tags V1 Api V1 Tags Book Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tags/series": { "get": { "tags": [ "Komga Metadata" ], "summary": "Get Series Tags V1", "operationId": "get_series_tags_v1_api_v1_tags_series_get", "parameters": [ { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Library Id" } }, { "name": "collection_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Get Series Tags V1 Api V1 Tags Series Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/koreader/users/auth": { "get": { "tags": [ "KOReader Sync" ], "summary": "Koreader Auth", "operationId": "koreader_auth_api_koreader_users_auth_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Koreader Auth Api Koreader Users Auth Get" } } } } } } }, "/koreader/users/auth": { "get": { "tags": [ "KOReader Sync" ], "summary": "Koreader Auth", "operationId": "koreader_auth_koreader_users_auth_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Koreader Auth Koreader Users Auth Get" } } } } } } }, "/api/koreader/users/create": { "post": { "tags": [ "KOReader Sync" ], "summary": "Koreader Register User", "operationId": "koreader_register_user_api_koreader_users_create_post", "responses": { "403": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Koreader Register User Api Koreader Users Create Post" } } } } } } }, "/koreader/users/create": { "post": { "tags": [ "KOReader Sync" ], "summary": "Koreader Register User", "operationId": "koreader_register_user_koreader_users_create_post", "responses": { "403": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Koreader Register User Koreader Users Create Post" } } } } } } }, "/api/koreader/syncs/progress/{book_hash}": { "get": { "tags": [ "KOReader Sync" ], "summary": "Get Koreader Progress Endpoint", "operationId": "get_koreader_progress_endpoint_api_koreader_syncs_progress__book_hash__get", "parameters": [ { "name": "book_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Book Hash" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KoreaderProgressDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/koreader/syncs/progress/{book_hash}": { "get": { "tags": [ "KOReader Sync" ], "summary": "Get Koreader Progress Endpoint", "operationId": "get_koreader_progress_endpoint_koreader_syncs_progress__book_hash__get", "parameters": [ { "name": "book_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Book Hash" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KoreaderProgressDto" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/koreader/syncs/progress": { "put": { "tags": [ "KOReader Sync" ], "summary": "Update Koreader Progress Endpoint", "operationId": "update_koreader_progress_endpoint_api_koreader_syncs_progress_put", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Koreader Progress Endpoint Api Koreader Syncs Progress Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/koreader/syncs/progress": { "put": { "tags": [ "KOReader Sync" ], "summary": "Update Koreader Progress Endpoint", "operationId": "update_koreader_progress_endpoint_koreader_syncs_progress_put", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Koreader Progress Endpoint Koreader Syncs Progress Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/status": { "get": { "tags": [ "Admin WebUI" ], "summary": "Get Dashboard Status", "operationId": "get_dashboard_status_admin_api_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Dashboard Status Admin Api Status Get" } } } } } } }, "/admin/api/calculate-pages": { "post": { "tags": [ "Admin WebUI" ], "summary": "Trigger Calculate Pages", "operationId": "trigger_calculate_pages_admin_api_calculate_pages_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalcPagesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Calculate Pages Admin Api Calculate Pages Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/page-calc/errors": { "get": { "tags": [ "Admin WebUI" ], "summary": "Get Page Calc Errors Endpoint", "operationId": "get_page_calc_errors_endpoint_admin_api_page_calc_errors_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Page Calc Errors Endpoint Admin Api Page Calc Errors Get" } } } } } } }, "/admin/api/page-calc/errors/clear": { "post": { "tags": [ "Admin WebUI" ], "summary": "Clear Page Calc Errors Endpoint", "operationId": "clear_page_calc_errors_endpoint_admin_api_page_calc_errors_clear_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Clear Page Calc Errors Endpoint Admin Api Page Calc Errors Clear Post" } } } } } } }, "/admin/api/stop-calculation": { "post": { "tags": [ "Admin WebUI" ], "summary": "Stop Calculate Pages", "operationId": "stop_calculate_pages_admin_api_stop_calculation_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Stop Calculate Pages Admin Api Stop Calculation Post" } } } } } } }, "/admin/api/sync": { "post": { "tags": [ "Admin WebUI" ], "summary": "Trigger Manual Sync", "operationId": "trigger_manual_sync_admin_api_sync_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Manual Sync Admin Api Sync Post" } } } } } } }, "/admin/api/sync/clear-logs": { "post": { "tags": [ "Admin WebUI" ], "summary": "Clear Sync Logs", "operationId": "clear_sync_logs_admin_api_sync_clear_logs_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Clear Sync Logs Admin Api Sync Clear Logs Post" } } } } } } }, "/admin/api/read-sync": { "post": { "tags": [ "Admin WebUI" ], "summary": "Trigger Manual Read Sync", "operationId": "trigger_manual_read_sync_admin_api_read_sync_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Manual Read Sync Admin Api Read Sync Post" } } } } } } }, "/admin/api/read-sync/clear-logs": { "post": { "tags": [ "Admin WebUI" ], "summary": "Clear Read Sync Logs", "operationId": "clear_read_sync_logs_admin_api_read_sync_clear_logs_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Clear Read Sync Logs Admin Api Read Sync Clear Logs Post" } } } } } } }, "/admin/api/optimize-storage": { "post": { "tags": [ "Admin WebUI" ], "summary": "Optimize Storage Endpoint", "operationId": "optimize_storage_endpoint_admin_api_optimize_storage_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Optimize Storage Endpoint Admin Api Optimize Storage Post" } } } } } } }, "/admin/api/purge-and-refresh": { "post": { "tags": [ "Admin WebUI" ], "summary": "Purge And Refresh Endpoint", "operationId": "purge_and_refresh_endpoint_admin_api_purge_and_refresh_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Purge And Refresh Endpoint Admin Api Purge And Refresh Post" } } } } } } }, "/admin/api/users": { "get": { "tags": [ "Admin WebUI" ], "summary": "Get Users List Endpoint", "operationId": "get_users_list_endpoint_admin_api_users_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Users List Endpoint Admin Api Users Get" } } } } } } }, "/admin/api/users/{user_id}/purge": { "post": { "tags": [ "Admin WebUI" ], "summary": "Purge User Endpoint", "operationId": "purge_user_endpoint_admin_api_users__user_id__purge_post", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Purge User Endpoint Admin Api Users User Id Purge Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/users/{user_id}/sync": { "post": { "tags": [ "Admin WebUI" ], "summary": "Sync User Endpoint", "operationId": "sync_user_endpoint_admin_api_users__user_id__sync_post", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sync User Endpoint Admin Api Users User Id Sync Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/image-compression": { "post": { "tags": [ "Admin WebUI" ], "summary": "Update Image Compression Endpoint", "operationId": "update_image_compression_endpoint_admin_api_image_compression_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageCompressionConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Image Compression Endpoint Admin Api Image Compression Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/image-compression/clear-cache": { "post": { "tags": [ "Admin WebUI" ], "summary": "Clear Image Compression Cache Endpoint", "operationId": "clear_image_compression_cache_endpoint_admin_api_image_compression_clear_cache_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Clear Image Compression Cache Endpoint Admin Api Image Compression Clear Cache Post" } } } } } } }, "/admin/api/settings": { "get": { "tags": [ "Admin WebUI" ], "summary": "Get Settings Endpoint", "operationId": "get_settings_endpoint_admin_api_settings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Settings Endpoint Admin Api Settings Get" } } } } } }, "post": { "tags": [ "Admin WebUI" ], "summary": "Save Settings Endpoint", "operationId": "save_settings_endpoint_admin_api_settings_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Save Settings Endpoint Admin Api Settings Post" } } } } } } }, "/admin/api/books/search": { "get": { "tags": [ "Admin WebUI" ], "summary": "Search Books Endpoint", "operationId": "search_books_endpoint_admin_api_books_search_get", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "name": "library_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Library Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 24, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search Books Endpoint Admin Api Books Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/books/{book_id}/calculate-pages": { "post": { "tags": [ "Admin WebUI" ], "summary": "Trigger Calculate Single Book Pages", "operationId": "trigger_calculate_single_book_pages_admin_api_books__book_id__calculate_pages_post", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Trigger Calculate Single Book Pages Admin Api Books Book Id Calculate Pages Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/books/{book_id}/progress/pull": { "post": { "tags": [ "Admin WebUI" ], "summary": "Pull Book Progress", "operationId": "pull_book_progress_admin_api_books__book_id__progress_pull_post", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pull Book Progress Admin Api Books Book Id Progress Pull Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/books/{book_id}/progress/push": { "post": { "tags": [ "Admin WebUI" ], "summary": "Push Book Progress", "operationId": "push_book_progress_admin_api_books__book_id__progress_push_post", "parameters": [ { "name": "book_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Book Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BookProgressPushRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Push Book Progress Admin Api Books Book Id Progress Push Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/api/logs": { "get": { "tags": [ "Admin WebUI" ], "summary": "Get Logs Endpoint", "operationId": "get_logs_endpoint_admin_api_logs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Logs Endpoint Admin Api Logs Get" } } } } } } }, "/admin/api/logs/clear": { "post": { "tags": [ "Admin WebUI" ], "summary": "Clear Logs Endpoint", "operationId": "clear_logs_endpoint_admin_api_logs_clear_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Clear Logs Endpoint Admin Api Logs Clear Post" } } } } } } } }, "components": { "schemas": { "AgeRestrictionDto": { "properties": { "age": { "type": "integer", "title": "Age" }, "restriction": { "type": "string", "title": "Restriction", "default": "ALLOW_ONLY" } }, "type": "object", "required": [ "age" ], "title": "AgeRestrictionDto" }, "ApiKeyDto": { "properties": { "id": { "type": "string", "title": "Id" }, "key": { "type": "string", "title": "Key" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "lastUsed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastused" } }, "type": "object", "required": [ "id", "key" ], "title": "ApiKeyDto" }, "AuthorDto": { "properties": { "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "title": "Role", "default": "writer" } }, "type": "object", "required": [ "name" ], "title": "AuthorDto" }, "BookDto": { "properties": { "id": { "type": "string", "title": "Id" }, "seriesId": { "type": "string", "title": "Seriesid" }, "seriesTitle": { "type": "string", "title": "Seriestitle" }, "libraryId": { "type": "string", "title": "Libraryid" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url", "default": "" }, "number": { "type": "integer", "title": "Number", "default": 1 }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" }, "fileLastModified": { "type": "string", "title": "Filelastmodified" }, "sizeBytes": { "type": "integer", "title": "Sizebytes", "default": 0 }, "size": { "type": "string", "title": "Size", "default": "0 B" }, "media": { "$ref": "#/components/schemas/MediaDto" }, "metadata": { "$ref": "#/components/schemas/BookMetadataDto" }, "readProgress": { "anyOf": [ { "$ref": "#/components/schemas/ReadProgressDto" }, { "type": "null" } ] }, "deleted": { "type": "boolean", "title": "Deleted", "default": false }, "fileHash": { "type": "string", "title": "Filehash", "default": "" }, "oneshot": { "type": "boolean", "title": "Oneshot", "default": false } }, "type": "object", "required": [ "id", "seriesId", "seriesTitle", "libraryId", "name", "media", "metadata" ], "title": "BookDto" }, "BookMetadataAggregationDto": { "properties": { "authors": { "items": { "$ref": "#/components/schemas/AuthorDto" }, "type": "array", "title": "Authors" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "releaseDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Releasedate" }, "summary": { "type": "string", "title": "Summary", "default": "" }, "summaryNumber": { "type": "string", "title": "Summarynumber", "default": "" }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" } }, "type": "object", "title": "BookMetadataAggregationDto" }, "BookMetadataDto": { "properties": { "title": { "type": "string", "title": "Title", "default": "" }, "titleLock": { "type": "boolean", "title": "Titlelock", "default": false }, "summary": { "type": "string", "title": "Summary", "default": "" }, "summaryLock": { "type": "boolean", "title": "Summarylock", "default": false }, "number": { "type": "string", "title": "Number", "default": "1" }, "numberLock": { "type": "boolean", "title": "Numberlock", "default": false }, "numberSort": { "type": "number", "title": "Numbersort", "default": 1.0 }, "numberSortLock": { "type": "boolean", "title": "Numbersortlock", "default": false }, "releaseDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Releasedate" }, "releaseDateLock": { "type": "boolean", "title": "Releasedatelock", "default": false }, "authors": { "items": { "$ref": "#/components/schemas/AuthorDto" }, "type": "array", "title": "Authors" }, "authorsLock": { "type": "boolean", "title": "Authorslock", "default": false }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "tagsLock": { "type": "boolean", "title": "Tagslock", "default": false }, "isbn": { "type": "string", "title": "Isbn", "default": "" }, "isbnLock": { "type": "boolean", "title": "Isbnlock", "default": false }, "links": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Links" }, "linksLock": { "type": "boolean", "title": "Linkslock", "default": false }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" } }, "type": "object", "title": "BookMetadataDto" }, "BookProgressPushRequest": { "properties": { "completed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Completed" }, "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page" } }, "type": "object", "title": "BookProgressPushRequest" }, "CalcPagesRequest": { "properties": { "missing_only": { "type": "boolean", "title": "Missing Only", "default": true }, "retry_failed_only": { "type": "boolean", "title": "Retry Failed Only", "default": false }, "book_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Book Id" } }, "type": "object", "title": "CalcPagesRequest" }, "ClaimStatusDto": { "properties": { "isClaimed": { "type": "boolean", "title": "Isclaimed", "default": true } }, "type": "object", "title": "ClaimStatusDto" }, "ClientSettingDto": { "properties": { "value": { "type": "string", "title": "Value" }, "allowUnauthorized": { "type": "boolean", "title": "Allowunauthorized", "default": false } }, "type": "object", "required": [ "value" ], "title": "ClientSettingDto" }, "ClientSettingGlobalUpdateDto": { "properties": { "value": { "type": "string", "title": "Value" }, "allowUnauthorized": { "type": "boolean", "title": "Allowunauthorized", "default": false } }, "type": "object", "required": [ "value" ], "title": "ClientSettingGlobalUpdateDto" }, "ClientSettingUserUpdateDto": { "properties": { "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "ClientSettingUserUpdateDto" }, "CollectionDto": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "ordered": { "type": "boolean", "title": "Ordered", "default": false }, "seriesIds": { "items": { "type": "string" }, "type": "array", "title": "Seriesids" }, "createdDate": { "type": "string", "title": "Createddate" }, "lastModifiedDate": { "type": "string", "title": "Lastmodifieddate" }, "filtered": { "type": "boolean", "title": "Filtered", "default": false } }, "type": "object", "required": [ "id", "name" ], "title": "CollectionDto" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImageCompressionConfigRequest": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "format": { "anyOf": [ { "type": "string", "enum": [ "webp", "jpeg", "original" ] }, { "type": "null" } ], "title": "Format" }, "quality": { "anyOf": [ { "type": "integer", "maximum": 100.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Quality" }, "max_dimension": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Dimension" }, "min_size_kb": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Min Size Kb" }, "cache_type": { "anyOf": [ { "type": "string", "enum": [ "memory", "none", "disk" ] }, { "type": "null" } ], "title": "Cache Type" } }, "type": "object", "title": "ImageCompressionConfigRequest" }, "KoreaderProgressDto": { "properties": { "document": { "type": "string", "title": "Document" }, "percentage": { "type": "number", "title": "Percentage", "default": 0.0 }, "progress": { "type": "string", "title": "Progress", "default": "1" }, "device": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Device", "default": "grimmory-proxy" }, "device_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Device Id", "default": "grimmory-proxy" } }, "type": "object", "required": [ "document" ], "title": "KoreaderProgressDto" }, "LibraryDto": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "root": { "type": "string", "title": "Root", "default": "" }, "importComicInfoBook": { "type": "boolean", "title": "Importcomicinfobook", "default": true }, "importComicInfoSeries": { "type": "boolean", "title": "Importcomicinfoseries", "default": true }, "importComicInfoCollection": { "type": "boolean", "title": "Importcomicinfocollection", "default": true }, "importComicInfoReadList": { "type": "boolean", "title": "Importcomicinforeadlist", "default": true }, "importComicInfoSeriesAppendVolume": { "type": "boolean", "title": "Importcomicinfoseriesappendvolume", "default": true }, "importEpubBook": { "type": "boolean", "title": "Importepubbook", "default": true }, "importEpubSeries": { "type": "boolean", "title": "Importepubseries", "default": true }, "importMylarSeries": { "type": "boolean", "title": "Importmylarseries", "default": true }, "importLocalArtwork": { "type": "boolean", "title": "Importlocalartwork", "default": true }, "importBarcodeIsbn": { "type": "boolean", "title": "Importbarcodeisbn", "default": true }, "scanForceModifiedTime": { "type": "boolean", "title": "Scanforcemodifiedtime", "default": false }, "scanInterval": { "type": "string", "title": "Scaninterval", "default": "EVERY_6H" }, "scanOnStartup": { "type": "boolean", "title": "Scanonstartup", "default": false }, "scanCbx": { "type": "boolean", "title": "Scancbx", "default": true }, "scanPdf": { "type": "boolean", "title": "Scanpdf", "default": true }, "scanEpub": { "type": "boolean", "title": "Scanepub", "default": true }, "scanDirectoryExclusions": { "items": { "type": "string" }, "type": "array", "title": "Scandirectoryexclusions" }, "repairExtensions": { "type": "boolean", "title": "Repairextensions", "default": false }, "convertToCbz": { "type": "boolean", "title": "Converttocbz", "default": false }, "emptyTrashAfterScan": { "type": "boolean", "title": "Emptytrashafterscan", "default": false }, "seriesCover": { "type": "string", "title": "Seriescover", "default": "FIRST" }, "seriesCoverSort": { "type": "string", "title": "Seriescoversort", "default": "FIRST" }, "seriesPaging": { "type": "string", "title": "Seriespaging", "default": "DEFAULT" }, "hashFiles": { "type": "boolean", "title": "Hashfiles", "default": false }, "hashPages": { "type": "boolean", "title": "Hashpages", "default": false }, "hashKoreader": { "type": "boolean", "title": "Hashkoreader", "default": false }, "analyzeDimensions": { "type": "boolean", "title": "Analyzedimensions", "default": true }, "oneshotsDirectory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oneshotsdirectory" }, "unavailable": { "type": "boolean", "title": "Unavailable", "default": false } }, "type": "object", "required": [ "id", "name" ], "title": "LibraryDto" }, "MediaDto": { "properties": { "status": { "type": "string", "title": "Status", "default": "READY" }, "mediaType": { "type": "string", "title": "Mediatype", "default": "application/x-cbz" }, "pagesCount": { "type": "integer", "title": "Pagescount", "default": 0 }, "comment": { "type": "string", "title": "Comment", "default": "" }, "mediaProfile": { "type": "string", "title": "Mediaprofile", "default": "DIVINA" }, "epubDivinaCompatible": { "type": "boolean", "title": "Epubdivinacompatible", "default": false }, "epubIsKepub": { "type": "boolean", "title": "Epubiskepub", "default": false } }, "type": "object", "title": "MediaDto" }, "OAuth2ClientDto": { "properties": { "name": { "type": "string", "title": "Name" }, "registrationId": { "type": "string", "title": "Registrationid" } }, "type": "object", "required": [ "name", "registrationId" ], "title": "OAuth2ClientDto" }, "PageDto": { "properties": { "number": { "type": "integer", "title": "Number" }, "fileName": { "type": "string", "title": "Filename" }, "mediaType": { "type": "string", "title": "Mediatype", "default": "image/jpeg" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height" }, "sizeBytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sizebytes" }, "size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Size" } }, "type": "object", "required": [ "number", "fileName" ], "title": "PageDto" }, "PageableDto_AuthorDto_": { "properties": { "content": { "items": { "$ref": "#/components/schemas/AuthorDto" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[AuthorDto]" }, "PageableDto_BookDto_": { "properties": { "content": { "items": { "$ref": "#/components/schemas/BookDto" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[BookDto]" }, "PageableDto_CollectionDto_": { "properties": { "content": { "items": { "$ref": "#/components/schemas/CollectionDto" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[CollectionDto]" }, "PageableDto_ReadListDto_": { "properties": { "content": { "items": { "$ref": "#/components/schemas/ReadListDto" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[ReadListDto]" }, "PageableDto_SeriesDto_": { "properties": { "content": { "items": { "$ref": "#/components/schemas/SeriesDto" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[SeriesDto]" }, "PageableDto_str_": { "properties": { "content": { "items": { "type": "string" }, "type": "array", "title": "Content" }, "pageable": { "additionalProperties": true, "type": "object", "title": "Pageable" }, "totalElements": { "type": "integer", "title": "Totalelements" }, "totalPages": { "type": "integer", "title": "Totalpages" }, "last": { "type": "boolean", "title": "Last" }, "first": { "type": "boolean", "title": "First" }, "size": { "type": "integer", "title": "Size" }, "number": { "type": "integer", "title": "Number" }, "numberOfElements": { "type": "integer", "title": "Numberofelements" }, "empty": { "type": "boolean", "title": "Empty" }, "sort": { "additionalProperties": true, "type": "object", "title": "Sort" } }, "type": "object", "required": [ "content", "totalElements", "totalPages", "last", "first", "size", "number", "numberOfElements", "empty" ], "title": "PageableDto[str]" }, "ReadListDto": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "summary": { "type": "string", "title": "Summary", "default": "" }, "ordered": { "type": "boolean", "title": "Ordered", "default": false }, "bookIds": { "items": { "type": "string" }, "type": "array", "title": "Bookids" }, "createdDate": { "type": "string", "title": "Createddate" }, "lastModifiedDate": { "type": "string", "title": "Lastmodifieddate" }, "filtered": { "type": "boolean", "title": "Filtered", "default": false } }, "type": "object", "required": [ "id", "name" ], "title": "ReadListDto" }, "ReadProgressDto": { "properties": { "page": { "type": "integer", "title": "Page" }, "completed": { "type": "boolean", "title": "Completed" }, "readDate": { "type": "string", "title": "Readdate" }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" }, "deviceId": { "type": "string", "title": "Deviceid", "default": "" }, "deviceName": { "type": "string", "title": "Devicename", "default": "" } }, "type": "object", "required": [ "page", "completed" ], "title": "ReadProgressDto" }, "ReadProgressUpdateDto": { "properties": { "page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page" }, "completed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Completed" } }, "type": "object", "title": "ReadProgressUpdateDto" }, "SeriesDto": { "properties": { "id": { "type": "string", "title": "Id" }, "libraryId": { "type": "string", "title": "Libraryid" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url", "default": "" }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" }, "fileLastModified": { "type": "string", "title": "Filelastmodified" }, "booksCount": { "type": "integer", "title": "Bookscount", "default": 0 }, "booksReadCount": { "type": "integer", "title": "Booksreadcount", "default": 0 }, "booksUnreadCount": { "type": "integer", "title": "Booksunreadcount", "default": 0 }, "booksInProgressCount": { "type": "integer", "title": "Booksinprogresscount", "default": 0 }, "metadata": { "$ref": "#/components/schemas/SeriesMetadataDto" }, "booksMetadata": { "$ref": "#/components/schemas/BookMetadataAggregationDto" }, "deleted": { "type": "boolean", "title": "Deleted", "default": false }, "oneshot": { "type": "boolean", "title": "Oneshot", "default": false } }, "type": "object", "required": [ "id", "libraryId", "name", "metadata", "booksMetadata" ], "title": "SeriesDto" }, "SeriesMetadataDto": { "properties": { "status": { "type": "string", "title": "Status", "default": "ONGOING" }, "statusLock": { "type": "boolean", "title": "Statuslock", "default": false }, "created": { "type": "string", "title": "Created" }, "lastModified": { "type": "string", "title": "Lastmodified" }, "title": { "type": "string", "title": "Title", "default": "" }, "titleLock": { "type": "boolean", "title": "Titlelock", "default": false }, "titleSort": { "type": "string", "title": "Titlesort", "default": "" }, "titleSortLock": { "type": "boolean", "title": "Titlesortlock", "default": false }, "summary": { "type": "string", "title": "Summary", "default": "" }, "summaryLock": { "type": "boolean", "title": "Summarylock", "default": false }, "readingDirection": { "type": "string", "title": "Readingdirection", "default": "LEFT_TO_RIGHT" }, "readingDirectionLock": { "type": "boolean", "title": "Readingdirectionlock", "default": false }, "publisher": { "type": "string", "title": "Publisher", "default": "" }, "publisherLock": { "type": "boolean", "title": "Publisherlock", "default": false }, "ageRating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Agerating" }, "ageRatingLock": { "type": "boolean", "title": "Ageratinglock", "default": false }, "language": { "type": "string", "title": "Language", "default": "en" }, "languageLock": { "type": "boolean", "title": "Languagelock", "default": false }, "genres": { "items": { "type": "string" }, "type": "array", "title": "Genres" }, "genresLock": { "type": "boolean", "title": "Genreslock", "default": false }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "tagsLock": { "type": "boolean", "title": "Tagslock", "default": false }, "totalBookCount": { "type": "integer", "title": "Totalbookcount", "default": 0 }, "totalBookCountLock": { "type": "boolean", "title": "Totalbookcountlock", "default": false }, "sharingLabels": { "items": { "type": "string" }, "type": "array", "title": "Sharinglabels" }, "sharingLabelsLock": { "type": "boolean", "title": "Sharinglabelslock", "default": false }, "links": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Links" }, "linksLock": { "type": "boolean", "title": "Linkslock", "default": false }, "alternateTitles": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Alternatetitles" }, "alternateTitlesLock": { "type": "boolean", "title": "Alternatetitleslock", "default": false } }, "type": "object", "title": "SeriesMetadataDto" }, "TachiyomiReadProgressUpdateV2Dto": { "properties": { "lastBookNumberSortRead": { "type": "number", "title": "Lastbooknumbersortread" } }, "type": "object", "required": [ "lastBookNumberSortRead" ], "title": "TachiyomiReadProgressUpdateV2Dto" }, "TachiyomiReadProgressV2Dto": { "properties": { "booksCount": { "type": "integer", "title": "Bookscount", "default": 0 }, "booksInProgressCount": { "type": "integer", "title": "Booksinprogresscount", "default": 0 }, "booksReadCount": { "type": "integer", "title": "Booksreadcount", "default": 0 }, "booksUnreadCount": { "type": "integer", "title": "Booksunreadcount", "default": 0 }, "lastReadContinuousNumberSort": { "type": "number", "title": "Lastreadcontinuousnumbersort", "default": 0.0 }, "maxNumberSort": { "type": "number", "title": "Maxnumbersort", "default": 0.0 } }, "type": "object", "title": "TachiyomiReadProgressV2Dto" }, "UserDto": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "roles": { "items": { "type": "string" }, "type": "array", "title": "Roles" }, "sharedAllLibraries": { "type": "boolean", "title": "Sharedalllibraries", "default": true }, "sharedLibrariesIds": { "items": { "type": "string" }, "type": "array", "title": "Sharedlibrariesids" }, "labelsAllow": { "items": { "type": "string" }, "type": "array", "title": "Labelsallow" }, "labelsExclude": { "items": { "type": "string" }, "type": "array", "title": "Labelsexclude" }, "ageRestriction": { "anyOf": [ { "$ref": "#/components/schemas/AgeRestrictionDto" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "email" ], "title": "UserDto" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } } }