Cutlery/Kavita
1
0
Fork 0
mirror of https://github.com/Kareadita/Kavita.git synced 2025-09-29 15:30:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update OpenAPI documentation

Browse Source
This commit is contained in:
GitHub Action 2025-09-20 20:18:14 +00:00
parent 1cd644ac1d
commit ba01a38d20
1 changed files with 71 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
openapi.json
View File

@ -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.7.14",
"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.7.15",
"license": {
"name": "GPL-3.0",
"url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE"
},
"version": "0.8.7.14"
"version": "0.8.7.15"
},
"servers": [
{
@ -427,7 +427,9 @@
"tags": [
"Account"
],
"summary": "Change the Age Rating restriction for the user",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
@ -1016,6 +1018,47 @@
}
}
},
"/api/Annotation/all-for-series": {
"get": {
"tags": [
"Annotation"
],
"summary": "Returns all annotations by Series",
"parameters": [
{
"name": "seriesId",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AnnotationDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationDto"
}
}
}
}
}
}
},
"/api/Annotation/{annotationId}": {
"get": {
"tags": [
@ -5225,27 +5268,14 @@
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/Opds/{apiKey}/external-sources": {
"get": {
"tags": [
"Opds"
],
"parameters": [
{
"name": "apiKey",
"in": "path",
"required": true,
"name": "pageNumber",
"in": "query",
"schema": {
"type": "string"
"type": "integer",
"format": "int32",
"default": 0
}
}
],
@ -5322,6 +5352,15 @@
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
@ -5557,10 +5596,12 @@
"tags": [
"Opds"
],
"summary": "Returns recently updated series. While pagination is avaible, total amount of pages is not due to implementation\ndetails",
"parameters": [
{
"name": "apiKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
@ -5569,6 +5610,7 @@
{
"name": "pageNumber",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
@ -17973,6 +18015,10 @@
"description": "UI Site Global Setting: The language locale that should be used for the user",
"nullable": true
},
"colorScapeEnabled": {
"type": "boolean",
"description": "UI Site Global Setting: Should Kavita render ColorScape gradients"
},
"aniListScrobblingEnabled": {
"type": "boolean",
"description": "Should this account have Scrobbling enabled for AniList"
@ -28617,6 +28663,7 @@
"blurUnreadSummaries",
"bookReaderHighlightSlots",
"collapseSeriesRelationships",
"colorScapeEnabled",
"locale",
"noTransitions",
"promptForDownloadSize",
@ -28655,6 +28702,9 @@
"minLength": 1,
"type": "string"
},
"colorScapeEnabled": {
"type": "boolean"
},
"aniListScrobblingEnabled": {
"type": "boolean"
},