mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-08-07 09:01:25 -04:00
Update OpenAPI documentation
This commit is contained in:
GitHub Action
parent
4646426ac2
commit
e5bdb29482
375
openapi.json
375
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.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.7.6",
|
||||||
"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.5"
|
"version": "0.8.7.6"
|
||||||
},
|
},
|
||||||
"servers": [
|
"servers": [
|
||||||
{
|
{
|
||||||
@ -27,6 +27,68 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"paths": {
|
"paths": {
|
||||||
|
"/api/Account/oidc-authenticated": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"Account"
|
||||||
|
],
|
||||||
|
"summary": "Returns true if OIDC authentication cookies are present",
|
||||||
|
"description": "Makes not guarantee about their validity",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/api/Account": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"Account"
|
||||||
|
],
|
||||||
|
"summary": "Returns the current user, as it would from login",
|
||||||
|
"description": "Does not return tokens for the user",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/UserDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/UserDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/UserDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/api/Account/reset-password": {
|
"/api/Account/reset-password": {
|
||||||
"post": {
|
"post": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -397,6 +459,7 @@
|
|||||||
"Account"
|
"Account"
|
||||||
],
|
],
|
||||||
"summary": "Update the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.",
|
"summary": "Update the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.",
|
||||||
|
"description": "Users who's API.Entities.AppUser.IdentityProvider is not API.Entities.Enums.IdentityProvider.Kavita cannot be edited if API.DTOs.Settings.OidcConfigDto.SyncUserSettings is true",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "",
|
"description": "",
|
||||||
"content": {
|
"content": {
|
||||||
@ -4824,6 +4887,40 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/Oidc/login": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"Oidc"
|
||||||
|
],
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "returnUrl",
|
||||||
|
"in": "query",
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"default": "/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/Oidc/logout": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"Oidc"
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/api/Opds/{apiKey}": {
|
"/api/Opds/{apiKey}": {
|
||||||
"post": {
|
"post": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -13529,6 +13626,86 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/api/Settings/oidc": {
|
||||||
|
"get": {
|
||||||
|
"tags": [
|
||||||
|
"Settings"
|
||||||
|
],
|
||||||
|
"summary": "Retrieve publicly required configuration regarding Oidc",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/OidcPublicConfigDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/OidcPublicConfigDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/OidcPublicConfigDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/api/Settings/is-valid-authority": {
|
||||||
|
"post": {
|
||||||
|
"tags": [
|
||||||
|
"Settings"
|
||||||
|
],
|
||||||
|
"summary": "Validate if the given authority is reachable from the server",
|
||||||
|
"requestBody": {
|
||||||
|
"description": "",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/AuthorityValidationDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/AuthorityValidationDto"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/*+json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/AuthorityValidationDto"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "OK",
|
||||||
|
"content": {
|
||||||
|
"text/plain": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"text/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/api/Stats/user/{userId}/read": {
|
"/api/Stats/user/{userId}/read": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -16588,6 +16765,20 @@
|
|||||||
"description": "The timestamp of when Scrobble Event Generation ran (Utc)",
|
"description": "The timestamp of when Scrobble Event Generation ran (Utc)",
|
||||||
"format": "date-time"
|
"format": "date-time"
|
||||||
},
|
},
|
||||||
|
"oidcId": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The sub returned the by OIDC provider",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"identityProvider": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "The IdentityProvider for the user, default to API.Entities.Enums.IdentityProvider.Kavita",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
"scrobbleHolds": {
|
"scrobbleHolds": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -17853,6 +18044,16 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"AuthorityValidationDto": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"authority": {
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"BookChapterItem": {
|
"BookChapterItem": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -22407,6 +22608,15 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"nullable": true
|
"nullable": true
|
||||||
|
},
|
||||||
|
"identityProvider": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Who provides the identity of the user",
|
||||||
|
"format": "int32"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
@ -22685,6 +22895,139 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"OidcConfigDto": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"autoLogin": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Automatically redirect to the Oidc login screen"
|
||||||
|
},
|
||||||
|
"disablePasswordAuthentication": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Disables password authentication for non-admin users"
|
||||||
|
},
|
||||||
|
"providerName": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Name of your provider, used to display on the login screen",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"authority": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Optional OpenID Connect Authority URL. Not managed in DB. Managed in appsettings.json and synced to DB.",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"clientId": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Optional OpenID Connect ClientId, defaults to kavita. Not managed in DB. Managed in appsettings.json and synced to DB.",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"secret": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Optional OpenID Connect Secret. Not managed in DB. Managed in appsettings.json and synced to DB.",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"provisionAccounts": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "If true, auto creates a new account when someone logs in via OpenID Connect"
|
||||||
|
},
|
||||||
|
"requireVerifiedEmail": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Require emails to be verified by the OpenID Connect provider when creating accounts on login"
|
||||||
|
},
|
||||||
|
"syncUserSettings": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Overwrite Kavita roles, libraries and age rating with OpenIDConnect provided roles on log in."
|
||||||
|
},
|
||||||
|
"rolesPrefix": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "A prefix that all roles Kavita checks for during sync must have",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"rolesClaim": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The JWT claim roles are mapped under, defaults to System.Security.Claims.ClaimTypes.Role",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"customScopes": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"description": "Custom scopes Kavita should request from your OIDC provider",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"defaultRoles": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"defaultLibraries": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "integer",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"defaultAgeRestriction": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1,
|
||||||
|
2,
|
||||||
|
3,
|
||||||
|
4,
|
||||||
|
5,
|
||||||
|
6,
|
||||||
|
7,
|
||||||
|
8,
|
||||||
|
9,
|
||||||
|
10,
|
||||||
|
11,
|
||||||
|
12,
|
||||||
|
13,
|
||||||
|
14,
|
||||||
|
-1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Represents Age Rating for content.",
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
|
"defaultIncludeUnknowns": {
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"enabled": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Returns true if the !:OidcPublicConfigDto.Authority has been set",
|
||||||
|
"readOnly": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"description": "All configuration regarding OIDC"
|
||||||
|
},
|
||||||
|
"OidcPublicConfigDto": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"autoLogin": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Automatically redirect to the Oidc login screen"
|
||||||
|
},
|
||||||
|
"disablePasswordAuthentication": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Disables password authentication for non-admin users"
|
||||||
|
},
|
||||||
|
"providerName": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Name of your provider, used to display on the login screen",
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
|
"enabled": {
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"Person": {
|
"Person": {
|
||||||
"required": [
|
"required": [
|
||||||
"name",
|
"name",
|
||||||
@ -25516,6 +25859,9 @@
|
|||||||
"smtpConfig": {
|
"smtpConfig": {
|
||||||
"$ref": "#/components/schemas/SmtpConfigDto"
|
"$ref": "#/components/schemas/SmtpConfigDto"
|
||||||
},
|
},
|
||||||
|
"oidcConfig": {
|
||||||
|
"$ref": "#/components/schemas/OidcConfigDto"
|
||||||
|
},
|
||||||
"firstInstallDate": {
|
"firstInstallDate": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The Date Kavita was first installed",
|
"description": "The Date Kavita was first installed",
|
||||||
@ -27481,6 +27827,15 @@
|
|||||||
"email": {
|
"email": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
|
},
|
||||||
|
"identityProvider": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Who provides the identity of the user",
|
||||||
|
"format": "int32"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -27569,6 +27924,13 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
},
|
},
|
||||||
|
"roles": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"nullable": true
|
||||||
|
},
|
||||||
"token": {
|
"token": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
@ -27590,6 +27952,15 @@
|
|||||||
"kavitaVersion": {
|
"kavitaVersion": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true
|
"nullable": true
|
||||||
|
},
|
||||||
|
"identityProvider": {
|
||||||
|
"enum": [
|
||||||
|
0,
|
||||||
|
1
|
||||||
|
],
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Who provides the identity of the user",
|
||||||
|
"format": "int32"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user