From e3ebdacd0930999bbe85facf76e188ad823392bc Mon Sep 17 00:00:00 2001 From: Sonarr Date: Mon, 15 May 2023 04:11:40 +0000 Subject: [PATCH] Automated API Docs update --- src/Sonarr.Api.V3/openapi.json | 159 ++++++++++++++++++++++++++++++++- 1 file changed, 157 insertions(+), 2 deletions(-) diff --git a/src/Sonarr.Api.V3/openapi.json b/src/Sonarr.Api.V3/openapi.json index 6b4c5c624..e5bff37e6 100644 --- a/src/Sonarr.Api.V3/openapi.json +++ b/src/Sonarr.Api.V3/openapi.json @@ -502,6 +502,14 @@ "type": "boolean", "default": false } + }, + { + "name": "tags", + "in": "query", + "schema": { + "type": "string", + "default": "" + } } ], "responses": { @@ -576,7 +584,7 @@ } }, { - "name": "tagList", + "name": "tags", "in": "query", "schema": { "type": "string", @@ -1830,6 +1838,16 @@ "tags": [ "Episode" ], + "parameters": [ + { + "name": "includeImages", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + } + ], "requestBody": { "content": { "application/json": { @@ -4259,6 +4277,14 @@ "type": "boolean" } }, + { + "name": "ColonReplacementFormat", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, { "name": "MultiEpisodeStyle", "in": "query", @@ -6142,6 +6168,14 @@ "Series" ], "parameters": [ + { + "name": "moveFiles", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + }, { "name": "id", "in": "path", @@ -6196,6 +6230,22 @@ "type": "integer", "format": "int32" } + }, + { + "name": "deleteFiles", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "addImportListExclusion", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } } ], "responses": { @@ -7320,6 +7370,9 @@ "status": { "$ref": "#/components/schemas/CommandStatus" }, + "result": { + "$ref": "#/components/schemas/CommandResult" + }, "queued": { "type": "string", "format": "date-time" @@ -7367,6 +7420,14 @@ }, "additionalProperties": false }, + "CommandResult": { + "enum": [ + "unknown", + "successful", + "unsuccessful" + ], + "type": "string" + }, "CommandStatus": { "enum": [ "queued", @@ -7810,6 +7871,10 @@ "format": "date-time", "nullable": true }, + "runtime": { + "type": "integer", + "format": "int32" + }, "overview": { "type": "string", "nullable": true @@ -7998,6 +8063,10 @@ }, "privacy": { "$ref": "#/components/schemas/PrivacyLevel" + }, + "placeholder": { + "type": "string", + "nullable": true } }, "additionalProperties": false @@ -9151,7 +9220,7 @@ "latestSeason", "pilot", "monitorSpecials", - "UnmonitorSpecials", + "unmonitorSpecials", "none" ], "type": "string" @@ -9184,6 +9253,10 @@ "replaceIllegalCharacters": { "type": "boolean" }, + "colonReplacementFormat": { + "type": "integer", + "format": "int32" + }, "multiEpisodeStyle": { "type": "integer", "format": "int32" @@ -9304,6 +9377,9 @@ "onRename": { "type": "boolean" }, + "onSeriesAdd": { + "type": "boolean" + }, "onSeriesDelete": { "type": "boolean" }, @@ -9316,9 +9392,15 @@ "onHealthIssue": { "type": "boolean" }, + "onHealthRestored": { + "type": "boolean" + }, "onApplicationUpdate": { "type": "boolean" }, + "onManualInteractionRequired": { + "type": "boolean" + }, "supportsOnGrab": { "type": "boolean" }, @@ -9331,6 +9413,9 @@ "supportsOnRename": { "type": "boolean" }, + "supportsOnSeriesAdd": { + "type": "boolean" + }, "supportsOnSeriesDelete": { "type": "boolean" }, @@ -9343,9 +9428,15 @@ "supportsOnHealthIssue": { "type": "boolean" }, + "supportsOnHealthRestored": { + "type": "boolean" + }, "supportsOnApplicationUpdate": { "type": "boolean" }, + "supportsOnManualInteractionRequired": { + "type": "boolean" + }, "includeHealthWarnings": { "type": "boolean" }, @@ -9769,6 +9860,11 @@ "format": "int32", "nullable": true }, + "seasonNumber": { + "type": "integer", + "format": "int32", + "nullable": true + }, "series": { "$ref": "#/components/schemas/SeriesResource" }, @@ -9851,6 +9947,9 @@ "outputPath": { "type": "string", "nullable": true + }, + "episodeHasFile": { + "type": "boolean" } }, "additionalProperties": false @@ -9962,6 +10061,33 @@ ], "type": "string" }, + "ReleaseEpisodeResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "seasonNumber": { + "type": "integer", + "format": "int32" + }, + "episodeNumber": { + "type": "integer", + "format": "int32" + }, + "absoluteEpisodeNumber": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "ReleaseProfileResource": { "type": "object", "properties": { @@ -10122,6 +10248,18 @@ }, "nullable": true }, + "mappedSeriesId": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "mappedEpisodeInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReleaseEpisodeResource" + }, + "nullable": true + }, "approved": { "type": "boolean" }, @@ -10228,6 +10366,23 @@ "type": "integer", "format": "int32", "nullable": true + }, + "episodeIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "downloadClientId": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "shouldOverride": { + "type": "boolean", + "nullable": true } }, "additionalProperties": false