Cutlery/Kavita
1
0
Fork 0
mirror of https://github.com/Kareadita/Kavita.git synced 2025-07-31 14:33:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update OpenAPI documentation

Browse Source
This commit is contained in:
GitHub Action 2025-07-24 19:39:10 +00:00
parent c4701987d7
commit 22058f7413
1 changed files with 113 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
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.0",
"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.4",
"license": {
"name": "GPL-3.0",
"url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE"
},
"version": "0.8.7.0"
"version": "0.8.7.4"
},
"servers": [
{
@ -3206,6 +3206,64 @@
}
}
},
"/api/Library/has-files-at-root": {
"post": {
"tags": [
"Library"
],
"summary": "For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckForFilesInFolderRootsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CheckForFilesInFolderRootsDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CheckForFilesInFolderRootsDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
}
}
}
}
}
},
"/api/Library": {
"get": {
"tags": [
@ -5995,6 +6053,46 @@
}
}
},
"/api/Person/valid-asin": {
"get": {
"tags": [
"Person"
],
"summary": "Validates if the ASIN (10/13) is valid",
"parameters": [
{
"name": "asin",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/api/Person/fetch-cover": {
"post": {
"tags": [
@ -19228,6 +19326,19 @@
},
"additionalProperties": false
},
"CheckForFilesInFolderRootsDto": {
"type": "object",
"properties": {
"roots": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"CollectionTag": {
"required": [
"normalizedTitle",