github/lidarr
1
0
Fork 0
mirror of https://github.com/lidarr/lidarr.git synced 2025-08-19 04:59:35 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Automated API Docs update

Browse source
This commit is contained in:
Servarr 2023-01-22 23:10:07 +00:00 • committed by Qstick
commit 7eb028caf3
1 changed files with 422 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

448
src/Lidarr.Api.V1/openapi.json
View file

@ -1410,6 +1410,183 @@
} }
} }
}, },
"/api/v1/customformat/{id}": {
"get": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"put": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"delete": {
"tags": [
"CustomFormat"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/customformat": {
"post": {
"tags": [
"CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
},
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
}
}
}
}
}
}
}
},
"/api/v1/customformat/schema": {
"get": {
"tags": [
"CustomFormat"
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/api/v1/wanted/cutoff": { "/api/v1/wanted/cutoff": {
"get": { "get": {
"tags": [ "tags": [
@ -9645,6 +9822,13 @@
"quality": { "quality": {
"$ref": "#/components/schemas/QualityModel" "$ref": "#/components/schemas/QualityModel"
}, },
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"date": { "date": {
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
@ -9901,6 +10085,101 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"CustomFormat": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean"
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ICustomFormatSpecification"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"includeCustomFormatWhenRenaming": {
"type": "boolean",
"nullable": true
},
"specifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFormatSpecificationSchema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"implementation": {
"type": "string",
"nullable": true
},
"implementationName": {
"type": "string",
"nullable": true
},
"infoLink": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatSpecificationSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"DatabaseType": { "DatabaseType": {
"enum": [ "enum": [
"sqLite", "sqLite",
@ -9932,6 +10211,16 @@
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"bypassIfHighestQuality": {
"type": "boolean"
},
"bypassIfAboveCustomFormatScore": {
"type": "boolean"
},
"minimumCustomFormatScore": {
"type": "integer",
"format": "int32"
},
"order": { "order": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
@ -10215,6 +10504,13 @@
"quality": { "quality": {
"$ref": "#/components/schemas/QualityModel" "$ref": "#/components/schemas/QualityModel"
}, },
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"qualityCutoffNotMet": { "qualityCutoffNotMet": {
"type": "boolean" "type": "boolean"
}, },
@ -10462,6 +10758,37 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"ICustomFormatSpecification": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"infoLink": {
"type": "string",
"nullable": true,
"readOnly": true
},
"implementationName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"negate": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ImportListExclusionResource": { "ImportListExclusionResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -11679,6 +12006,10 @@
"releaseVersion": { "releaseVersion": {
"type": "string", "type": "string",
"nullable": true "nullable": true
},
"releaseTitle": {
"type": "string",
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -11804,6 +12135,41 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"ProfileFormatItem": {
"type": "object",
"properties": {
"format": {
"$ref": "#/components/schemas/CustomFormat"
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProfileFormatItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"format": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProfilePrimaryAlbumTypeItem": { "ProfilePrimaryAlbumTypeItem": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -12000,6 +12366,21 @@
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItem"
},
"nullable": true
},
"items": { "items": {
"type": "array", "type": "array",
"items": { "items": {
@ -12101,6 +12482,21 @@
"$ref": "#/components/schemas/QualityProfileQualityItemResource" "$ref": "#/components/schemas/QualityProfileQualityItemResource"
}, },
"nullable": true "nullable": true
},
"minFormatScore": {
"type": "integer",
"format": "int32"
},
"cutoffFormatScore": {
"type": "integer",
"format": "int32"
},
"formatItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileFormatItemResource"
},
"nullable": true
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -12145,6 +12541,13 @@
"quality": { "quality": {
"$ref": "#/components/schemas/QualityModel" "$ref": "#/components/schemas/QualityModel"
}, },
"customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"size": { "size": {
"type": "number", "type": "number",
"format": "double" "format": "double"
@ -12329,22 +12732,18 @@
"type": "boolean" "type": "boolean"
}, },
"required": { "required": {
"type": "string",
"nullable": true
},
"ignored": {
"type": "string",
"nullable": true
},
"preferred": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/components/schemas/StringInt32KeyValuePair" "type": "string"
}, },
"nullable": true "nullable": true
}, },
"includePreferredWhenRenaming": { "ignored": {
"type": "boolean" "type": "array",
"items": {
"type": "string"
},
"nullable": true
}, },
"indexerId": { "indexerId": {
"type": "integer", "type": "integer",
@ -12477,7 +12876,14 @@
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"preferredWordScore": { "customFormats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFormatResource"
},
"nullable": true
},
"customFormatScore": {
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
@ -12761,20 +13167,6 @@
], ],
"type": "string" "type": "string"
}, },
"StringInt32KeyValuePair": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SystemResource": { "SystemResource": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -13197,6 +13589,10 @@
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"originalFilePath": {
"type": "string",
"nullable": true
},
"sceneName": { "sceneName": {
"type": "string", "type": "string",
"nullable": true "nullable": true