mirror/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr synced 2024-12-21 23:33:00 +00:00
Code Issues Releases Wiki Activity

Updated API documents

Browse source
This commit is contained in:
Mark McDowall 2023-02-12 15:09:00 -08:00
parent d2cd3f7716
commit 27cc551980
1 changed files with 317 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

318
src/Sonarr.Api.V3/openapi.json
View file

@ -113,6 +113,173 @@
} }
} }
}, },
"/api/v3/autotagging": {
"post": {
"tags": [
"AutoTagging"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
},
"get": {
"tags": [
"AutoTagging"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
}
}
},
"/api/v3/autotagging/{id}": {
"put": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
},
"delete": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"get": {
"tags": [
"AutoTagging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoTaggingResource"
}
}
}
}
}
}
},
"/api/v3/autotagging/schema": {
"get": {
"tags": [
"AutoTagging"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v3/system/backup": { "/api/v3/system/backup": {
"get": { "get": {
"tags": [ "tags": [
@ -3325,6 +3492,25 @@
} }
} }
}, },
"/api/v3/localization/language": {
"get": {
"tags": [
"Localization"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalizationLanguageResource"
}
}
}
}
}
}
},
"/api/v3/localization/{id}": { "/api/v3/localization/{id}": {
"get": { "get": {
"tags": [ "tags": [
@ -6816,6 +7002,74 @@
], ],
"type": "string" "type": "string"
}, },
"AutoTaggingResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"removeTagsAutomatically": {
"type": "boolean"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoTaggingSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"AutoTaggingSpecificationSchema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
}
},
"additionalProperties": false
},
"BackupResource": { "BackupResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -7012,6 +7266,11 @@
"format": "date-time", "format": "date-time",
"nullable": true "nullable": true
}, },
"lastStartTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"trigger": { "trigger": {
"$ref": "#/components/schemas/CommandTrigger" "$ref": "#/components/schemas/CommandTrigger"
}, },
@ -7166,7 +7425,8 @@
"nullable": true "nullable": true
}, },
"includeCustomFormatWhenRenaming": { "includeCustomFormatWhenRenaming": {
"type": "boolean" "type": "boolean",
"nullable": true
}, },
"specifications": { "specifications": {
"type": "array", "type": "array",
@ -7251,6 +7511,13 @@
"bypassIfHighestQuality": { "bypassIfHighestQuality": {
"type": "boolean" "type": "boolean"
}, },
"bypassIfAboveCustomFormatScore": {
"type": "boolean"
},
"minimumCustomFormatScore": {
"type": "integer",
"format": "int32"
},
"order": { "order": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -7812,6 +8079,10 @@
}, },
"nullable": true "nullable": true
}, },
"customFormatScore": {
"type": "integer",
"format": "int32"
},
"qualityCutoffNotMet": { "qualityCutoffNotMet": {
"type": "boolean" "type": "boolean"
}, },
@ -8156,6 +8427,9 @@
"listOrder": { "listOrder": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
},
"minRefreshInterval": {
"$ref": "#/components/schemas/TimeSpan"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -8165,6 +8439,7 @@
"program", "program",
"plex", "plex",
"trakt", "trakt",
"simkl",
"other", "other",
"advanced" "advanced"
], ],
@ -8358,6 +8633,16 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"LocalizationLanguageResource": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LocalizationResource": { "LocalizationResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -8611,6 +8896,13 @@
"type": "string", "type": "string",
"nullable": true "nullable": true
}, },
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"rejections": { "rejections": {
"type": "array", "type": "array",
"items": { "items": {
@ -9340,6 +9632,11 @@
"type": "number", "type": "number",
"format": "double", "format": "double",
"nullable": true "nullable": true
},
"preferredSize": {
"type": "number",
"format": "double",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -10673,6 +10970,14 @@
}, },
"nullable": true "nullable": true
}, },
"autoTagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"seriesIds": { "seriesIds": {
"type": "array", "type": "array",
"items": { "items": {
@ -10721,9 +11026,16 @@
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"lastStartTime": {
"type": "string",
"format": "date-time"
},
"nextExecution": { "nextExecution": {
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
},
"lastDuration": {
"$ref": "#/components/schemas/TimeSpan"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -10879,6 +11191,10 @@
"path": { "path": {
"type": "string", "type": "string",
"nullable": true "nullable": true
},
"relativePath": {
"type": "string",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false