mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-08-05 08:39:59 -04:00
Update OpenAPI documentation
This commit is contained in:
parent
4abe2532bf
commit
412cecaf3c
202
openapi.json
202
openapi.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"openapi": "3.0.4",
|
"openapi": "3.0.4",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "Kavita (v0.8.5.20)",
|
"title": "Kavita (v0.8.5.21)",
|
||||||
"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.5.20",
|
"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.5.21",
|
||||||
"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"
|
||||||
@ -7706,7 +7706,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"ReadingList"
|
"ReadingList"
|
||||||
],
|
],
|
||||||
"summary": "Deletes a list item from the list. Will reorder all item positions afterwards",
|
"summary": "Deletes a list item from the list. Item orders will update as a result.",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "",
|
"description": "",
|
||||||
"content": {
|
"content": {
|
||||||
@ -8002,12 +8002,87 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/api/ReadingList/characters": {
|
"/api/ReadingList/people": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
"ReadingList"
|
"ReadingList"
|
||||||
],
|
],
|
||||||
"summary": "Returns a list of characters associated with the reading list",
|
"summary": "Returns a list of a given role associated with the reading list",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "readingListId",
|
||||||
|
"in": "query",
|
||||||
|
"description": "",
|
||||||
|
"schema": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "role",
|
||||||
|
"in": "query",
|
||||||
|
"description": "PersonRole",
|
||||||
|
"schema": {
|
||||||
|
"enum": [
|
||||||
|
1,
|
||||||
|
3,
|
||||||
|
4,
|
||||||
|
5,
|
||||||
|
6,
|
||||||
|
7,
|
||||||
|
8,
|
||||||
|
9,
|
||||||
|
10,
|
||||||
|
11,
|
||||||
|
12,
|
||||||
|
13,
|
||||||
|
14,
|
||||||
|
15
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/PersonDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/PersonDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/PersonDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/api/ReadingList/all-people": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"ReadingList"
|
||||||
|
],
|
||||||
|
"summary": "Returns all people in given roles for a reading list",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"name": "readingListId",
|
"name": "readingListId",
|
||||||
@ -8264,6 +8339,47 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/api/ReadingList/info": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"ReadingList"
|
||||||
|
],
|
||||||
|
"summary": "Returns random information about a Reading List",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "readingListId",
|
||||||
|
"in": "query",
|
||||||
|
"description": "",
|
||||||
|
"schema": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/ReadingListInfoDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/ReadingListInfoDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/ReadingListInfoDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/api/Recommended/quick-reads": {
|
"/api/Recommended/quick-reads": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -15416,6 +15532,10 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Manga Reader Option: Should swiping trigger pagination"
|
"description": "Manga Reader Option: Should swiping trigger pagination"
|
||||||
},
|
},
|
||||||
|
"allowAutomaticWebtoonReaderDetection": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Manga Reader Option: Allow Automatic Webtoon detection"
|
||||||
|
},
|
||||||
"bookReaderMargin": {
|
"bookReaderMargin": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Book Reader Option: Override extra Margin",
|
"description": "Book Reader Option: Override extra Margin",
|
||||||
@ -20637,6 +20757,9 @@
|
|||||||
"description": "This is a collection of API.Entities.ReadingListItem which represent individual chapters and an order."
|
"description": "This is a collection of API.Entities.ReadingListItem which represent individual chapters and an order."
|
||||||
},
|
},
|
||||||
"ReadingListDto": {
|
"ReadingListDto": {
|
||||||
|
"required": [
|
||||||
|
"ageRating"
|
||||||
|
],
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
@ -20695,6 +20818,61 @@
|
|||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Maximum Month the Reading List starts",
|
"description": "Maximum Month the Reading List starts",
|
||||||
"format": "int32"
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"ageRating": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1,
|
||||||
|
2,
|
||||||
|
3,
|
||||||
|
4,
|
||||||
|
5,
|
||||||
|
6,
|
||||||
|
7,
|
||||||
|
8,
|
||||||
|
9,
|
||||||
|
10,
|
||||||
|
11,
|
||||||
|
12,
|
||||||
|
13,
|
||||||
|
14,
|
||||||
|
-1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "The highest age rating from all Series within the reading list",
|
||||||
|
"format": "int32"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"ReadingListInfoDto": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"pages": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Total Pages across all Reading List Items",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"wordCount": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Total Word count across all Reading List Items",
|
||||||
|
"format": "int64"
|
||||||
|
},
|
||||||
|
"isAllEpub": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Are ALL Reading List Items epub"
|
||||||
|
},
|
||||||
|
"minHoursToRead": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"maxHoursToRead": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"avgHoursToRead": {
|
||||||
|
"type": "number",
|
||||||
|
"format": "float"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -20828,7 +21006,8 @@
|
|||||||
"releaseDate": {
|
"releaseDate": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Release Date from Chapter",
|
"description": "Release Date from Chapter",
|
||||||
"format": "date-time"
|
"format": "date-time",
|
||||||
|
"nullable": true
|
||||||
},
|
},
|
||||||
"readingListId": {
|
"readingListId": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
@ -20838,7 +21017,8 @@
|
|||||||
"lastReadingProgressUtc": {
|
"lastReadingProgressUtc": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The last time a reading list item (underlying chapter) was read by current authenticated user",
|
"description": "The last time a reading list item (underlying chapter) was read by current authenticated user",
|
||||||
"format": "date-time"
|
"format": "date-time",
|
||||||
|
"nullable": true
|
||||||
},
|
},
|
||||||
"fileSize": {
|
"fileSize": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
@ -21254,7 +21434,8 @@
|
|||||||
2,
|
2,
|
||||||
3,
|
3,
|
||||||
4,
|
4,
|
||||||
5
|
5,
|
||||||
|
6
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Which field to sort on",
|
"description": "Which field to sort on",
|
||||||
@ -24883,6 +25064,7 @@
|
|||||||
},
|
},
|
||||||
"UserPreferencesDto": {
|
"UserPreferencesDto": {
|
||||||
"required": [
|
"required": [
|
||||||
|
"allowAutomaticWebtoonReaderDetection",
|
||||||
"autoCloseMenu",
|
"autoCloseMenu",
|
||||||
"backgroundColor",
|
"backgroundColor",
|
||||||
"blurUnreadSummaries",
|
"blurUnreadSummaries",
|
||||||
@ -24990,6 +25172,10 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Manga Reader Option: Show screen hints to the user on some actions, ie) pagination direction change"
|
"description": "Manga Reader Option: Show screen hints to the user on some actions, ie) pagination direction change"
|
||||||
},
|
},
|
||||||
|
"allowAutomaticWebtoonReaderDetection": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Manga Reader Option: Allow Automatic Webtoon detection"
|
||||||
|
},
|
||||||
"bookReaderMargin": {
|
"bookReaderMargin": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Book Reader Option: Override extra Margin",
|
"description": "Book Reader Option: Override extra Margin",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user