Cutlery/Kavita
1
0
Fork 0
mirror of https://github.com/Kareadita/Kavita.git synced 2025-11-05 12:03:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update OpenAPI documentation

Browse Source
This commit is contained in:
GitHub Action 2025-11-01 14:57:53 +00:00
parent 0b1b3e71b8
commit 4b2bcda4a0
1 changed files with 211 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

229
openapi.json
View File

@ -2,12 +2,12 @@
"openapi": "3.0.4", "openapi": "3.0.4",
"info": { "info": {
"title": "Kavita", "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": { "license": {
"name": "GPL-3.0", "name": "GPL-3.0",
"url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE" "url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE"
}, },
"version": "0.8.8.3" "version": "0.8.8.4"
}, },
"servers": [ "servers": [
{ {
@ -4075,25 +4075,25 @@
"content": { "content": {
"text/plain": { "text/plain": {
"schema": { "schema": {
"type": "object", "type": "array",
"additionalProperties": { "items": {
"type": "boolean" "type": "string"
} }
} }
}, },
"application/json": { "application/json": {
"schema": { "schema": {
"type": "object", "type": "array",
"additionalProperties": { "items": {
"type": "boolean" "type": "string"
} }
} }
}, },
"text/json": { "text/json": {
"schema": { "schema": {
"type": "object", "type": "array",
"additionalProperties": { "items": {
"type": "boolean" "type": "string"
} }
} }
} }
@ -18815,6 +18815,80 @@
"type": "boolean", "type": "boolean",
"description": "Enable data saver mode across Kavita, limiting information that is pre-fetched" "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": { "aniListScrobblingEnabled": {
"type": "boolean", "type": "boolean",
"description": "Should this account have Scrobbling enabled for AniList" "description": "Should this account have Scrobbling enabled for AniList"
@ -23303,6 +23377,35 @@
}, },
"additionalProperties": false "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": { "KoreaderBookDto": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -23456,6 +23559,11 @@
"type": "boolean", "type": "boolean",
"description": "Should series inherit web links from the first chapter/volume" "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": { "created": {
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
@ -23625,6 +23733,10 @@
}, },
"inheritWebLinksFromFirstChapter": { "inheritWebLinksFromFirstChapter": {
"type": "boolean" "type": "boolean"
},
"defaultLanguage": {
"type": "string",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -28856,6 +28968,10 @@
"inheritWebLinksFromFirstChapter": { "inheritWebLinksFromFirstChapter": {
"type": "boolean" "type": "boolean"
}, },
"defaultLanguage": {
"type": "string",
"nullable": true
},
"fileGroupTypes": { "fileGroupTypes": {
"type": "array", "type": "array",
"items": { "items": {
@ -29469,6 +29585,14 @@
"UpdateStreamPositionDto": { "UpdateStreamPositionDto": {
"type": "object", "type": "object",
"properties": { "properties": {
"streamName": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"fromPosition": { "fromPosition": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -29477,13 +29601,9 @@
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"id": { "positionIncludesInvisible": {
"type": "integer", "type": "boolean",
"format": "int32" "description": "If the API.DTOs.Dashboard.UpdateStreamPositionDto.ToPosition has taken into account non-visible items"
},
"streamName": {
"type": "string",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -29698,6 +29818,7 @@
"bookReaderHighlightSlots", "bookReaderHighlightSlots",
"collapseSeriesRelationships", "collapseSeriesRelationships",
"colorScapeEnabled", "colorScapeEnabled",
"customKeyBinds",
"dataSaver", "dataSaver",
"locale", "locale",
"noTransitions", "noTransitions",
@ -29739,6 +29860,78 @@
"dataSaver": { "dataSaver": {
"type": "boolean" "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": { "aniListScrobblingEnabled": {
"type": "boolean" "type": "boolean"
}, },