From bdae7a2cdcd6e01161a9535423ec3996cf71d18e Mon Sep 17 00:00:00 2001 From: Servarr Date: Tue, 10 Oct 2023 23:40:26 +0000 Subject: [PATCH] Automated API Docs update --- src/Prowlarr.Api.V1/openapi.json | 149 ++++++++++++++++++++++--------- 1 file changed, 109 insertions(+), 40 deletions(-) diff --git a/src/Prowlarr.Api.V1/openapi.json b/src/Prowlarr.Api.V1/openapi.json index c5174e5e3..93e781bcd 100644 --- a/src/Prowlarr.Api.V1/openapi.json +++ b/src/Prowlarr.Api.V1/openapi.json @@ -503,25 +503,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" } } @@ -1412,6 +1412,62 @@ "tags": [ "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": "eventType", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "successful", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "downloadId", + "in": "query", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Success", @@ -2263,6 +2319,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", @@ -3235,21 +3332,21 @@ ], "parameters": [ { - "name": "Query", + "name": "query", "in": "query", "schema": { "type": "string" } }, { - "name": "Type", + "name": "type", "in": "query", "schema": { "type": "string" } }, { - "name": "IndexerIds", + "name": "indexerIds", "in": "query", "schema": { "type": "array", @@ -3260,7 +3357,7 @@ } }, { - "name": "Categories", + "name": "categories", "in": "query", "schema": { "type": "array", @@ -3271,7 +3368,7 @@ } }, { - "name": "Limit", + "name": "limit", "in": "query", "schema": { "type": "integer", @@ -3279,7 +3376,7 @@ } }, { - "name": "Offset", + "name": "offset", "in": "query", "schema": { "type": "integer", @@ -4626,13 +4723,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -5423,13 +5513,6 @@ "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PagingResourceFilter" - }, - "nullable": true - }, "totalRecords": { "type": "integer", "format": "int32" @@ -5564,20 +5647,6 @@ }, "additionalProperties": false }, - "PagingResourceFilter": { - "type": "object", - "properties": { - "key": { - "type": "string", - "nullable": true - }, - "value": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, "PingResource": { "type": "object", "properties": {