From 42a15ab60e36760b925968920d8e3dfe06e99ba5 Mon Sep 17 00:00:00 2001 From: Servarr Date: Mon, 30 Oct 2023 20:29:18 +0000 Subject: [PATCH] Automated API Docs update --- src/Lidarr.Api.V1/openapi.json | 382 +++++++++++++++++++++++---------- 1 file changed, 265 insertions(+), 117 deletions(-) diff --git a/src/Lidarr.Api.V1/openapi.json b/src/Lidarr.Api.V1/openapi.json index 62d199156..e47cff8d0 100644 --- a/src/Lidarr.Api.V1/openapi.json +++ b/src/Lidarr.Api.V1/openapi.json @@ -701,25 +701,25 @@ "schema": { "type": "object", "properties": { - "Username": { + "username": { "type": "string" }, - "Password": { + "password": { "type": "string" }, - "RememberMe": { + "rememberMe": { "type": "string" } } }, "encoding": { - "Username": { + "username": { "style": "form" }, - "Password": { + "password": { "style": "form" }, - "RememberMe": { + "rememberMe": { "style": "form" } } @@ -1033,6 +1033,40 @@ "tags": [ "Blocklist" ], + "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + } + ], "responses": { "200": { "description": "Success", @@ -1718,6 +1752,38 @@ "Cutoff" ], "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + }, { "name": "includeArtist", "in": "query", @@ -1725,6 +1791,14 @@ "type": "boolean", "default": false } + }, + { + "name": "monitored", + "in": "query", + "schema": { + "type": "boolean", + "default": true + } } ], "responses": { @@ -2543,28 +2617,80 @@ "History" ], "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + }, { "name": "includeArtist", "in": "query", "schema": { - "type": "boolean", - "default": false + "type": "boolean" } }, { "name": "includeAlbum", "in": "query", "schema": { - "type": "boolean", - "default": false + "type": "boolean" } }, { "name": "includeTrack", "in": "query", "schema": { - "type": "boolean", - "default": false + "type": "boolean" + } + }, + { + "name": "eventType", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "albumId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "downloadId", + "in": "query", + "schema": { + "type": "string" } } ], @@ -2572,20 +2698,10 @@ "200": { "description": "Success", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/HistoryResourcePagingResource" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/HistoryResourcePagingResource" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/HistoryResourcePagingResource" - } } } } @@ -2642,14 +2758,6 @@ "200": { "description": "Success", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HistoryResource" - } - } - }, "application/json": { "schema": { "type": "array", @@ -2657,14 +2765,6 @@ "$ref": "#/components/schemas/HistoryResource" } } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HistoryResource" - } - } } } } @@ -2729,14 +2829,6 @@ "200": { "description": "Success", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HistoryResource" - } - } - }, "application/json": { "schema": { "type": "array", @@ -2744,14 +2836,6 @@ "$ref": "#/components/schemas/HistoryResource" } } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HistoryResource" - } - } } } } @@ -3906,6 +3990,47 @@ "tags": [ "Log" ], + "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + }, + { + "name": "level", + "in": "query", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Success", @@ -4840,6 +4965,38 @@ "Missing" ], "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + }, { "name": "includeArtist", "in": "query", @@ -4847,6 +5004,14 @@ "type": "boolean", "default": false } + }, + { + "name": "monitored", + "in": "query", + "schema": { + "type": "boolean", + "default": true + } } ], "responses": { @@ -5035,21 +5200,21 @@ ], "parameters": [ { - "name": "RenameTracks", + "name": "renameTracks", "in": "query", "schema": { "type": "boolean" } }, { - "name": "ReplaceIllegalCharacters", + "name": "replaceIllegalCharacters", "in": "query", "schema": { "type": "boolean" } }, { - "name": "ColonReplacementFormat", + "name": "colonReplacementFormat", "in": "query", "schema": { "type": "integer", @@ -5057,70 +5222,70 @@ } }, { - "name": "StandardTrackFormat", + "name": "standardTrackFormat", "in": "query", "schema": { "type": "string" } }, { - "name": "MultiDiscTrackFormat", + "name": "multiDiscTrackFormat", "in": "query", "schema": { "type": "string" } }, { - "name": "ArtistFolderFormat", + "name": "artistFolderFormat", "in": "query", "schema": { "type": "string" } }, { - "name": "IncludeArtistName", + "name": "includeArtistName", "in": "query", "schema": { "type": "boolean" } }, { - "name": "IncludeAlbumTitle", + "name": "includeAlbumTitle", "in": "query", "schema": { "type": "boolean" } }, { - "name": "IncludeQuality", + "name": "includeQuality", "in": "query", "schema": { "type": "boolean" } }, { - "name": "ReplaceSpaces", + "name": "replaceSpaces", "in": "query", "schema": { "type": "boolean" } }, { - "name": "Separator", + "name": "separator", "in": "query", "schema": { "type": "string" } }, { - "name": "NumberStyle", + "name": "numberStyle", "in": "query", "schema": { "type": "string" } }, { - "name": "Id", + "name": "id", "in": "query", "schema": { "type": "integer", @@ -5128,7 +5293,7 @@ } }, { - "name": "ResourceName", + "name": "resourceName", "in": "query", "schema": { "type": "string" @@ -5952,6 +6117,38 @@ "Queue" ], "parameters": [ + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "sortKey", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sortDirection", + "in": "query", + "schema": { + "$ref": "#/components/schemas/SortDirection" + } + }, { "name": "includeUnknownArtistItems", "in": "query", @@ -8436,13 +8633,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -9215,13 +9405,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -9981,13 +10164,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -10674,13 +10850,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -11456,20 +11625,6 @@ }, "additionalProperties": false }, - "PagingResourceFilter": { - "type": "object", - "properties": { - "key": { - "type": "string", - "nullable": true - }, - "value": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, "ParseResource": { "type": "object", "properties": { @@ -12183,13 +12338,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32"