From 4b2bcda4a027dae013904b539b918372b056216a Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 1 Nov 2025 14:57:53 +0000 Subject: [PATCH] Update OpenAPI documentation --- openapi.json | 229 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 211 insertions(+), 18 deletions(-) diff --git a/openapi.json b/openapi.json index e6b98b930..be186e2a3 100644 --- a/openapi.json +++ b/openapi.json @@ -2,12 +2,12 @@ "openapi": "3.0.4", "info": { "title": "Kavita", - "description": "Kavita provides a set of APIs that are authenticated by JWT. JWT token can be copied from local storage. Assume all fields of a payload are required. Built against v0.8.8.3", + "description": "Kavita provides a set of APIs that are authenticated by JWT. JWT token can be copied from local storage. Assume all fields of a payload are required. Built against v0.8.8.4", "license": { "name": "GPL-3.0", "url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE" }, - "version": "0.8.8.3" + "version": "0.8.8.4" }, "servers": [ { @@ -4075,25 +4075,25 @@ "content": { "text/plain": { "schema": { - "type": "object", - "additionalProperties": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" } } }, "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" } } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": { - "type": "boolean" + "type": "array", + "items": { + "type": "string" } } } @@ -18815,6 +18815,80 @@ "type": "boolean", "description": "Enable data saver mode across Kavita, limiting information that is pre-fetched" }, + "customKeyBinds": { + "type": "object", + "properties": { + "NavigateToSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "OpenSearch": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "NavigateToScrobbling": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "ToggleFullScreen": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "BookmarkPage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "OpenHelp": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "GoTo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "ToggleMenu": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "PageLeft": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "PageRight": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "Escape": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + } + }, + "additionalProperties": false, + "description": "JSON dictionary mappings for custom keybinds across the web app.\nValues are a list of key codes that need to be pressed at the same time for the keybind to be valid", + "nullable": true + }, "aniListScrobblingEnabled": { "type": "boolean", "description": "Should this account have Scrobbling enabled for AniList" @@ -23303,6 +23377,35 @@ }, "additionalProperties": false }, + "KeyBind": { + "type": "object", + "properties": { + "key": { + "type": "string", + "nullable": true + }, + "control": { + "type": "boolean" + }, + "shift": { + "type": "boolean" + }, + "meta": { + "type": "boolean" + }, + "alt": { + "type": "boolean" + }, + "controllerSequence": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, "KoreaderBookDto": { "type": "object", "properties": { @@ -23456,6 +23559,11 @@ "type": "boolean", "description": "Should series inherit web links from the first chapter/volume" }, + "defaultLanguage": { + "type": "string", + "description": "Language to assign to series if none is set in the metadata", + "nullable": true + }, "created": { "type": "string", "format": "date-time" @@ -23625,6 +23733,10 @@ }, "inheritWebLinksFromFirstChapter": { "type": "boolean" + }, + "defaultLanguage": { + "type": "string", + "nullable": true } }, "additionalProperties": false @@ -28856,6 +28968,10 @@ "inheritWebLinksFromFirstChapter": { "type": "boolean" }, + "defaultLanguage": { + "type": "string", + "nullable": true + }, "fileGroupTypes": { "type": "array", "items": { @@ -29469,6 +29585,14 @@ "UpdateStreamPositionDto": { "type": "object", "properties": { + "streamName": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer", + "format": "int32" + }, "fromPosition": { "type": "integer", "format": "int32" @@ -29477,13 +29601,9 @@ "type": "integer", "format": "int32" }, - "id": { - "type": "integer", - "format": "int32" - }, - "streamName": { - "type": "string", - "nullable": true + "positionIncludesInvisible": { + "type": "boolean", + "description": "If the API.DTOs.Dashboard.UpdateStreamPositionDto.ToPosition has taken into account non-visible items" } }, "additionalProperties": false @@ -29698,6 +29818,7 @@ "bookReaderHighlightSlots", "collapseSeriesRelationships", "colorScapeEnabled", + "customKeyBinds", "dataSaver", "locale", "noTransitions", @@ -29739,6 +29860,78 @@ "dataSaver": { "type": "boolean" }, + "customKeyBinds": { + "type": "object", + "properties": { + "NavigateToSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "OpenSearch": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "NavigateToScrobbling": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "ToggleFullScreen": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "BookmarkPage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "OpenHelp": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "GoTo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "ToggleMenu": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "PageLeft": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "PageRight": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + }, + "Escape": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KeyBind" + } + } + }, + "additionalProperties": false + }, "aniListScrobblingEnabled": { "type": "boolean" },