mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-07-09 03:04:19 -04:00
Update OpenAPI documentation
This commit is contained in:
GitHub Action
parent
7ccf743f9f
commit
0ea1116d1d
188
openapi.json
188
openapi.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"openapi": "3.0.4",
|
"openapi": "3.0.4",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "Kavita (v0.8.6.1)",
|
"title": "Kavita (v0.8.6.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.6.1",
|
"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.6.3",
|
||||||
"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"
|
||||||
@ -8983,7 +8983,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -11186,7 +11188,6 @@
|
|||||||
{
|
{
|
||||||
"name": "aniListId",
|
"name": "aniListId",
|
||||||
"in": "query",
|
"in": "query",
|
||||||
"description": "",
|
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int32"
|
"format": "int32"
|
||||||
@ -11199,6 +11200,14 @@
|
|||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int64"
|
"format": "int64"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "cbrId",
|
||||||
|
"in": "query",
|
||||||
|
"schema": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@ -15380,7 +15389,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Who created/manages the list. Non-Kavita lists are not editable by the user, except to promote",
|
"description": "Who created/manages the list. Non-Kavita lists are not editable by the user, except to promote",
|
||||||
@ -15488,7 +15499,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Who created/manages the list. Non-Kavita lists are not editable by the user, except to promote",
|
"description": "Who created/manages the list. Non-Kavita lists are not editable by the user, except to promote",
|
||||||
@ -17497,6 +17510,15 @@
|
|||||||
"person": {
|
"person": {
|
||||||
"$ref": "#/components/schemas/Person"
|
"$ref": "#/components/schemas/Person"
|
||||||
},
|
},
|
||||||
|
"kavitaPlusConnection": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The source of this connection. If not Kavita, this implies Metadata Download linked this and it can be removed between matches"
|
||||||
|
},
|
||||||
|
"orderWeight": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "A weight that allows lower numbers to sort first",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
"role": {
|
"role": {
|
||||||
"enum": [
|
"enum": [
|
||||||
1,
|
1,
|
||||||
@ -18220,6 +18242,80 @@
|
|||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"description": "Represents if Test Email Service URL was successful or not and if any error occured"
|
"description": "Represents if Test Email Service URL was successful or not and if any error occured"
|
||||||
},
|
},
|
||||||
|
"ExternalChapterDto": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"title": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"issueNumber": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"criticRating": {
|
||||||
|
"type": "number",
|
||||||
|
"format": "double",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"userRating": {
|
||||||
|
"type": "number",
|
||||||
|
"format": "double",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"summary": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"writers": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"artists": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"releaseDate": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"publisher": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"coverImageUrl": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"issueUrl": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"criticReviews": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/UserReviewDto"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"userReviews": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/UserReviewDto"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"description": "Information about an individual issue/chapter/book from Kavita+"
|
||||||
|
},
|
||||||
"ExternalRating": {
|
"ExternalRating": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -18239,7 +18335,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -18305,7 +18403,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -18361,7 +18461,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -18422,6 +18524,11 @@
|
|||||||
"format": "int64",
|
"format": "int64",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
},
|
},
|
||||||
|
"cbrId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
"synonyms": {
|
"synonyms": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -18478,7 +18585,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -18519,6 +18628,18 @@
|
|||||||
"$ref": "#/components/schemas/SeriesCharacter"
|
"$ref": "#/components/schemas/SeriesCharacter"
|
||||||
},
|
},
|
||||||
"nullable": true
|
"nullable": true
|
||||||
|
},
|
||||||
|
"publisher": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"chapterDtos": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/ExternalChapterDto"
|
||||||
|
},
|
||||||
|
"description": "Only from CBR for API.Services.Plus.ScrobbleProvider.Cbr. Full metadata about issues",
|
||||||
|
"nullable": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -18562,7 +18683,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -18623,6 +18746,10 @@
|
|||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int32"
|
"format": "int32"
|
||||||
},
|
},
|
||||||
|
"cbrId": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
"malId": {
|
"malId": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"format": "int64"
|
"format": "int64"
|
||||||
@ -20265,6 +20392,26 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Allow setting the cover image"
|
"description": "Allow setting the cover image"
|
||||||
},
|
},
|
||||||
|
"enableChapterSummary": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Allow Summary to be set within Chapter/Issue"
|
||||||
|
},
|
||||||
|
"enableChapterReleaseDate": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Allow Release Date to be set within Chapter/Issue"
|
||||||
|
},
|
||||||
|
"enableChapterTitle": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Allow Title to be set within Chapter/Issue"
|
||||||
|
},
|
||||||
|
"enableChapterPublisher": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Allow Publisher to be set within Chapter/Issue"
|
||||||
|
},
|
||||||
|
"enableChapterCoverImage": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Allow setting the cover image for the Chapter/Issue"
|
||||||
|
},
|
||||||
"enableGenres": {
|
"enableGenres": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
@ -20323,7 +20470,12 @@
|
|||||||
6,
|
6,
|
||||||
7,
|
7,
|
||||||
8,
|
8,
|
||||||
9
|
9,
|
||||||
|
10,
|
||||||
|
11,
|
||||||
|
12,
|
||||||
|
13,
|
||||||
|
14
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Represents which field that can be written to as an override when already locked",
|
"description": "Represents which field that can be written to as an override when already locked",
|
||||||
@ -20705,7 +20857,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -22884,7 +23038,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
"description": "Misleading name but is the source of data (like a review coming from AniList)",
|
||||||
@ -25553,7 +25709,9 @@
|
|||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
2
|
2,
|
||||||
|
3,
|
||||||
|
4
|
||||||
],
|
],
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"description": "If this review is External, which Provider did it come from",
|
"description": "If this review is External, which Provider did it come from",
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user