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

Automated API Docs update

Browse source 
ignore-downstream
This commit is contained in:
Sonarr 2025-03-24 00:18:32 +00:00 • committed by Mark McDowall
parent 9756a3df38
commit b598795262
1 changed files with 240 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -508,6 +508,133 @@
}
}
}
},
"/api/v5/update": {
"get": {
"tags": [
"Update"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateResource"
}
}
}
}
}
}
}
},
"/api/v5/settings/update": {
"get": {
"tags": [
"UpdateSettings"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
}
}
}
}
},
"put": {
"tags": [
"UpdateSettings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
}
}
}
}
}
},
"/api/v5/settings/update/{id}": {
"get": {
"tags": [
"UpdateSettings"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSettingsResource"
}
}
}
}
}
}
}
},
"components": {
@ -1047,6 +1174,119 @@
"descending"
],
"type": "string"
},
"UpdateChanges": {
"type": "object",
"properties": {
"new": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fixed": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateMechanism": {
"enum": [
"builtIn",
"script",
"external",
"apt",
"docker"
],
"type": "string"
},
"UpdateResource": {
"required": [
"branch",
"changes",
"fileName",
"hash",
"url",
"version"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"version": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"releaseDate": {
"type": "string",
"format": "date-time"
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"installed": {
"type": "boolean"
},
"installedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"installable": {
"type": "boolean"
},
"latest": {
"type": "boolean"
},
"changes": {
"$ref": "#/components/schemas/UpdateChanges"
},
"hash": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateSettingsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"updateAutomatically": {
"type": "boolean"
},
"updateMechanism": {
"$ref": "#/components/schemas/UpdateMechanism"
},
"updateScriptPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {