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

Automated API Docs update

Browse Source 
ignore-downstream
This commit is contained in:
Sonarr
2025-11-03 00:20:32 +00:00
committed by Mark McDowall
parent 81c6f3ac75
commit 52ba6f4593
1 changed files with 511 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Sonarr.Api.V5/openapi.json
+511
View File
@@ -241,6 +241,273 @@
}
}
},
"/api/v5/history": {
"get": {
"tags": [
"History"
],
"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": "includeSeries",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "episodeId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seriesIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "languages",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "quality",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource"
}
}
}
}
}
}
},
"/api/v5/history/since": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "date",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v5/history/series": {
"get": {
"tags": [
"History"
],
"parameters": [
{
"name": "seriesId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seasonNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
}
},
{
"name": "includeSeries",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEpisode",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResource"
}
}
}
}
}
}
}
},
"/api/v5/history/failed/{id}": {
"post": {
"tags": [
"History"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/log": {
"get": {
"tags": [
@@ -301,6 +568,51 @@
}
}
},
"/api/v5/log/file": {
"get": {
"tags": [
"LogFile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v5/log/file/{filename}": {
"get": {
"tags": [
"LogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/ping": {
"get": {
"tags": [
@@ -1065,6 +1377,51 @@
}
}
},
"/api/v5/log/file/update": {
"get": {
"tags": [
"UpdateLogFile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogFileResource"
}
}
}
}
}
}
}
},
"/api/v5/log/file/update/{filename}": {
"get": {
"tags": [
"UpdateLogFile"
],
"parameters": [
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/settings/update": {
"get": {
"tags": [
@@ -1515,6 +1872,19 @@
},
"additionalProperties": false
},
"EpisodeHistoryEventType": {
"enum": [
"unknown",
"grabbed",
"seriesFolderImported",
"downloadFolderImported",
"downloadFailed",
"episodeFileDeleted",
"episodeFileRenamed",
"downloadIgnored"
],
"type": "string"
},
"EpisodeResource": {
"required": [
"title"
@@ -1703,6 +2073,115 @@
},
"additionalProperties": false
},
"HistoryResource": {
"required": [
"customFormats",
"data",
"languages",
"quality",
"sourceTitle"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"episodeId": {
"type": "integer",
"format": "int32"
},
"seriesId": {
"type": "integer",
"format": "int32"
},
"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
},
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"qualityCutoffNotMet": {
"type": "boolean"
},
"date": {
"type": "string",
"format": "date-time"
},
"downloadId": {
"type": "string",
"nullable": true
},
"eventType": {
"$ref": "#/components/schemas/EpisodeHistoryEventType"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"episode": {
"$ref": "#/components/schemas/EpisodeResource"
},
"series": {
"$ref": "#/components/schemas/SeriesResource"
}
},
"additionalProperties": false
},
"HistoryResourcePagingResource": {
"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/HistoryResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"Language": {
"type": "object",
"properties": {
@@ -1717,6 +2196,38 @@
},
"additionalProperties": false
},
"LogFileResource": {
"required": [
"contentsUrl",
"downloadUrl",
"filename",
"lastWriteTime"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"filename": {
"type": "string",
"nullable": true
},
"lastWriteTime": {
"type": "string",
"format": "date-time"
},
"contentsUrl": {
"type": "string",
"nullable": true
},
"downloadUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogResource": {
"required": [
"level",