mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-09-29 15:30:50 -04:00
Update OpenAPI documentation
This commit is contained in:
parent
1cd644ac1d
commit
ba01a38d20
90
openapi.json
90
openapi.json
@ -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.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": {
|
"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.7.14"
|
"version": "0.8.7.15"
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
{
|
{
|
||||||
@ -427,7 +427,9 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Account"
|
"Account"
|
||||||
],
|
],
|
||||||
|
"summary": "Change the Age Rating restriction for the user",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
|
"description": "",
|
||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"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}": {
|
"/api/Annotation/{annotationId}": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -5225,27 +5268,14 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
}
|
|
||||||
],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "OK"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"/api/Opds/{apiKey}/external-sources": {
|
|
||||||
"get": {
|
|
||||||
"tags": [
|
|
||||||
"Opds"
|
|
||||||
],
|
|
||||||
"parameters": [
|
|
||||||
{
|
{
|
||||||
"name": "apiKey",
|
"name": "pageNumber",
|
||||||
"in": "path",
|
"in": "query",
|
||||||
"required": true,
|
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "integer",
|
||||||
|
"format": "int32",
|
||||||
|
"default": 0
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@ -5322,6 +5352,15 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "pageNumber",
|
||||||
|
"in": "query",
|
||||||
|
"schema": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32",
|
||||||
|
"default": 0
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -5557,10 +5596,12 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Opds"
|
"Opds"
|
||||||
],
|
],
|
||||||
|
"summary": "Returns recently updated series. While pagination is avaible, total amount of pages is not due to implementation\ndetails",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"name": "apiKey",
|
"name": "apiKey",
|
||||||
"in": "path",
|
"in": "path",
|
||||||
|
"description": "",
|
||||||
"required": true,
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -5569,6 +5610,7 @@
|
|||||||
{
|
{
|
||||||
"name": "pageNumber",
|
"name": "pageNumber",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
|
"description": "",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int32",
|
"format": "int32",
|
||||||
@ -17973,6 +18015,10 @@
|
|||||||
"description": "UI Site Global Setting: The language locale that should be used for the user",
|
"description": "UI Site Global Setting: The language locale that should be used for the user",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
},
|
},
|
||||||
|
"colorScapeEnabled": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "UI Site Global Setting: Should Kavita render ColorScape gradients"
|
||||||
|
},
|
||||||
"aniListScrobblingEnabled": {
|
"aniListScrobblingEnabled": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Should this account have Scrobbling enabled for AniList"
|
"description": "Should this account have Scrobbling enabled for AniList"
|
||||||
@ -28617,6 +28663,7 @@
|
|||||||
"blurUnreadSummaries",
|
"blurUnreadSummaries",
|
||||||
"bookReaderHighlightSlots",
|
"bookReaderHighlightSlots",
|
||||||
"collapseSeriesRelationships",
|
"collapseSeriesRelationships",
|
||||||
|
"colorScapeEnabled",
|
||||||
"locale",
|
"locale",
|
||||||
"noTransitions",
|
"noTransitions",
|
||||||
"promptForDownloadSize",
|
"promptForDownloadSize",
|
||||||
@ -28655,6 +28702,9 @@
|
|||||||
"minLength": 1,
|
"minLength": 1,
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"colorScapeEnabled": {
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
"aniListScrobblingEnabled": {
|
"aniListScrobblingEnabled": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
|
Loading…
x
Reference in New Issue
Block a user