1
0
mirror of https://github.com/Sonarr/Sonarr.git synced 2026-04-21 22:05:38 -04:00

Automated API Docs update

ignore-downstream
This commit is contained in:
Sonarr
2026-01-01 17:36:47 +00:00
committed by Mark McDowall
parent b2f2c21a61
commit e0abca8360
+734
View File
@@ -2144,6 +2144,352 @@
}
}
},
"/api/v5/qualitydefinition/{id}": {
"put": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityDefinition"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
},
"/api/v5/qualitydefinition": {
"get": {
"tags": [
"QualityDefinition"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
}
}
},
"put": {
"tags": [
"QualityDefinition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityDefinitionResource"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/qualityprofile": {
"post": {
"tags": [
"QualityProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
}
},
"/api/v5/qualityprofile/{id}": {
"delete": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"QualityProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v5/qualityprofile/schema": {
"get": {
"tags": [
"QualityProfileSchema"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QualityProfileResource"
}
}
}
}
}
}
},
"/api/v5/queue/{id}": {
"delete": {
"tags": [
@@ -2582,6 +2928,197 @@
}
}
},
"/api/v5/releaseprofile": {
"post": {
"tags": [
"ReleaseProfile"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"ReleaseProfile"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
}
},
"/api/v5/releaseprofile/{id}": {
"delete": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"put": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
},
"get": {
"tags": [
"ReleaseProfile"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseProfileResource"
}
}
}
}
}
}
},
"/api/v5/release/push": {
"post": {
"tags": [
@@ -6111,6 +6648,28 @@
],
"type": "string"
},
"ProfileFormatItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"format": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Quality": {
"type": "object",
"properties": {
@@ -6132,6 +6691,27 @@
},
"additionalProperties": false
},
"QualityDefinitionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"title": {
"type": "string",
"nullable": true
},
"weight": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"QualityModel": {
"type": "object",
"properties": {
@@ -6144,6 +6724,95 @@
},
"additionalProperties": false
},
"QualityProfileQualityItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"quality": {
"$ref": "#/components/schemas/Quality"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"allowed": {
"type": "boolean"
},
"minSize": {
"type": "number",
"format": "double",
"nullable": true
},
"maxSize": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredSize": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"QualityProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"upgradeAllowed": {
"type": "boolean"
},
"cutoff": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QualityProfileQualityItemResource"
},
"nullable": true
},
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"minUpgradeFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItemResource"
},
"nullable": true
}
},
"additionalProperties": false
},
"QualitySource": {
"enum": [
"unknown",
@@ -6608,6 +7277,59 @@
},
"additionalProperties": false
},
"ReleaseProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"indexerId": {
"type": "integer",
"format": "int32"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"excludedTags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReleasePushResource": {
"type": "object",
"properties": {
@@ -8028,6 +8750,15 @@
{
"name": "Ping"
},
{
"name": "QualityDefinition"
},
{
"name": "QualityProfile"
},
{
"name": "QualityProfileSchema"
},
{
"name": "Queue"
},
@@ -8043,6 +8774,9 @@
{
"name": "Release"
},
{
"name": "ReleaseProfile"
},
{
"name": "ReleasePush"
},