updated swagger docs

This commit is contained in:
CyferShepard
2024-12-27 00:25:01 +02:00
parent 7eae08c797
commit 42402b7cfd

View File

@@ -74,6 +74,9 @@
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -88,6 +91,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -122,6 +128,9 @@
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -156,6 +165,9 @@
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -177,6 +189,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -213,6 +228,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -244,6 +262,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -275,6 +296,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
@@ -289,6 +313,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"503": {
"description": "Service Unavailable"
}
@@ -303,6 +330,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"503": {
"description": "Service Unavailable"
}
@@ -324,6 +354,9 @@
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
},
"503": {
"description": "Service Unavailable"
}
@@ -357,6 +390,9 @@
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
}
}
@@ -548,6 +584,61 @@
}
}
},
"/api/setExternalUrl": {
"post": {
"tags": ["API"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ExternalUrl": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/api/setPreferredAdmin": {
"post": {
"tags": ["API"],
@@ -1716,6 +1807,98 @@
}
}
},
"/api/getBackupTables": {
"get": {
"tags": ["API"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/api/setExcludedBackupTable": {
"post": {
"tags": ["API"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"table": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/getHistory": {
"get": {
"tags": ["API"],
@@ -1737,7 +1920,12 @@
"type": "string"
},
{
"name": "limit",
"name": "size",
"in": "query",
"type": "string"
},
{
"name": "page",
"in": "query",
"type": "string"
}
@@ -1779,7 +1967,12 @@
"type": "string"
},
{
"name": "limit",
"name": "size",
"in": "query",
"type": "string"
},
{
"name": "page",
"in": "query",
"type": "string"
},
@@ -1838,6 +2031,16 @@
"in": "query",
"type": "string"
},
{
"name": "size",
"in": "query",
"type": "string"
},
{
"name": "page",
"in": "query",
"type": "string"
},
{
"name": "body",
"in": "body",
@@ -1894,7 +2097,12 @@
"type": "string"
},
{
"name": "limit",
"name": "size",
"in": "query",
"type": "string"
},
{
"name": "page",
"in": "query",
"type": "string"
},
@@ -1988,175 +2196,6 @@
}
}
},
"/sync/beginSync": {
"get": {
"tags": ["Sync"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/sync/beginPartialSync": {
"get": {
"tags": ["Sync"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/sync/fetchItem": {
"post": {
"tags": ["Sync"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"itemId": {
"example": "any"
}
}
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/sync/syncPlaybackPluginData": {
"get": {
"tags": ["Sync"],
"description": "",
"parameters": [
{
"name": "authorization",
"in": "header",
"type": "string"
},
{
"name": "x-api-token",
"in": "header",
"type": "string"
},
{
"name": "req",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/stats/getLibraryOverview": {
"get": {
"tags": ["Stats"],
@@ -3411,6 +3450,9 @@
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},