From 27cc5519800115401d50d5670f64ccf74778ee2d Mon Sep 17 00:00:00 2001 From: Mark McDowall Date: Sun, 12 Feb 2023 15:09:00 -0800 Subject: [PATCH] Updated API documents --- src/Sonarr.Api.V3/openapi.json | 318 ++++++++++++++++++++++++++++++++- 1 file changed, 317 insertions(+), 1 deletion(-) diff --git a/src/Sonarr.Api.V3/openapi.json b/src/Sonarr.Api.V3/openapi.json index 146fb49d3..0a6d4ebcc 100644 --- a/src/Sonarr.Api.V3/openapi.json +++ b/src/Sonarr.Api.V3/openapi.json @@ -113,6 +113,173 @@ } } }, + "/api/v3/autotagging": { + "post": { + "tags": [ + "AutoTagging" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + } + } + }, + "get": { + "tags": [ + "AutoTagging" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + } + } + } + } + }, + "/api/v3/autotagging/{id}": { + "put": { + "tags": [ + "AutoTagging" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + } + } + }, + "delete": { + "tags": [ + "AutoTagging" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "AutoTagging" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTaggingResource" + } + } + } + } + } + } + }, + "/api/v3/autotagging/schema": { + "get": { + "tags": [ + "AutoTagging" + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, "/api/v3/system/backup": { "get": { "tags": [ @@ -3325,6 +3492,25 @@ } } }, + "/api/v3/localization/language": { + "get": { + "tags": [ + "Localization" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationLanguageResource" + } + } + } + } + } + } + }, "/api/v3/localization/{id}": { "get": { "tags": [ @@ -6816,6 +7002,74 @@ ], "type": "string" }, + "AutoTaggingResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "removeTagsAutomatically": { + "type": "boolean" + }, + "tags": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "specifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AutoTaggingSpecificationSchema" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "AutoTaggingSpecificationSchema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "implementation": { + "type": "string", + "nullable": true + }, + "implementationName": { + "type": "string", + "nullable": true + }, + "negate": { + "type": "boolean" + }, + "required": { + "type": "boolean" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + }, + "nullable": true + } + }, + "additionalProperties": false + }, "BackupResource": { "type": "object", "properties": { @@ -7012,6 +7266,11 @@ "format": "date-time", "nullable": true }, + "lastStartTime": { + "type": "string", + "format": "date-time", + "nullable": true + }, "trigger": { "$ref": "#/components/schemas/CommandTrigger" }, @@ -7166,7 +7425,8 @@ "nullable": true }, "includeCustomFormatWhenRenaming": { - "type": "boolean" + "type": "boolean", + "nullable": true }, "specifications": { "type": "array", @@ -7251,6 +7511,13 @@ "bypassIfHighestQuality": { "type": "boolean" }, + "bypassIfAboveCustomFormatScore": { + "type": "boolean" + }, + "minimumCustomFormatScore": { + "type": "integer", + "format": "int32" + }, "order": { "type": "integer", "format": "int32" @@ -7812,6 +8079,10 @@ }, "nullable": true }, + "customFormatScore": { + "type": "integer", + "format": "int32" + }, "qualityCutoffNotMet": { "type": "boolean" }, @@ -8156,6 +8427,9 @@ "listOrder": { "type": "integer", "format": "int32" + }, + "minRefreshInterval": { + "$ref": "#/components/schemas/TimeSpan" } }, "additionalProperties": false @@ -8165,6 +8439,7 @@ "program", "plex", "trakt", + "simkl", "other", "advanced" ], @@ -8358,6 +8633,16 @@ }, "additionalProperties": false }, + "LocalizationLanguageResource": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "LocalizationResource": { "type": "object", "properties": { @@ -8611,6 +8896,13 @@ "type": "string", "nullable": true }, + "customFormats": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFormatResource" + }, + "nullable": true + }, "rejections": { "type": "array", "items": { @@ -9340,6 +9632,11 @@ "type": "number", "format": "double", "nullable": true + }, + "preferredSize": { + "type": "number", + "format": "double", + "nullable": true } }, "additionalProperties": false @@ -10673,6 +10970,14 @@ }, "nullable": true }, + "autoTagIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, "seriesIds": { "type": "array", "items": { @@ -10721,9 +11026,16 @@ "type": "string", "format": "date-time" }, + "lastStartTime": { + "type": "string", + "format": "date-time" + }, "nextExecution": { "type": "string", "format": "date-time" + }, + "lastDuration": { + "$ref": "#/components/schemas/TimeSpan" } }, "additionalProperties": false @@ -10879,6 +11191,10 @@ "path": { "type": "string", "nullable": true + }, + "relativePath": { + "type": "string", + "nullable": true } }, "additionalProperties": false