github-mirrors/sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2025-04-23 13:57:06 -04:00
Code Issues Projects Releases Packages Wiki Activity

API docs for v5 series

Browse source
This commit is contained in:
Mark McDowall 2025-02-19 17:01:13 -08:00
parent 05d57aa913
commit 5678f98344
No known key found for this signature in database
2 changed files with 191 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/Sonarr.Api.V5/Series/SeriesController.cs
View file

@ -127,6 +127,12 @@ namespace Sonarr.Api.V5.Series
return seriesResources;
}
[NonAction]
public override ActionResult<SeriesResource> GetResourceByIdWithErrorHandler(int id)
{
return base.GetResourceByIdWithErrorHandler(id);
}
[RestGetById]
[Produces("application/json")]
public ActionResult<SeriesResource> GetResourceByIdWithErrorHandler(int id, [FromQuery]bool includeSeasonImages = false)

185
src/Sonarr.Api.V5/openapi.json
View file

@ -149,6 +149,191 @@
}
}
},
"/api/v5/series": {
"get": {
"tags": [
"Series"
],
"parameters": [
{
"name": "tvdbId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSeasonImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
},
"post": {
"tags": [
"Series"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
}
},
"/api/v5/series/{id}": {
"get": {
"tags": [
"Series"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeSeasonImages",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
},
"put": {
"tags": [
"Series"
],
"parameters": [
{
"name": "moveFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeriesResource"
}
}
}
}
}
},
"delete": {
"tags": [
"Series"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "deleteFiles",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "addImportListExclusion",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v5/series/lookup": {
"get": {
"tags": [