mirror
/
Radarr
mirror of https://github.com/Radarr/Radarr
1
0
Fork 0
Code Issues Releases Wiki Activity

Ongoing updates to api docs (#5082) [skip ci]

This commit is contained in:
nitsua 2020-10-03 09:25:35 -04:00 committed by GitHub
parent 2161f08140
commit a6758e4bf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 121 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
src/Radarr.Api.V3/swagger.json
View File

@ -68,6 +68,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -208,6 +211,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -289,6 +295,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -333,6 +342,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -364,6 +376,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -429,6 +444,9 @@
} }
}, },
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -502,8 +520,10 @@
}, },
"/diskspace": { "/diskspace": {
"get": { "get": {
"summary": "Get diskspace information", "summary": "Get system diskspace information",
"tags": [], "tags": [
"Disk Space"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -556,6 +576,9 @@
"operationId": "get-diskspace", "operationId": "get-diskspace",
"description": "Query Radarr for disk usage information\n\nLocation: System > Status", "description": "Query Radarr for disk usage information\n\nLocation: System > Status",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -565,7 +588,9 @@
"/status": { "/status": {
"get": { "get": {
"summary": "Get internal information", "summary": "Get internal information",
"tags": [], "tags": [
"Status"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -695,6 +720,9 @@
}, },
"operationId": "get-status", "operationId": "get-status",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -705,8 +733,10 @@
}, },
"/health": { "/health": {
"get": { "get": {
"summary": "Get Radarr health information", "summary": "Get Radarr's health information",
"tags": [], "tags": [
"Health"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -756,6 +786,9 @@
}, },
"operationId": "get-health", "operationId": "get-health",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -766,6 +799,9 @@
"/command": { "/command": {
"post": { "post": {
"summary": "command", "summary": "command",
"tags": [
"Command"
],
"operationId": "post-command", "operationId": "post-command",
"responses": { "responses": {
"200": { "200": {
@ -812,7 +848,9 @@
"/update": { "/update": {
"get": { "get": {
"summary": "List of recent updates", "summary": "List of recent updates",
"tags": [], "tags": [
"Update"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -897,6 +935,9 @@
"operationId": "get-update", "operationId": "get-update",
"description": "Will return a list of recent updates to Radarr\n\nLocation: System > Updates", "description": "Will return a list of recent updates to Radarr\n\nLocation: System > Updates",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -905,8 +946,10 @@
}, },
"/qualityProfile": { "/qualityProfile": {
"get": { "get": {
"summary": "Get quality profiles", "summary": "Get Radarr's quality profiles",
"tags": [], "tags": [
"Quality"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful response", "description": "Successful response",
@ -1032,6 +1075,9 @@
"operationId": "get-add-discover", "operationId": "get-add-discover",
"description": "Query Radarr for quality profiles ", "description": "Query Radarr for quality profiles ",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1041,8 +1087,10 @@
}, },
"/calendar": { "/calendar": {
"get": { "get": {
"summary": "Get calendar events", "summary": "Get Radarr's calendar events",
"tags": [], "tags": [
"Calendar"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request" "description": "Successful request"
@ -1054,6 +1102,9 @@
"operationId": "get-calendar", "operationId": "get-calendar",
"description": "Get a list of movies based on calendar parameters", "description": "Get a list of movies based on calendar parameters",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1090,8 +1141,10 @@
}, },
"/queue": { "/queue": {
"get": { "get": {
"summary": "Get queue items", "summary": "Get Radarr's queue items",
"tags": [], "tags": [
"Queue"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request" "description": "Successful request"
@ -1103,6 +1156,9 @@
"operationId": "get-queue", "operationId": "get-queue",
"description": "Return a json object list of items in the queue", "description": "Return a json object list of items in the queue",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1158,8 +1214,10 @@
}, },
"/history": { "/history": {
"get": { "get": {
"summary": "Get history items", "summary": "Get Radarr's history items",
"tags": [], "tags": [
"History"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -1546,6 +1604,9 @@
"operationId": "get-history", "operationId": "get-history",
"description": "Return a json object list of items in your history", "description": "Return a json object list of items in your history",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1592,8 +1653,10 @@
}, },
"/customFilter": { "/customFilter": {
"get": { "get": {
"summary": "Get custom filters", "summary": "Get Radarr's custom filters",
"tags": [], "tags": [
"Custom Filters"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful response", "description": "Successful response",
@ -1608,7 +1671,7 @@
"label": { "label": {
"type": "string" "type": "string"
}, },
"": { "Radarr's ": {
"type": "object", "type": "object",
"properties": { "properties": {
"key": { "key": {
@ -1669,6 +1732,9 @@
"operationId": "get-customFilter", "operationId": "get-customFilter",
"description": "Query Radarr for custom filters", "description": "Query Radarr for custom filters",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1678,7 +1744,9 @@
"/importList": { "/importList": {
"get": { "get": {
"summary": "Get import list information", "summary": "Get import list information",
"tags": [], "tags": [
"Import"
],
"responses": { "responses": {
"200": { "200": {
"description": "Succesful response ", "description": "Succesful response ",
@ -1810,6 +1878,9 @@
"operationId": "get-importList", "operationId": "get-importList",
"description": "Query Radarr for all lists", "description": "Query Radarr for all lists",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1819,7 +1890,9 @@
"/ui": { "/ui": {
"get": { "get": {
"summary": "Get UI settings", "summary": "Get UI settings",
"tags": [], "tags": [
"UI"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -1886,6 +1959,9 @@
"operationId": "get-ui", "operationId": "get-ui",
"description": "Query Radarr for UI settings", "description": "Query Radarr for UI settings",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1895,7 +1971,9 @@
"/remotePathMapping": { "/remotePathMapping": {
"get": { "get": {
"summary": "Get Radarr's remote path mappings", "summary": "Get Radarr's remote path mappings",
"tags": [], "tags": [
"Remote Path Mapping"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request", "description": "Successful request",
@ -1946,6 +2024,9 @@
"operationId": "get-remotePathMapping", "operationId": "get-remotePathMapping",
"description": "Get a list of remote paths being mapped and used by Radarr", "description": "Get a list of remote paths being mapped and used by Radarr",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1955,7 +2036,9 @@
"/downloadClient": { "/downloadClient": {
"get": { "get": {
"summary": "Get Radarr's download client list", "summary": "Get Radarr's download client list",
"tags": [], "tags": [
"Download Client"
],
"responses": { "responses": {
"200": { "200": {
"description": "Successful request" "description": "Successful request"
@ -1967,6 +2050,9 @@
"operationId": "get-downloadClient", "operationId": "get-downloadClient",
"description": "Get a list of all the download clients added in Radarr", "description": "Get a list of all the download clients added in Radarr",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -1976,7 +2062,9 @@
"/blackList": { "/blackList": {
"get": { "get": {
"summary": "Get Radarr's blacklisted movies", "summary": "Get Radarr's blacklisted movies",
"tags": [], "tags": [
"Blacklist"
],
"responses": { "responses": {
"200": { "200": {
"description": "Invalid API Key", "description": "Invalid API Key",
@ -2028,6 +2116,9 @@
"operationId": "get-blackList", "operationId": "get-blackList",
"description": "", "description": "",
"security": [ "security": [
{
"X-API-Key": []
},
{ {
"api key": [] "api key": []
} }
@ -2085,7 +2176,7 @@
"description": "Removes a specific movie (the id provided) from the blacklist", "description": "Removes a specific movie (the id provided) from the blacklist",
"security": [ "security": [
{ {
"api key": [] "X-API-Key": []
} }
], ],
"parameters": [ "parameters": [
@ -2340,16 +2431,16 @@
} }
}, },
"securitySchemes": { "securitySchemes": {
"api key": {
"name": "apiKey",
"type": "apiKey",
"in": "query",
"description": "Used when not providing key via header"
},
"X-API-Key": { "X-API-Key": {
"type": "http", "type": "http",
"scheme": "basic", "scheme": "basic",
"description": "Used when not providing key via URL" "description": "Used when not providing the key via URL"
},
"api key": {
"name": "API Key",
"type": "apiKey",
"in": "query",
"description": "Used when not providing the key via header"
} }
} }
} }