open-source-mirrors
/
Radarr
mirror of https://github.com/Radarr/Radarr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Automated API Docs update

Browse Source
pull/10196/head
Servarr 5 months ago committed by Bogdan
parent 3be2c6b0be
commit 8d9f1697ee
1 changed files with 371 additions and 261 deletions
Show Stats Download Patch File Download Diff File

632
src/Radarr.Api.V3/openapi.json
Unescape View File

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

Write Preview
Loading…
Cancel
Save