Automated API Docs update

This commit is contained in:
Sonarr 2023-05-15 04:11:40 +00:00 committed by Mark McDowall
parent 3508cb63dc
commit 14411f1f15
1 changed files with 157 additions and 2 deletions

View File

@ -502,6 +502,14 @@
"type": "boolean", "type": "boolean",
"default": false "default": false
} }
},
{
"name": "tags",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
} }
], ],
"responses": { "responses": {
@ -576,7 +584,7 @@
} }
}, },
{ {
"name": "tagList", "name": "tags",
"in": "query", "in": "query",
"schema": { "schema": {
"type": "string", "type": "string",
@ -1830,6 +1838,16 @@
"tags": [ "tags": [
"Episode" "Episode"
], ],
"parameters": [
{
"name": "includeImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": { "requestBody": {
"content": { "content": {
"application/json": { "application/json": {
@ -4259,6 +4277,14 @@
"type": "boolean" "type": "boolean"
} }
}, },
{
"name": "ColonReplacementFormat",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{ {
"name": "MultiEpisodeStyle", "name": "MultiEpisodeStyle",
"in": "query", "in": "query",
@ -6142,6 +6168,14 @@
"Series" "Series"
], ],
"parameters": [ "parameters": [
{
"name": "moveFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{ {
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -6196,6 +6230,22 @@
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
} }
},
{
"name": "deleteFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "addImportListExclusion",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
} }
], ],
"responses": { "responses": {
@ -7320,6 +7370,9 @@
"status": { "status": {
"$ref": "#/components/schemas/CommandStatus" "$ref": "#/components/schemas/CommandStatus"
}, },
"result": {
"$ref": "#/components/schemas/CommandResult"
},
"queued": { "queued": {
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
@ -7367,6 +7420,14 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"CommandResult": {
"enum": [
"unknown",
"successful",
"unsuccessful"
],
"type": "string"
},
"CommandStatus": { "CommandStatus": {
"enum": [ "enum": [
"queued", "queued",
@ -7810,6 +7871,10 @@
"format": "date-time", "format": "date-time",
"nullable": true "nullable": true
}, },
"runtime": {
"type": "integer",
"format": "int32"
},
"overview": { "overview": {
"type": "string", "type": "string",
"nullable": true "nullable": true
@ -7998,6 +8063,10 @@
}, },
"privacy": { "privacy": {
"$ref": "#/components/schemas/PrivacyLevel" "$ref": "#/components/schemas/PrivacyLevel"
},
"placeholder": {
"type": "string",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -9151,7 +9220,7 @@
"latestSeason", "latestSeason",
"pilot", "pilot",
"monitorSpecials", "monitorSpecials",
"UnmonitorSpecials", "unmonitorSpecials",
"none" "none"
], ],
"type": "string" "type": "string"
@ -9184,6 +9253,10 @@
"replaceIllegalCharacters": { "replaceIllegalCharacters": {
"type": "boolean" "type": "boolean"
}, },
"colonReplacementFormat": {
"type": "integer",
"format": "int32"
},
"multiEpisodeStyle": { "multiEpisodeStyle": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -9304,6 +9377,9 @@
"onRename": { "onRename": {
"type": "boolean" "type": "boolean"
}, },
"onSeriesAdd": {
"type": "boolean"
},
"onSeriesDelete": { "onSeriesDelete": {
"type": "boolean" "type": "boolean"
}, },
@ -9316,9 +9392,15 @@
"onHealthIssue": { "onHealthIssue": {
"type": "boolean" "type": "boolean"
}, },
"onHealthRestored": {
"type": "boolean"
},
"onApplicationUpdate": { "onApplicationUpdate": {
"type": "boolean" "type": "boolean"
}, },
"onManualInteractionRequired": {
"type": "boolean"
},
"supportsOnGrab": { "supportsOnGrab": {
"type": "boolean" "type": "boolean"
}, },
@ -9331,6 +9413,9 @@
"supportsOnRename": { "supportsOnRename": {
"type": "boolean" "type": "boolean"
}, },
"supportsOnSeriesAdd": {
"type": "boolean"
},
"supportsOnSeriesDelete": { "supportsOnSeriesDelete": {
"type": "boolean" "type": "boolean"
}, },
@ -9343,9 +9428,15 @@
"supportsOnHealthIssue": { "supportsOnHealthIssue": {
"type": "boolean" "type": "boolean"
}, },
"supportsOnHealthRestored": {
"type": "boolean"
},
"supportsOnApplicationUpdate": { "supportsOnApplicationUpdate": {
"type": "boolean" "type": "boolean"
}, },
"supportsOnManualInteractionRequired": {
"type": "boolean"
},
"includeHealthWarnings": { "includeHealthWarnings": {
"type": "boolean" "type": "boolean"
}, },
@ -9769,6 +9860,11 @@
"format": "int32", "format": "int32",
"nullable": true "nullable": true
}, },
"seasonNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"series": { "series": {
"$ref": "#/components/schemas/SeriesResource" "$ref": "#/components/schemas/SeriesResource"
}, },
@ -9851,6 +9947,9 @@
"outputPath": { "outputPath": {
"type": "string", "type": "string",
"nullable": true "nullable": true
},
"episodeHasFile": {
"type": "boolean"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -9962,6 +10061,33 @@
], ],
"type": "string" "type": "string"
}, },
"ReleaseEpisodeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"seasonNumber": {
"type": "integer",
"format": "int32"
},
"episodeNumber": {
"type": "integer",
"format": "int32"
},
"absoluteEpisodeNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ReleaseProfileResource": { "ReleaseProfileResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -10122,6 +10248,18 @@
}, },
"nullable": true "nullable": true
}, },
"mappedSeriesId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mappedEpisodeInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseEpisodeResource"
},
"nullable": true
},
"approved": { "approved": {
"type": "boolean" "type": "boolean"
}, },
@ -10228,6 +10366,23 @@
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"nullable": true "nullable": true
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"downloadClientId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shouldOverride": {
"type": "boolean",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false