From a946546793e140e15a68dacdc40526ce9a27958f Mon Sep 17 00:00:00 2001 From: Servarr Date: Tue, 15 Aug 2023 12:19:50 +0000 Subject: [PATCH] Automated API Docs update --- src/Radarr.Api.V3/openapi.json | 448 +++++++++++++++++---------------- 1 file changed, 238 insertions(+), 210 deletions(-) diff --git a/src/Radarr.Api.V3/openapi.json b/src/Radarr.Api.V3/openapi.json index 5cc413b27..40b1f575a 100644 --- a/src/Radarr.Api.V3/openapi.json +++ b/src/Radarr.Api.V3/openapi.json @@ -7017,123 +7017,26 @@ } } }, - "/api/v3/release/push": { - "post": { - "tags": [ - "ReleasePush" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReleaseResource" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReleaseResource" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReleaseResource" - } - } - } - } - } - } - } - }, - "/api/v3/release/push/{id}": { - "get": { - "tags": [ - "ReleasePush" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ReleaseResource" - } - } - } - } - } - } - }, - "/api/v3/remotepathmapping": { + "/api/v3/releaseprofile": { "post": { "tags": [ - "RemotePathMapping" + "ReleaseProfile" ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7144,17 +7047,17 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7163,7 +7066,7 @@ }, "get": { "tags": [ - "RemotePathMapping" + "ReleaseProfile" ], "responses": { "200": { @@ -7173,7 +7076,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } }, @@ -7181,7 +7084,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } }, @@ -7189,7 +7092,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7198,10 +7101,10 @@ } } }, - "/api/v3/remotepathmapping/{id}": { + "/api/v3/releaseprofile/{id}": { "delete": { "tags": [ - "RemotePathMapping" + "ReleaseProfile" ], "parameters": [ { @@ -7222,7 +7125,7 @@ }, "put": { "tags": [ - "RemotePathMapping" + "ReleaseProfile" ], "parameters": [ { @@ -7238,17 +7141,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7259,17 +7162,17 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7278,7 +7181,7 @@ }, "get": { "tags": [ - "RemotePathMapping" + "ReleaseProfile" ], "parameters": [ { @@ -7297,17 +7200,17 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RemotePathMappingResource" + "$ref": "#/components/schemas/ReleaseProfileResource" } } } @@ -7315,21 +7218,30 @@ } } }, - "/api/v3/rename": { - "get": { + "/api/v3/release/push": { + "post": { "tags": [ - "RenameMovie" + "ReleasePush" ], - "parameters": [ - { - "name": "movieId", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseResource" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ReleaseResource" + } } } - ], + }, "responses": { "200": { "description": "Success", @@ -7338,7 +7250,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RenameMovieResource" + "$ref": "#/components/schemas/ReleaseResource" } } }, @@ -7346,7 +7258,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RenameMovieResource" + "$ref": "#/components/schemas/ReleaseResource" } } }, @@ -7354,7 +7266,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/RenameMovieResource" + "$ref": "#/components/schemas/ReleaseResource" } } } @@ -7363,10 +7275,21 @@ } } }, - "/api/v3/restriction": { + "/api/v3/release/push/{id}": { "get": { "tags": [ - "Restriction" + "ReleasePush" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } ], "responses": { "200": { @@ -7374,51 +7297,44 @@ "content": { "text/plain": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RestrictionResource" - } + "$ref": "#/components/schemas/ReleaseResource" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RestrictionResource" - } + "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RestrictionResource" - } + "$ref": "#/components/schemas/ReleaseResource" } } } } } - }, + } + }, + "/api/v3/remotepathmapping": { "post": { "tags": [ - "Restriction" + "RemotePathMapping" ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } } } @@ -7429,17 +7345,53 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } + } + } + } + } + }, + "get": { + "tags": [ + "RemotePathMapping" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "type": "array", + "items": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "type": "array", + "items": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } } } } @@ -7447,10 +7399,31 @@ } } }, - "/api/v3/restriction/{id}": { + "/api/v3/remotepathmapping/{id}": { + "delete": { + "tags": [ + "RemotePathMapping" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, "put": { "tags": [ - "Restriction" + "RemotePathMapping" ], "parameters": [ { @@ -7466,17 +7439,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } } } @@ -7487,26 +7460,26 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "$ref": "#/components/schemas/RemotePathMappingResource" } } } } } }, - "delete": { + "get": { "tags": [ - "Restriction" + "RemotePathMapping" ], "parameters": [ { @@ -7521,19 +7494,37 @@ ], "responses": { "200": { - "description": "Success" + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RemotePathMappingResource" + } + } + } } } - }, + } + }, + "/api/v3/rename": { "get": { "tags": [ - "Restriction" + "RenameMovie" ], "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "movieId", + "in": "query", "schema": { "type": "integer", "format": "int32" @@ -7546,17 +7537,26 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "type": "array", + "items": { + "$ref": "#/components/schemas/RenameMovieResource" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "type": "array", + "items": { + "$ref": "#/components/schemas/RenameMovieResource" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/RestrictionResource" + "type": "array", + "items": { + "$ref": "#/components/schemas/RenameMovieResource" + } } } } @@ -8552,11 +8552,19 @@ ], "type": "string" }, + "AuthenticationRequiredType": { + "enum": [ + "enabled", + "disabledForLocalAddresses" + ], + "type": "string" + }, "AuthenticationType": { "enum": [ "none", "basic", - "forms" + "forms", + "external" ], "type": "string" }, @@ -9607,6 +9615,9 @@ "type": "string", "nullable": true }, + "privacy": { + "$ref": "#/components/schemas/PrivacyLevel" + }, "placeholder": { "type": "string", "nullable": true @@ -9786,6 +9797,9 @@ "authenticationMethod": { "$ref": "#/components/schemas/AuthenticationType" }, + "authenticationRequired": { + "$ref": "#/components/schemas/AuthenticationRequiredType" + }, "analyticsEnabled": { "type": "boolean" }, @@ -11836,6 +11850,15 @@ }, "additionalProperties": false }, + "PrivacyLevel": { + "enum": [ + "normal", + "password", + "apiKey", + "userName" + ], + "type": "string" + }, "ProfileFormatItemResource": { "type": "object", "properties": { @@ -12288,6 +12311,42 @@ ], "type": "string" }, + "ReleaseProfileResource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "enabled": { + "type": "boolean" + }, + "required": { + "nullable": true + }, + "ignored": { + "nullable": true + }, + "indexerId": { + "type": "integer", + "format": "int32" + }, + "tags": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, "ReleaseResource": { "type": "object", "properties": { @@ -12517,37 +12576,6 @@ ], "type": "string" }, - "RestrictionResource": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "required": { - "type": "string", - "nullable": true - }, - "preferred": { - "type": "string", - "nullable": true - }, - "ignored": { - "type": "string", - "nullable": true - }, - "tags": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "Revision": { "type": "object", "properties": { @@ -12825,7 +12853,7 @@ }, "nullable": true }, - "restrictionIds": { + "releaseProfileIds": { "type": "array", "items": { "type": "integer",