Skip to content

Commit 4b2bcda

Browse files
actions-useractions-user
committed
Update OpenAPI documentation
1 parent 0b1b3e7 commit 4b2bcda

File tree

1 file changed

+210
-17
lines changed

1 file changed

+210
-17
lines changed

‎openapi.json‎

Lines changed: 210 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"openapi": "3.0.4",
33
"info": {
44
"title": "Kavita",
5-
"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.8.3",
5+
"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.8.4",
66
"license": {
77
"name": "GPL-3.0",
88
"url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE"
99
},
10-
"version": "0.8.8.3"
10+
"version": "0.8.8.4"
1111
},
1212
"servers": [
1313
{
@@ -4075,25 +4075,25 @@
40754075
"content": {
40764076
"text/plain": {
40774077
"schema": {
4078-
"type": "object",
4079-
"additionalProperties": {
4080-
"type": "boolean"
4078+
"type": "array",
4079+
"items": {
4080+
"type": "string"
40814081
}
40824082
}
40834083
},
40844084
"application/json": {
40854085
"schema": {
4086-
"type": "object",
4087-
"additionalProperties": {
4088-
"type": "boolean"
4086+
"type": "array",
4087+
"items": {
4088+
"type": "string"
40894089
}
40904090
}
40914091
},
40924092
"text/json": {
40934093
"schema": {
4094-
"type": "object",
4095-
"additionalProperties": {
4096-
"type": "boolean"
4094+
"type": "array",
4095+
"items": {
4096+
"type": "string"
40974097
}
40984098
}
40994099
}
@@ -18815,6 +18815,80 @@
1881518815
"type": "boolean",
1881618816
"description": "Enable data saver mode across Kavita, limiting information that is pre-fetched"
1881718817
},
18818+
"customKeyBinds": {
18819+
"type": "object",
18820+
"properties": {
18821+
"NavigateToSettings": {
18822+
"type": "array",
18823+
"items": {
18824+
"$ref": "#/components/schemas/KeyBind"
18825+
}
18826+
},
18827+
"OpenSearch": {
18828+
"type": "array",
18829+
"items": {
18830+
"$ref": "#/components/schemas/KeyBind"
18831+
}
18832+
},
18833+
"NavigateToScrobbling": {
18834+
"type": "array",
18835+
"items": {
18836+
"$ref": "#/components/schemas/KeyBind"
18837+
}
18838+
},
18839+
"ToggleFullScreen": {
18840+
"type": "array",
18841+
"items": {
18842+
"$ref": "#/components/schemas/KeyBind"
18843+
}
18844+
},
18845+
"BookmarkPage": {
18846+
"type": "array",
18847+
"items": {
18848+
"$ref": "#/components/schemas/KeyBind"
18849+
}
18850+
},
18851+
"OpenHelp": {
18852+
"type": "array",
18853+
"items": {
18854+
"$ref": "#/components/schemas/KeyBind"
18855+
}
18856+
},
18857+
"GoTo": {
18858+
"type": "array",
18859+
"items": {
18860+
"$ref": "#/components/schemas/KeyBind"
18861+
}
18862+
},
18863+
"ToggleMenu": {
18864+
"type": "array",
18865+
"items": {
18866+
"$ref": "#/components/schemas/KeyBind"
18867+
}
18868+
},
18869+
"PageLeft": {
18870+
"type": "array",
18871+
"items": {
18872+
"$ref": "#/components/schemas/KeyBind"
18873+
}
18874+
},
18875+
"PageRight": {
18876+
"type": "array",
18877+
"items": {
18878+
"$ref": "#/components/schemas/KeyBind"
18879+
}
18880+
},
18881+
"Escape": {
18882+
"type": "array",
18883+
"items": {
18884+
"$ref": "#/components/schemas/KeyBind"
18885+
}
18886+
}
18887+
},
18888+
"additionalProperties": false,
18889+
"description": "JSON dictionary mappings for custom keybinds across the web app.\nValues are a list of key codes that need to be pressed at the same time for the keybind to be valid",
18890+
"nullable": true
18891+
},
1881818892
"aniListScrobblingEnabled": {
1881918893
"type": "boolean",
1882018894
"description": "Should this account have Scrobbling enabled for AniList"
@@ -23303,6 +23377,35 @@
2330323377
},
2330423378
"additionalProperties": false
2330523379
},
23380+
"KeyBind": {
23381+
"type": "object",
23382+
"properties": {
23383+
"key": {
23384+
"type": "string",
23385+
"nullable": true
23386+
},
23387+
"control": {
23388+
"type": "boolean"
23389+
},
23390+
"shift": {
23391+
"type": "boolean"
23392+
},
23393+
"meta": {
23394+
"type": "boolean"
23395+
},
23396+
"alt": {
23397+
"type": "boolean"
23398+
},
23399+
"controllerSequence": {
23400+
"type": "array",
23401+
"items": {
23402+
"type": "string"
23403+
},
23404+
"nullable": true
23405+
}
23406+
},
23407+
"additionalProperties": false
23408+
},
2330623409
"KoreaderBookDto": {
2330723410
"type": "object",
2330823411
"properties": {
@@ -23456,6 +23559,11 @@
2345623559
"type": "boolean",
2345723560
"description": "Should series inherit web links from the first chapter/volume"
2345823561
},
23562+
"defaultLanguage": {
23563+
"type": "string",
23564+
"description": "Language to assign to series if none is set in the metadata",
23565+
"nullable": true
23566+
},
2345923567
"created": {
2346023568
"type": "string",
2346123569
"format": "date-time"
@@ -23625,6 +23733,10 @@
2362523733
},
2362623734
"inheritWebLinksFromFirstChapter": {
2362723735
"type": "boolean"
23736+
},
23737+
"defaultLanguage": {
23738+
"type": "string",
23739+
"nullable": true
2362823740
}
2362923741
},
2363023742
"additionalProperties": false
@@ -28856,6 +28968,10 @@
2885628968
"inheritWebLinksFromFirstChapter": {
2885728969
"type": "boolean"
2885828970
},
28971+
"defaultLanguage": {
28972+
"type": "string",
28973+
"nullable": true
28974+
},
2885928975
"fileGroupTypes": {
2886028976
"type": "array",
2886128977
"items": {
@@ -29469,21 +29585,25 @@
2946929585
"UpdateStreamPositionDto": {
2947029586
"type": "object",
2947129587
"properties": {
29472-
"fromPosition": {
29588+
"streamName": {
29589+
"type": "string",
29590+
"nullable": true
29591+
},
29592+
"id": {
2947329593
"type": "integer",
2947429594
"format": "int32"
2947529595
},
29476-
"toPosition": {
29596+
"fromPosition": {
2947729597
"type": "integer",
2947829598
"format": "int32"
2947929599
},
29480-
"id": {
29600+
"toPosition": {
2948129601
"type": "integer",
2948229602
"format": "int32"
2948329603
},
29484-
"streamName": {
29485-
"type": "string",
29486-
"nullable": true
29604+
"positionIncludesInvisible": {
29605+
"type": "boolean",
29606+
"description": "If the API.DTOs.Dashboard.UpdateStreamPositionDto.ToPosition has taken into account non-visible items"
2948729607
}
2948829608
},
2948929609
"additionalProperties": false
@@ -29698,6 +29818,7 @@
2969829818
"bookReaderHighlightSlots",
2969929819
"collapseSeriesRelationships",
2970029820
"colorScapeEnabled",
29821+
"customKeyBinds",
2970129822
"dataSaver",
2970229823
"locale",
2970329824
"noTransitions",
@@ -29739,6 +29860,78 @@
2973929860
"dataSaver": {
2974029861
"type": "boolean"
2974129862
},
29863+
"customKeyBinds": {
29864+
"type": "object",
29865+
"properties": {
29866+
"NavigateToSettings": {
29867+
"type": "array",
29868+
"items": {
29869+
"$ref": "#/components/schemas/KeyBind"
29870+
}
29871+
},
29872+
"OpenSearch": {
29873+
"type": "array",
29874+
"items": {
29875+
"$ref": "#/components/schemas/KeyBind"
29876+
}
29877+
},
29878+
"NavigateToScrobbling": {
29879+
"type": "array",
29880+
"items": {
29881+
"$ref": "#/components/schemas/KeyBind"
29882+
}
29883+
},
29884+
"ToggleFullScreen": {
29885+
"type": "array",
29886+
"items": {
29887+
"$ref": "#/components/schemas/KeyBind"
29888+
}
29889+
},
29890+
"BookmarkPage": {
29891+
"type": "array",
29892+
"items": {
29893+
"$ref": "#/components/schemas/KeyBind"
29894+
}
29895+
},
29896+
"OpenHelp": {
29897+
"type": "array",
29898+
"items": {
29899+
"$ref": "#/components/schemas/KeyBind"
29900+
}
29901+
},
29902+
"GoTo": {
29903+
"type": "array",
29904+
"items": {
29905+
"$ref": "#/components/schemas/KeyBind"
29906+
}
29907+
},
29908+
"ToggleMenu": {
29909+
"type": "array",
29910+
"items": {
29911+
"$ref": "#/components/schemas/KeyBind"
29912+
}
29913+
},
29914+
"PageLeft": {
29915+
"type": "array",
29916+
"items": {
29917+
"$ref": "#/components/schemas/KeyBind"
29918+
}
29919+
},
29920+
"PageRight": {
29921+
"type": "array",
29922+
"items": {
29923+
"$ref": "#/components/schemas/KeyBind"
29924+
}
29925+
},
29926+
"Escape": {
29927+
"type": "array",
29928+
"items": {
29929+
"$ref": "#/components/schemas/KeyBind"
29930+
}
29931+
}
29932+
},
29933+
"additionalProperties": false
29934+
},
2974229935
"aniListScrobblingEnabled": {
2974329936
"type": "boolean"
2974429937
},

0 commit comments

Comments
 (0)