open-source-mirrors
/
Readarr
mirror of https://github.com/Readarr/Readarr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Automated API Docs update

Browse Source
pull/3186/head
Servarr 5 months ago committed by Bogdan
parent 9e3dfc510d
commit a093290792
1 changed files with 266 additions and 112 deletions
Show Stats Download Patch File Download Diff File

378
src/Readarr.Api.V1/openapi.json
Unescape View File

@ -66,25 +66,25 @@
"schema": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"Username": { "username": {
"type": "string" "type": "string"
}, },
"Password": { "password": {
"type": "string" "type": "string"
}, },
"RememberMe": { "rememberMe": {
"type": "string" "type": "string"
} }
} }
}, },
"encoding": { "encoding": {
"Username": { "username": {
"style": "form" "style": "form"
}, },
"Password": { "password": {
"style": "form" "style": "form"
}, },
"RememberMe": { "rememberMe": {
"style": "form" "style": "form"
} }
} }
@ -517,24 +517,48 @@
"tags": [ "tags": [
"Blocklist" "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": { "responses": {
"200": { "200": {
"description": "Success", "description": "Success",
"content": { "content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource"
}
},
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource" "$ref": "#/components/schemas/BlocklistResourcePagingResource"
} }
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlocklistResourcePagingResource"
}
} }
} }
} }
@ -1899,6 +1923,38 @@
"Cutoff" "Cutoff"
], ],
"parameters": [ "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": "includeAuthor", "name": "includeAuthor",
"in": "query", "in": "query",
@ -1906,6 +1962,14 @@
"type": "boolean", "type": "boolean",
"default": false "default": false
} }
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
} }
], ],
"responses": { "responses": {
@ -2912,20 +2976,76 @@
"History" "History"
], ],
"parameters": [ "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": "includeAuthor", "name": "includeAuthor",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean", "type": "boolean"
"default": false
} }
}, },
{ {
"name": "includeBook", "name": "includeBook",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean", "type": "boolean"
"default": false }
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "bookId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
} }
} }
], ],
@ -2933,20 +3053,10 @@
"200": { "200": {
"description": "Success", "description": "Success",
"content": { "content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource"
}
},
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource" "$ref": "#/components/schemas/HistoryResourcePagingResource"
} }
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/HistoryResourcePagingResource"
}
} }
} }
} }
@ -4221,24 +4331,55 @@
"tags": [ "tags": [
"Log" "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": { "responses": {
"200": { "200": {
"description": "Success", "description": "Success",
"content": { "content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LogResourcePagingResource"
}
},
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/LogResourcePagingResource" "$ref": "#/components/schemas/LogResourcePagingResource"
} }
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LogResourcePagingResource"
}
} }
} }
} }
@ -5181,6 +5322,38 @@
"Missing" "Missing"
], ],
"parameters": [ "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": "includeAuthor", "name": "includeAuthor",
"in": "query", "in": "query",
@ -5188,6 +5361,14 @@
"type": "boolean", "type": "boolean",
"default": false "default": false
} }
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
} }
], ],
"responses": { "responses": {
@ -5366,21 +5547,21 @@
], ],
"parameters": [ "parameters": [
{ {
"name": "RenameBooks", "name": "renameBooks",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "ReplaceIllegalCharacters", "name": "replaceIllegalCharacters",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "ColonReplacementFormat", "name": "colonReplacementFormat",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "integer", "type": "integer",
@ -5388,63 +5569,63 @@
} }
}, },
{ {
"name": "StandardBookFormat", "name": "standardBookFormat",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string" "type": "string"
} }
}, },
{ {
"name": "AuthorFolderFormat", "name": "authorFolderFormat",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string" "type": "string"
} }
}, },
{ {
"name": "IncludeAuthorName", "name": "includeAuthorName",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "IncludeBookTitle", "name": "includeBookTitle",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "IncludeQuality", "name": "includeQuality",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "ReplaceSpaces", "name": "replaceSpaces",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "boolean" "type": "boolean"
} }
}, },
{ {
"name": "Separator", "name": "separator",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string" "type": "string"
} }
}, },
{ {
"name": "NumberStyle", "name": "numberStyle",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string" "type": "string"
} }
}, },
{ {
"name": "Id", "name": "id",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "integer", "type": "integer",
@ -5452,7 +5633,7 @@
} }
}, },
{ {
"name": "ResourceName", "name": "resourceName",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string" "type": "string"
@ -6256,6 +6437,38 @@
"Queue" "Queue"
], ],
"parameters": [ "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": "includeUnknownAuthorItems", "name": "includeUnknownAuthorItems",
"in": "query", "in": "query",
@ -6285,20 +6498,10 @@
"200": { "200": {
"description": "Success", "description": "Success",
"content": { "content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/QueueResourcePagingResource"
}
},
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/QueueResourcePagingResource" "$ref": "#/components/schemas/QueueResourcePagingResource"
} }
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QueueResourcePagingResource"
}
} }
} }
} }
@ -8688,13 +8891,6 @@
"sortDirection": { "sortDirection": {
"$ref": "#/components/schemas/SortDirection" "$ref": "#/components/schemas/SortDirection"
}, },
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": { "totalRecords": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -9148,13 +9344,6 @@
"sortDirection": { "sortDirection": {
"$ref": "#/components/schemas/SortDirection" "$ref": "#/components/schemas/SortDirection"
}, },
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": { "totalRecords": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -10240,13 +10429,6 @@
"sortDirection": { "sortDirection": {
"$ref": "#/components/schemas/SortDirection" "$ref": "#/components/schemas/SortDirection"
}, },
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": { "totalRecords": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -10915,13 +11097,6 @@
"sortDirection": { "sortDirection": {
"$ref": "#/components/schemas/SortDirection" "$ref": "#/components/schemas/SortDirection"
}, },
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": { "totalRecords": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -11646,20 +11821,6 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"PagingResourceFilter": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParseResource": { "ParseResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -12299,13 +12460,6 @@
"sortDirection": { "sortDirection": {
"$ref": "#/components/schemas/SortDirection" "$ref": "#/components/schemas/SortDirection"
}, },
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": { "totalRecords": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"

Write Preview
Loading…
Cancel
Save