Automated API Docs update

pull/10196/head
Servarr 1 month ago committed by Bogdan
parent 3be2c6b0be
commit 8d9f1697ee

@ -2725,36 +2725,20 @@
}
}
},
"/api/v3/exclusions": {
"/api/v3/importlist": {
"get": {
"tags": [
"ImportExclusions"
"ImportList"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2764,13 +2748,23 @@
},
"post": {
"tags": [
"ImportExclusions"
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2779,19 +2773,9 @@
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2799,12 +2783,20 @@
}
}
},
"/api/v3/exclusions/{id}": {
"/api/v3/importlist/{id}": {
"put": {
"tags": [
"ImportExclusions"
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
@ -2818,7 +2810,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2827,19 +2819,9 @@
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2848,7 +2830,7 @@
},
"delete": {
"tags": [
"ImportExclusions"
"ImportList"
],
"parameters": [
{
@ -2869,7 +2851,7 @@
},
"get": {
"tags": [
"ImportExclusions"
"ImportList"
],
"parameters": [
{
@ -2888,17 +2870,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListResource"
}
}
}
@ -2906,35 +2888,42 @@
}
}
},
"/api/v3/exclusions/bulk": {
"post": {
"/api/v3/importlist/bulk": {
"put": {
"tags": [
"ImportExclusions"
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
"$ref": "#/components/schemas/ImportListBulkResource"
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
},
"application/*+json": {
}
}
}
},
"delete": {
"tags": [
"ImportList"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
}
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
@ -2946,7 +2935,7 @@
}
}
},
"/api/v3/importlist": {
"/api/v3/importlist/schema": {
"get": {
"tags": [
"ImportList"
@ -2966,14 +2955,16 @@
}
}
}
},
}
},
"/api/v3/importlist/test": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
@ -2992,34 +2983,31 @@
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
}
}
"description": "OK"
}
}
}
},
"/api/v3/importlist/{id}": {
"put": {
"/api/v3/importlist/testall": {
"post": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/action/{name}": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"name": "name",
"in": "path",
"required": true,
"schema": {
@ -3036,22 +3024,36 @@
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/importlist": {
"get": {
"tags": [
"ImportListConfig"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
}
}
},
"delete": {
}
},
"/api/v3/config/importlist/{id}": {
"put": {
"tags": [
"ImportList"
"ImportListConfig"
],
"parameters": [
{
@ -3059,20 +3061,45 @@
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
}
}
},
"get": {
"tags": [
"ImportList"
"ImportListConfig"
],
"parameters": [
{
@ -3091,17 +3118,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
"$ref": "#/components/schemas/ImportListConfigResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
"$ref": "#/components/schemas/ImportListConfigResource"
}
}
}
@ -3109,68 +3136,58 @@
}
}
},
"/api/v3/importlist/bulk": {
"put": {
"/api/v3/exclusions": {
"get": {
"tags": [
"ImportList"
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"deprecated": true
},
"delete": {
"post": {
"tags": [
"ImportList"
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListBulkResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/schema": {
"get": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListResource"
}
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
@ -3178,84 +3195,44 @@
}
}
},
"/api/v3/importlist/test": {
"post": {
"/api/v3/exclusions/paged": {
"get": {
"tags": [
"ImportList"
"ImportListExclusion"
],
"parameters": [
{
"name": "forceTest",
"name": "page",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
"type": "integer",
"format": "int32",
"default": 1
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/testall": {
"post": {
"tags": [
"ImportList"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/importlist/action/{name}": {
"post": {
"tags": [
"ImportList"
],
"parameters": [
},
{
"name": "name",
"in": "path",
"required": true,
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListResource"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v3/config/importlist": {
"get": {
"tags": [
"ImportListConfig"
],
"responses": {
"200": {
@ -3263,7 +3240,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResourcePagingResource"
}
}
}
@ -3271,10 +3248,10 @@
}
}
},
"/api/v3/config/importlist/{id}": {
"/api/v3/exclusions/{id}": {
"put": {
"tags": [
"ImportListConfig"
"ImportListExclusion"
],
"parameters": [
{
@ -3290,7 +3267,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
@ -3301,26 +3278,47 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
},
"delete": {
"tags": [
"ImportListExclusion"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"ImportListConfig"
"ImportListExclusion"
],
"parameters": [
{
@ -3339,21 +3337,90 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListConfigResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
}
}
},
"/api/v3/exclusions/bulk": {
"post": {
"tags": [
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"ImportListExclusion"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportListExclusionBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
@ -9464,7 +9531,81 @@
},
"additionalProperties": false
},
"ImportExclusionsResource": {
"ImportListBulkResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enabled": {
"type": "boolean",
"nullable": true
},
"enableAuto": {
"type": "boolean",
"nullable": true
},
"rootFolderPath": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minimumAvailability": {
"$ref": "#/components/schemas/MovieStatusType"
}
},
"additionalProperties": false
},
"ImportListConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"listSyncLevel": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportListExclusionBulkResource": {
"type": "object",
"properties": {
"ids": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportListExclusionResource": {
"type": "object",
"properties": {
"id": {
@ -9513,7 +9654,7 @@
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportExclusionsResource"
"$ref": "#/components/schemas/ImportListExclusionResource"
},
"nullable": true
},
@ -9532,64 +9673,33 @@
},
"additionalProperties": false
},
"ImportListBulkResource": {
"ImportListExclusionResourcePagingResource": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"applyTags": {
"$ref": "#/components/schemas/ApplyTags"
},
"enabled": {
"type": "boolean",
"nullable": true
"page": {
"type": "integer",
"format": "int32"
},
"enableAuto": {
"type": "boolean",
"nullable": true
"pageSize": {
"type": "integer",
"format": "int32"
},
"rootFolderPath": {
"sortKey": {
"type": "string",
"nullable": true
},
"qualityProfileId": {
"type": "integer",
"format": "int32",
"nullable": true
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"minimumAvailability": {
"$ref": "#/components/schemas/MovieStatusType"
}
},
"additionalProperties": false
},
"ImportListConfigResource": {
"type": "object",
"properties": {
"id": {
"totalRecords": {
"type": "integer",
"format": "int32"
},
"listSyncLevel": {
"type": "string",
"nullable": true
},
"importExclusions": {
"type": "string",
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportListExclusionResource"
},
"nullable": true
}
},

Loading…
Cancel
Save