tedkulp/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2026-04-17 21:26:13 -04:00
Code Issues Projects Releases Wiki Activity

Automated API Docs update

Browse Source 
ignore-downstream
This commit is contained in:
Sonarr
2025-10-20 00:20:11 +00:00
committed by Mark McDowall
parent a4f210855e
commit ca364724cf
1 changed files with 264 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

264
src/Sonarr.Api.V5/openapi.json
View File

@@ -113,6 +113,134 @@
}
}
},
"/api/v5/blocklist": {
"get": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sortKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "seriesIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "protocols",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadProtocol"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource"
}
}
}
}
}
}
},
"/api/v5/blocklist/{id}": {
"delete": {
"tags": [
"Blocklist"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/blocklist/bulk": {
"delete": {
"tags": [
"Blocklist"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BlocklistBulkResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/log": {
"get": {
"tags": [
@@ -224,6 +352,13 @@
"format": "int32"
}
},
{
"name": "message",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "removeFromClient",
"in": "query",
@@ -270,6 +405,13 @@
"Queue"
],
"parameters": [
{
"name": "message",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "removeFromClient",
"in": "query",
@@ -1080,6 +1222,128 @@
},
"additionalProperties": false
},
"BlocklistBulkResource": {
"required": [
"ids"
],
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"BlocklistResource": {
"required": [
"customFormats",
"episodeIds",
"languages",
"quality",
"series",
"sourceTitle"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sourceTitle": {
"type": "string",
"nullable": true
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Language"
},
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/QualityModel"
},
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"protocol": {
"$ref": "#/components/schemas/DownloadProtocol"
},
"indexer": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
}
},
"additionalProperties": false
},
"BlocklistResourcePagingResource": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"sortKey": {
"type": "string",
"nullable": true
},
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"totalRecords": {
"type": "integer",
"format": "int32"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlocklistResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatResource": {
"required": [
"name"