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
2026-02-16 00:26:04 +00:00
committed by Mark McDowall
parent 9c61a5c286
commit 49f6117d54
1 changed files with 538 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Sonarr.Api.V5/openapi.json
+538
View File
@@ -2222,6 +2222,351 @@
}
}
},
"/api/v5/settings/mediamanagement": {
"get": {
"tags": [
"MediaManagementSettings"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
}
}
}
}
}
},
"/api/v5/settings/mediamanagement/{id}": {
"put": {
"tags": [
"MediaManagementSettings"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
}
}
}
}
},
"get": {
"tags": [
"MediaManagementSettings"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaManagementSettingsResource"
}
}
}
}
}
}
},
"/api/v5/metadata": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v5/metadata/{id}": {
"put": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "forceSave",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"get": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
},
"/api/v5/metadata/schema": {
"get": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
}
}
}
}
},
"/api/v5/metadata/test": {
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "forceTest",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/metadata/testall": {
"post": {
"tags": [
"Metadata"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/metadata/action/{name}": {
"post": {
"tags": [
"Metadata"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResource"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/wanted/missing": {
"get": {
"tags": [
@@ -6157,6 +6502,14 @@
],
"type": "string"
},
"EpisodeTitleRequiredType": {
"enum": [
"always",
"bulkSeasonReleases",
"never"
],
"type": "string"
},
"EpisodesMonitoredResource": {
"required": [
"episodeIds"
@@ -6250,6 +6603,14 @@
},
"additionalProperties": false
},
"FileDateType": {
"enum": [
"none",
"localAirDate",
"utcAirDate"
],
"type": "string"
},
"HealthCheckReason": {
"enum": [
"appDataLocation",
@@ -7000,6 +7361,153 @@
},
"additionalProperties": false
},
"MediaManagementSettingsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"autoUnmonitorPreviouslyDownloadedEpisodes": {
"type": "boolean"
},
"recycleBin": {
"type": "string",
"nullable": true
},
"recycleBinCleanupDays": {
"type": "integer",
"format": "int32"
},
"downloadPropersAndRepacks": {
"$ref": "#/components/schemas/ProperDownloadTypes"
},
"createEmptySeriesFolders": {
"type": "boolean"
},
"deleteEmptyFolders": {
"type": "boolean"
},
"fileDate": {
"$ref": "#/components/schemas/FileDateType"
},
"rescanAfterRefresh": {
"$ref": "#/components/schemas/RescanAfterRefreshType"
},
"setPermissionsLinux": {
"type": "boolean"
},
"chmodFolder": {
"type": "string",
"nullable": true
},
"chownGroup": {
"type": "string",
"nullable": true
},
"episodeTitleRequired": {
"$ref": "#/components/schemas/EpisodeTitleRequiredType"
},
"skipFreeSpaceCheckWhenImporting": {
"type": "boolean"
},
"minimumFreeSpaceWhenImporting": {
"type": "integer",
"format": "int32"
},
"copyUsingHardlinks": {
"type": "boolean"
},
"useScriptImport": {
"type": "boolean"
},
"scriptImportPath": {
"type": "string",
"nullable": true
},
"importExtraFiles": {
"type": "boolean"
},
"extraFileExtensions": {
"type": "string",
"nullable": true
},
"enableMediaInfo": {
"type": "boolean"
},
"userRejectedExtensions": {
"type": "string",
"nullable": true
},
"seasonPackUpgrade": {
"$ref": "#/components/schemas/SeasonPackUpgradeType"
},
"seasonPackUpgradeThreshold": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"MetadataResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"configContract": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"message": {
"$ref": "#/components/schemas/ProviderMessage"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataResource"
},
"nullable": true
},
"enable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"MissingSubresource": {
"enum": [
"series",
@@ -7394,6 +7902,14 @@
},
"additionalProperties": false
},
"ProperDownloadTypes": {
"enum": [
"preferAndUpgrade",
"doNotUpgrade",
"doNotPrefer"
],
"type": "string"
},
"ProviderMessage": {
"type": "object",
"properties": {
@@ -8337,6 +8853,14 @@
},
"additionalProperties": false
},
"RescanAfterRefreshType": {
"enum": [
"always",
"afterManual",
"never"
],
"type": "string"
},
"Revision": {
"type": "object",
"properties": {
@@ -8420,6 +8944,14 @@
},
"additionalProperties": false
},
"SeasonPackUpgradeType": {
"enum": [
"all",
"threshold",
"any"
],
"type": "string"
},
"SeasonPassResource": {
"type": "object",
"properties": {
@@ -9493,6 +10025,12 @@
{
"name": "ManualImport"
},
{
"name": "MediaManagementSettings"
},
{
"name": "Metadata"
},
{
"name": "Missing"
},