tedkulp/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2026-04-21 22:05:38 -04:00
Code Issues Projects Releases Wiki Activity

Paging params in API docs

Browse Source 
Closes #6003
This commit is contained in:
Mark McDowall
2023-10-09 20:37:31 -07:00
committed by GitHub
parent 9f3915d4ad
commit bfaa7291e1
14 changed files with 320 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Sonarr.Api.V3/openapi.json
+269 -76
View File
@@ -59,25 +59,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"
}
}
@@ -381,6 +381,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",
@@ -1050,6 +1084,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": "includeSeries",
"in": "query",
@@ -1073,6 +1139,14 @@
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
@@ -2220,6 +2294,38 @@
"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": "includeSeries",
"in": "query",
@@ -2233,6 +2339,29 @@
"schema": {
"type": "boolean"
}
},
{
"name": "eventType",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "episodeId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "downloadId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -3627,6 +3756,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",
@@ -4142,6 +4312,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": "includeSeries",
"in": "query",
@@ -4157,6 +4359,14 @@
"type": "boolean",
"default": false
}
},
{
"name": "monitored",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
@@ -4325,21 +4535,21 @@
],
"parameters": [
{
"name": "RenameEpisodes",
"name": "renameEpisodes",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "ReplaceIllegalCharacters",
"name": "replaceIllegalCharacters",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "ColonReplacementFormat",
"name": "colonReplacementFormat",
"in": "query",
"schema": {
"type": "integer",
@@ -4347,7 +4557,7 @@
}
},
{
"name": "MultiEpisodeStyle",
"name": "multiEpisodeStyle",
"in": "query",
"schema": {
"type": "integer",
@@ -4355,91 +4565,91 @@
}
},
{
"name": "StandardEpisodeFormat",
"name": "standardEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "DailyEpisodeFormat",
"name": "dailyEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "AnimeEpisodeFormat",
"name": "animeEpisodeFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "SeriesFolderFormat",
"name": "seriesFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "SeasonFolderFormat",
"name": "seasonFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "SpecialsFolderFormat",
"name": "specialsFolderFormat",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "IncludeSeriesTitle",
"name": "includeSeriesTitle",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeEpisodeTitle",
"name": "includeEpisodeTitle",
"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",
@@ -4447,7 +4657,7 @@
}
},
{
"name": "ResourceName",
"name": "resourceName",
"in": "query",
"schema": {
"type": "string"
@@ -5212,6 +5422,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": "includeUnknownSeriesItems",
"in": "query",
@@ -7185,13 +7427,6 @@
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": {
"type": "integer",
"format": "int32"
@@ -7402,7 +7637,7 @@
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
"additionalProperties": {}
},
"nullable": true
}
@@ -7951,13 +8186,6 @@
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": {
"type": "integer",
"format": "int32"
@@ -8200,13 +8428,6 @@
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": {
"type": "integer",
"format": "int32"
@@ -8891,13 +9112,6 @@
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": {
"type": "integer",
"format": "int32"
@@ -9549,20 +9763,6 @@
},
"additionalProperties": false
},
"PagingResourceFilter": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParseResource": {
"type": "object",
"properties": {
@@ -10096,13 +10296,6 @@
"sortDirection": {
"$ref": "#/components/schemas/SortDirection"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagingResourceFilter"
},
"nullable": true
},
"totalRecords": {
"type": "integer",
"format": "int32"
@@ -11628,10 +11821,10 @@
},
"security": [
{
"X-Api-Key": [ ]
"X-Api-Key": []
},
{
"apikey": [ ]
"apikey": []
}
]
}