{ "openapi": "3.0.1", "info": { "title": "Lidarr", "description": "Lidarr API docs", "license": { "name": "GPL-3.0", "url": "https://github.com/Lidarr/Lidarr/blob/develop/LICENSE" }, "version": "1.0.0" }, "servers": [ { "url": "{protocol}://{hostpath}", "variables": { "protocol": { "default": "http", "enum": [ "http", "https" ] }, "hostpath": { "default": "localhost:8686" } } } ], "paths": { "/api/v1/album": { "get": { "tags": [ "Album" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "foreignAlbumId", "in": "query", "schema": { "type": "string" } }, { "name": "includeAllArtistAlbums", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "post": { "tags": [ "Album" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "/api/v1/album/{id}": { "put": { "tags": [ "Album" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } }, "delete": { "tags": [ "Album" ], "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": "Success" } } }, "get": { "tags": [ "Album" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "/api/v1/album/monitor": { "put": { "tags": [ "Album" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbumsMonitoredResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumsMonitoredResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlbumsMonitoredResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/album/lookup": { "get": { "tags": [ "AlbumLookup" ], "parameters": [ { "name": "term", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/albumstudio": { "post": { "tags": [ "AlbumStudio" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbumStudioResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumStudioResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlbumStudioResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api": { "get": { "tags": [ "ApiInfo" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/artist/{id}": { "get": { "tags": [ "Artist" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } } } } } }, "put": { "tags": [ "Artist" ], "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/ArtistResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } } } } } }, "delete": { "tags": [ "Artist" ], "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": "Success" } } } }, "/api/v1/artist": { "get": { "tags": [ "Artist" ], "parameters": [ { "name": "mbId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtistResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtistResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtistResource" } } } } } } }, "post": { "tags": [ "Artist" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistResource" } } } } } } }, "/api/v1/artist/editor": { "put": { "tags": [ "ArtistEditor" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "ArtistEditor" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArtistEditorResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/artist/lookup": { "get": { "tags": [ "ArtistLookup" ], "parameters": [ { "name": "term", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/login": { "post": { "tags": [ "Authentication" ], "parameters": [ { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Username": { "type": "string" }, "Password": { "type": "string" }, "RememberMe": { "type": "string" } } }, "encoding": { "Username": { "style": "form" }, "Password": { "style": "form" }, "RememberMe": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "StaticResource" ], "responses": { "200": { "description": "Success" } } } }, "/logout": { "get": { "tags": [ "Authentication" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/backup": { "get": { "tags": [ "Backup" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BackupResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BackupResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BackupResource" } } } } } } } }, "/api/v1/system/backup/{id}": { "delete": { "tags": [ "Backup" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/backup/restore/{id}": { "post": { "tags": [ "Backup" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/backup/restore/upload": { "post": { "tags": [ "Backup" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/blocklist": { "get": { "tags": [ "Blocklist" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BlocklistResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlocklistResourcePagingResource" } } } } } } }, "/api/v1/blocklist/{id}": { "delete": { "tags": [ "Blocklist" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/blocklist/bulk": { "delete": { "tags": [ "Blocklist" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistBulkResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlocklistBulkResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BlocklistBulkResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/calendar": { "get": { "tags": [ "Calendar" ], "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "unmonitored", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" } } } } } } } }, "/api/v1/calendar/{id}": { "get": { "tags": [ "Calendar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "/feed/v1/calendar/lidarr.ics": { "get": { "tags": [ "CalendarFeed" ], "parameters": [ { "name": "pastDays", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 7 } }, { "name": "futureDays", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 28 } }, { "name": "tagList", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "unmonitored", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/command/{id}": { "get": { "tags": [ "Command" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } } } } } }, "delete": { "tags": [ "Command" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/command": { "post": { "tags": [ "Command" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommandResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommandResource" } } } } } }, "get": { "tags": [ "Command" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommandResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommandResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommandResource" } } } } } } } }, "/api/v1/customfilter/{id}": { "get": { "tags": [ "CustomFilter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } } } } } }, "put": { "tags": [ "CustomFilter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } } } } } }, "delete": { "tags": [ "CustomFilter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/customfilter": { "get": { "tags": [ "CustomFilter" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFilterResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFilterResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFilterResource" } } } } } } }, "post": { "tags": [ "CustomFilter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFilterResource" } } } } } } }, "/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": { "get": { "tags": [ "Cutoff" ], "parameters": [ { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } } } } } } }, "/api/v1/wanted/cutoff/{id}": { "get": { "tags": [ "Cutoff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "/api/v1/delayprofile": { "post": { "tags": [ "DelayProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } } } } } }, "get": { "tags": [ "DelayProfile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelayProfileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelayProfileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelayProfileResource" } } } } } } } }, "/api/v1/delayprofile/{id}": { "delete": { "tags": [ "DelayProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "DelayProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } } } } } }, "get": { "tags": [ "DelayProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelayProfileResource" } } } } } } }, "/api/v1/delayprofile/reorder/{id}": { "put": { "tags": [ "DelayProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "afterId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/diskspace": { "get": { "tags": [ "DiskSpace" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiskSpaceResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiskSpaceResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiskSpaceResource" } } } } } } } }, "/api/v1/downloadclient/{id}": { "get": { "tags": [ "DownloadClient" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } } } }, "put": { "tags": [ "DownloadClient" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } } } }, "delete": { "tags": [ "DownloadClient" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/downloadclient": { "get": { "tags": [ "DownloadClient" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } } } } } }, "post": { "tags": [ "DownloadClient" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } } } } }, "/api/v1/downloadclient/schema": { "get": { "tags": [ "DownloadClient" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" } } } } } } } }, "/api/v1/downloadclient/test": { "post": { "tags": [ "DownloadClient" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/downloadclient/testall": { "post": { "tags": [ "DownloadClient" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/downloadclient/action/{name}": { "post": { "tags": [ "DownloadClient" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownloadClientResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/config/downloadclient/{id}": { "get": { "tags": [ "DownloadClientConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } } } } } }, "put": { "tags": [ "DownloadClientConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } } } } } } }, "/api/v1/config/downloadclient": { "get": { "tags": [ "DownloadClientConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadClientConfigResource" } } } } } } }, "/api/v1/filesystem": { "get": { "tags": [ "FileSystem" ], "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "allowFoldersWithoutTrailingSlashes", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/filesystem/type": { "get": { "tags": [ "FileSystem" ], "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/filesystem/mediafiles": { "get": { "tags": [ "FileSystem" ], "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/health/{id}": { "get": { "tags": [ "Health" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HealthResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HealthResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HealthResource" } } } } } } }, "/api/v1/health": { "get": { "tags": [ "Health" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HealthResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HealthResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HealthResource" } } } } } } } }, "/api/v1/history": { "get": { "tags": [ "History" ], "parameters": [ { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAlbum", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeTrack", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HistoryResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HistoryResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HistoryResourcePagingResource" } } } } } } }, "/api/v1/history/since": { "get": { "tags": [ "History" ], "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "eventType", "in": "query", "schema": { "$ref": "#/components/schemas/EntityHistoryEventType" } }, { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAlbum", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeTrack", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } } } } } } }, "/api/v1/history/artist": { "get": { "tags": [ "History" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "eventType", "in": "query", "schema": { "$ref": "#/components/schemas/EntityHistoryEventType" } }, { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAlbum", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeTrack", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } } } } } } } }, "/api/v1/history/failed/{id}": { "post": { "tags": [ "History" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/config/host/{id}": { "get": { "tags": [ "HostConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } } } } } }, "put": { "tags": [ "HostConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } } } } } } }, "/api/v1/config/host": { "get": { "tags": [ "HostConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HostConfigResource" } } } } } } }, "/api/v1/importlist/{id}": { "get": { "tags": [ "ImportList" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } } } }, "put": { "tags": [ "ImportList" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } } } }, "delete": { "tags": [ "ImportList" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/importlist": { "get": { "tags": [ "ImportList" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } } } } } }, "post": { "tags": [ "ImportList" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } } } } }, "/api/v1/importlist/schema": { "get": { "tags": [ "ImportList" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" } } } } } } } }, "/api/v1/importlist/test": { "post": { "tags": [ "ImportList" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/importlist/testall": { "post": { "tags": [ "ImportList" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/importlist/action/{name}": { "post": { "tags": [ "ImportList" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/importlistexclusion/{id}": { "get": { "tags": [ "ImportListExclusion" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } } } }, "put": { "tags": [ "ImportListExclusion" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } } } }, "delete": { "tags": [ "ImportListExclusion" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/importlistexclusion": { "get": { "tags": [ "ImportListExclusion" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListExclusionResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListExclusionResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } } } } }, "post": { "tags": [ "ImportListExclusion" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportListExclusionResource" } } } } } } }, "/api/v1/indexer/{id}": { "get": { "tags": [ "Indexer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } } } }, "put": { "tags": [ "Indexer" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } } } }, "delete": { "tags": [ "Indexer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/indexer": { "get": { "tags": [ "Indexer" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } } } } } }, "post": { "tags": [ "Indexer" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } } } } }, "/api/v1/indexer/schema": { "get": { "tags": [ "Indexer" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" } } } } } } } }, "/api/v1/indexer/test": { "post": { "tags": [ "Indexer" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/indexer/testall": { "post": { "tags": [ "Indexer" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/indexer/action/{name}": { "post": { "tags": [ "Indexer" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexerResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/config/indexer/{id}": { "get": { "tags": [ "IndexerConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } } } } } }, "put": { "tags": [ "IndexerConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } } } } } } }, "/api/v1/config/indexer": { "get": { "tags": [ "IndexerConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexerConfigResource" } } } } } } }, "/initialize.js": { "get": { "tags": [ "InitializeJs" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/language/{id}": { "get": { "tags": [ "Language" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LanguageResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LanguageResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageResource" } } } } } } }, "/api/v1/language": { "get": { "tags": [ "Language" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" } } } } } } } }, "/api/v1/localization": { "get": { "tags": [ "Localization" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v1/log": { "get": { "tags": [ "Log" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResourcePagingResource" } } } } } } }, "/api/v1/log/file": { "get": { "tags": [ "LogFile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } } } } } } }, "/api/v1/log/file/{filename}": { "get": { "tags": [ "LogFile" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "schema": { "pattern": "[-.a-zA-Z0-9]+?\\.txt", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/manualimport": { "post": { "tags": [ "ManualImport" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportUpdateResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportUpdateResource" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportUpdateResource" } } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "ManualImport" ], "parameters": [ { "name": "folder", "in": "query", "schema": { "type": "string" } }, { "name": "downloadId", "in": "query", "schema": { "type": "string" } }, { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "filterExistingFiles", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "replaceExistingFiles", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualImportResource" } } } } } } } }, "/api/v1/mediacover/artist/{artistId}/{filename}": { "get": { "tags": [ "MediaCover" ], "parameters": [ { "name": "artistId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filename", "in": "path", "required": true, "schema": { "pattern": "(.+)\\.(jpg|png|gif)", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/mediacover/album/{albumId}/{filename}": { "get": { "tags": [ "MediaCover" ], "parameters": [ { "name": "albumId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filename", "in": "path", "required": true, "schema": { "pattern": "(.+)\\.(jpg|png|gif)", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/config/mediamanagement/{id}": { "get": { "tags": [ "MediaManagementConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } } } } } }, "put": { "tags": [ "MediaManagementConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } } } } } } }, "/api/v1/config/mediamanagement": { "get": { "tags": [ "MediaManagementConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaManagementConfigResource" } } } } } } }, "/api/v1/metadata/{id}": { "get": { "tags": [ "Metadata" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } } } }, "put": { "tags": [ "Metadata" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } } } }, "delete": { "tags": [ "Metadata" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/metadata": { "get": { "tags": [ "Metadata" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } } } } } }, "post": { "tags": [ "Metadata" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } } } } }, "/api/v1/metadata/schema": { "get": { "tags": [ "Metadata" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" } } } } } } } }, "/api/v1/metadata/test": { "post": { "tags": [ "Metadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/metadata/testall": { "post": { "tags": [ "Metadata" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/metadata/action/{name}": { "post": { "tags": [ "Metadata" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/metadataprofile": { "post": { "tags": [ "MetadataProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } } } }, "get": { "tags": [ "MetadataProfile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataProfileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataProfileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataProfileResource" } } } } } } } }, "/api/v1/metadataprofile/{id}": { "delete": { "tags": [ "MetadataProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "MetadataProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } } } }, "get": { "tags": [ "MetadataProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } } } } }, "/api/v1/metadataprofile/schema": { "get": { "tags": [ "MetadataProfileSchema" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProfileResource" } } } } } } }, "/api/v1/config/metadataprovider/{id}": { "get": { "tags": [ "MetadataProviderConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } } } } } }, "put": { "tags": [ "MetadataProviderConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } } } } } } }, "/api/v1/config/metadataprovider": { "get": { "tags": [ "MetadataProviderConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetadataProviderConfigResource" } } } } } } }, "/api/v1/wanted/missing": { "get": { "tags": [ "Missing" ], "parameters": [ { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResourcePagingResource" } } } } } } }, "/api/v1/wanted/missing/{id}": { "get": { "tags": [ "Missing" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlbumResource" } } } } } } }, "/api/v1/config/naming/{id}": { "get": { "tags": [ "NamingConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } } } } } }, "put": { "tags": [ "NamingConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } } } } } } }, "/api/v1/config/naming": { "get": { "tags": [ "NamingConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConfigResource" } } } } } } }, "/api/v1/config/naming/examples": { "get": { "tags": [ "NamingConfig" ], "parameters": [ { "name": "RenameTracks", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReplaceIllegalCharacters", "in": "query", "schema": { "type": "boolean" } }, { "name": "ColonReplacementFormat", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "StandardTrackFormat", "in": "query", "schema": { "type": "string" } }, { "name": "MultiDiscTrackFormat", "in": "query", "schema": { "type": "string" } }, { "name": "ArtistFolderFormat", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeArtistName", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAlbumTitle", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeQuality", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReplaceSpaces", "in": "query", "schema": { "type": "boolean" } }, { "name": "Separator", "in": "query", "schema": { "type": "string" } }, { "name": "NumberStyle", "in": "query", "schema": { "type": "string" } }, { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ResourceName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/notification/{id}": { "get": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } } } }, "put": { "tags": [ "Notification" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } } } }, "delete": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/notification": { "get": { "tags": [ "Notification" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } } } } } }, "post": { "tags": [ "Notification" ], "parameters": [ { "name": "forceSave", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } } } } }, "/api/v1/notification/schema": { "get": { "tags": [ "Notification" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } } } } } } } }, "/api/v1/notification/test": { "post": { "tags": [ "Notification" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/notification/testall": { "post": { "tags": [ "Notification" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/notification/action/{name}": { "post": { "tags": [ "Notification" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/parse": { "get": { "tags": [ "Parse" ], "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ParseResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ParseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParseResource" } } } } } } }, "/ping": { "get": { "tags": [ "Ping" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResource" } } } } } } }, "/api/v1/qualitydefinition/{id}": { "put": { "tags": [ "QualityDefinition" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } } } } } }, "get": { "tags": [ "QualityDefinition" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityDefinitionResource" } } } } } } }, "/api/v1/qualitydefinition": { "get": { "tags": [ "QualityDefinition" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } } } } } } }, "/api/v1/qualitydefinition/update": { "put": { "tags": [ "QualityDefinition" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityDefinitionResource" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/qualityprofile": { "post": { "tags": [ "QualityProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } } } }, "get": { "tags": [ "QualityProfile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileResource" } } } } } } } }, "/api/v1/qualityprofile/{id}": { "delete": { "tags": [ "QualityProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "QualityProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } } } }, "get": { "tags": [ "QualityProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } } } } }, "/api/v1/qualityprofile/schema": { "get": { "tags": [ "QualityProfileSchema" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityProfileResource" } } } } } } }, "/api/v1/queue/{id}": { "get": { "tags": [ "Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueResource" } } } } } }, "delete": { "tags": [ "Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "removeFromClient", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "blocklist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "skipReDownload", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/queue/bulk": { "delete": { "tags": [ "Queue" ], "parameters": [ { "name": "removeFromClient", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "blocklist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "skipReDownload", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/queue": { "get": { "tags": [ "Queue" ], "parameters": [ { "name": "includeUnknownArtistItems", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAlbum", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueResourcePagingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueResourcePagingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueResourcePagingResource" } } } } } } }, "/api/v1/queue/grab/{id}": { "post": { "tags": [ "QueueAction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/queue/grab/bulk": { "post": { "tags": [ "QueueAction" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QueueBulkResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/queue/details/{id}": { "get": { "tags": [ "QueueDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueResource" } } } } } } }, "/api/v1/queue/details": { "get": { "tags": [ "QueueDetails" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "includeArtist", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeAlbum", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueResource" } } } } } } } }, "/api/v1/queue/status/{id}": { "get": { "tags": [ "QueueStatus" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } } } } } } }, "/api/v1/queue/status": { "get": { "tags": [ "QueueStatus" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueStatusResource" } } } } } } }, "/api/v1/release": { "post": { "tags": [ "Release" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } } } }, "get": { "tags": [ "Release" ], "parameters": [ { "name": "albumId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseResource" } } } } } } } }, "/api/v1/release/{id}": { "get": { "tags": [ "Release" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } } } } }, "/api/v1/releaseprofile/{id}": { "get": { "tags": [ "ReleaseProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } } } }, "put": { "tags": [ "ReleaseProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } } } }, "delete": { "tags": [ "ReleaseProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/releaseprofile": { "get": { "tags": [ "ReleaseProfile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseProfileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseProfileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } } } } }, "post": { "tags": [ "ReleaseProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseProfileResource" } } } } } } }, "/api/v1/release/push": { "post": { "tags": [ "ReleasePush" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } } } } }, "/api/v1/release/push/{id}": { "get": { "tags": [ "ReleasePush" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseResource" } } } } } } }, "/api/v1/remotepathmapping/{id}": { "get": { "tags": [ "RemotePathMapping" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } } } }, "delete": { "tags": [ "RemotePathMapping" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "RemotePathMapping" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } } } } }, "/api/v1/remotepathmapping": { "post": { "tags": [ "RemotePathMapping" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } } } }, "get": { "tags": [ "RemotePathMapping" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemotePathMappingResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemotePathMappingResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemotePathMappingResource" } } } } } } } }, "/api/v1/rename": { "get": { "tags": [ "RenameTrack" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RenameTrackResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RenameTrackResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RenameTrackResource" } } } } } } } }, "/api/v1/retag": { "get": { "tags": [ "RetagTrack" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetagTrackResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetagTrackResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetagTrackResource" } } } } } } } }, "/api/v1/rootfolder/{id}": { "get": { "tags": [ "RootFolder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } } } } } }, "put": { "tags": [ "RootFolder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } } } } } }, "delete": { "tags": [ "RootFolder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/rootfolder": { "post": { "tags": [ "RootFolder" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RootFolderResource" } } } } } }, "get": { "tags": [ "RootFolder" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RootFolderResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RootFolderResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RootFolderResource" } } } } } } } }, "/api/v1/search": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "term", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/content/{path}": { "get": { "tags": [ "StaticResource" ], "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "pattern": "^(?!api/).*", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/": { "get": { "tags": [ "StaticResource" ], "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/{path}": { "get": { "tags": [ "StaticResource" ], "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "pattern": "^(?!(api|feed)/).*", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/status": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemResource" } } } } } } }, "/api/v1/system/routes": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/routes/duplicate": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/shutdown": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/system/restart": { "post": { "tags": [ "System" ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/tag/{id}": { "get": { "tags": [ "Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } } }, "put": { "tags": [ "Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } } }, "delete": { "tags": [ "Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/tag": { "get": { "tags": [ "Tag" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResource" } } } } } } }, "post": { "tags": [ "Tag" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TagResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagResource" } } } } } } }, "/api/v1/tag/detail/{id}": { "get": { "tags": [ "TagDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TagDetailsResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TagDetailsResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagDetailsResource" } } } } } } }, "/api/v1/tag/detail": { "get": { "tags": [ "TagDetails" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDetailsResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDetailsResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagDetailsResource" } } } } } } } }, "/api/v1/system/task": { "get": { "tags": [ "Task" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResource" } } } } } } } }, "/api/v1/system/task/{id}": { "get": { "tags": [ "Task" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskResource" } } } } } } }, "/api/v1/track": { "get": { "tags": [ "Track" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "albumReleaseId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "trackIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResource" } } } } } } } }, "/api/v1/track/{id}": { "get": { "tags": [ "Track" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResource" } } } } } } }, "/api/v1/trackfile/{id}": { "get": { "tags": [ "TrackFile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } } } } } }, "put": { "tags": [ "TrackFile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackFileResource" } } } } } }, "delete": { "tags": [ "TrackFile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v1/trackfile": { "get": { "tags": [ "TrackFile" ], "parameters": [ { "name": "artistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "trackFileIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "albumId", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "unmapped", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackFileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackFileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackFileResource" } } } } } } } }, "/api/v1/trackfile/editor": { "put": { "tags": [ "TrackFile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/trackfile/bulk": { "delete": { "tags": [ "TrackFile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackFileListResource" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/config/ui/{id}": { "put": { "tags": [ "UiConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } } } } } }, "get": { "tags": [ "UiConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } } } } } } }, "/api/v1/config/ui": { "get": { "tags": [ "UiConfig" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiConfigResource" } } } } } } }, "/api/v1/update": { "get": { "tags": [ "Update" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateResource" } } } } } } } }, "/api/v1/log/file/update": { "get": { "tags": [ "UpdateLogFile" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogFileResource" } } } } } } } }, "/api/v1/log/file/update/{filename}": { "get": { "tags": [ "UpdateLogFile" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "schema": { "pattern": "[-.a-zA-Z0-9]+?\\.txt", "type": "string" } } ], "responses": { "200": { "description": "Success" } } } } }, "components": { "schemas": { "AddAlbumOptions": { "type": "object", "properties": { "addType": { "$ref": "#/components/schemas/AlbumAddType" }, "searchForNewAlbum": { "type": "boolean" } }, "additionalProperties": false }, "AddArtistOptions": { "type": "object", "properties": { "monitor": { "$ref": "#/components/schemas/MonitorTypes" }, "albumsToMonitor": { "type": "array", "items": { "type": "string" }, "nullable": true }, "monitored": { "type": "boolean" }, "searchForMissingAlbums": { "type": "boolean" } }, "additionalProperties": false }, "Album": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistMetadataId": { "type": "integer", "format": "int32" }, "foreignAlbumId": { "type": "string", "nullable": true }, "oldForeignAlbumIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "title": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "releaseDate": { "type": "string", "format": "date-time", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCover" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Links" }, "nullable": true }, "genres": { "type": "array", "items": { "type": "string" }, "nullable": true }, "albumType": { "type": "string", "nullable": true }, "secondaryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/SecondaryAlbumType" }, "nullable": true }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "cleanTitle": { "type": "string", "nullable": true }, "profileId": { "type": "integer", "format": "int32" }, "monitored": { "type": "boolean" }, "anyReleaseOk": { "type": "boolean" }, "lastInfoSync": { "type": "string", "format": "date-time", "nullable": true }, "added": { "type": "string", "format": "date-time" }, "addOptions": { "$ref": "#/components/schemas/AddAlbumOptions" }, "artistMetadata": { "$ref": "#/components/schemas/ArtistMetadataLazyLoaded" }, "albumReleases": { "$ref": "#/components/schemas/AlbumReleaseListLazyLoaded" }, "artist": { "$ref": "#/components/schemas/ArtistLazyLoaded" } }, "additionalProperties": false }, "AlbumAddType": { "enum": [ "automatic", "manual" ], "type": "string" }, "AlbumLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/Album" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AlbumListLazyLoaded": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Album" }, "nullable": true, "readOnly": true }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AlbumRelease": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "foreignReleaseId": { "type": "string", "nullable": true }, "oldForeignReleaseIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "label": { "type": "array", "items": { "type": "string" }, "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "country": { "type": "array", "items": { "type": "string" }, "nullable": true }, "releaseDate": { "type": "string", "format": "date-time", "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Medium" }, "nullable": true }, "trackCount": { "type": "integer", "format": "int32" }, "monitored": { "type": "boolean" }, "album": { "$ref": "#/components/schemas/AlbumLazyLoaded" }, "tracks": { "$ref": "#/components/schemas/TrackListLazyLoaded" } }, "additionalProperties": false }, "AlbumReleaseLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/AlbumRelease" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AlbumReleaseListLazyLoaded": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumRelease" }, "nullable": true, "readOnly": true }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AlbumReleaseResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "foreignReleaseId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "trackCount": { "type": "integer", "format": "int32" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MediumResource" }, "nullable": true }, "mediumCount": { "type": "integer", "format": "int32", "readOnly": true }, "disambiguation": { "type": "string", "nullable": true }, "country": { "type": "array", "items": { "type": "string" }, "nullable": true }, "label": { "type": "array", "items": { "type": "string" }, "nullable": true }, "format": { "type": "string", "nullable": true }, "monitored": { "type": "boolean" } }, "additionalProperties": false }, "AlbumResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "artistId": { "type": "integer", "format": "int32" }, "foreignAlbumId": { "type": "string", "nullable": true }, "monitored": { "type": "boolean" }, "anyReleaseOk": { "type": "boolean" }, "profileId": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" }, "albumType": { "type": "string", "nullable": true }, "secondaryTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "mediumCount": { "type": "integer", "format": "int32", "readOnly": true }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "releaseDate": { "type": "string", "format": "date-time", "nullable": true }, "releases": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumReleaseResource" }, "nullable": true }, "genres": { "type": "array", "items": { "type": "string" }, "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MediumResource" }, "nullable": true }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCover" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Links" }, "nullable": true }, "statistics": { "$ref": "#/components/schemas/AlbumStatisticsResource" }, "addOptions": { "$ref": "#/components/schemas/AddAlbumOptions" }, "remoteCover": { "type": "string", "nullable": true }, "grabbed": { "type": "boolean" } }, "additionalProperties": false }, "AlbumResourcePagingResource": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "sortKey": { "type": "string", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/PagingResourceFilter" }, "nullable": true }, "totalRecords": { "type": "integer", "format": "int32" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" }, "nullable": true } }, "additionalProperties": false }, "AlbumStatisticsResource": { "type": "object", "properties": { "trackFileCount": { "type": "integer", "format": "int32" }, "trackCount": { "type": "integer", "format": "int32" }, "totalTrackCount": { "type": "integer", "format": "int32" }, "sizeOnDisk": { "type": "integer", "format": "int64" }, "percentOfTracks": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "AlbumStudioArtistResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "monitored": { "type": "boolean", "nullable": true }, "albums": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" }, "nullable": true } }, "additionalProperties": false }, "AlbumStudioResource": { "type": "object", "properties": { "artist": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumStudioArtistResource" }, "nullable": true }, "monitoringOptions": { "$ref": "#/components/schemas/MonitoringOptions" }, "monitorNewItems": { "$ref": "#/components/schemas/NewItemMonitorTypes" } }, "additionalProperties": false }, "AlbumsMonitoredResource": { "type": "object", "properties": { "albumIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "monitored": { "type": "boolean" } }, "additionalProperties": false }, "AllowFingerprinting": { "enum": [ "never", "newFiles", "allFiles" ], "type": "string" }, "ApplyTags": { "enum": [ "add", "remove", "replace" ], "type": "string" }, "Artist": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistMetadataId": { "type": "integer", "format": "int32" }, "cleanName": { "type": "string", "nullable": true }, "sortName": { "type": "string", "nullable": true }, "monitored": { "type": "boolean" }, "monitorNewItems": { "$ref": "#/components/schemas/NewItemMonitorTypes" }, "lastInfoSync": { "type": "string", "format": "date-time", "nullable": true }, "path": { "type": "string", "nullable": true }, "rootFolderPath": { "type": "string", "nullable": true }, "added": { "type": "string", "format": "date-time" }, "qualityProfileId": { "type": "integer", "format": "int32" }, "metadataProfileId": { "type": "integer", "format": "int32" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "addOptions": { "$ref": "#/components/schemas/AddArtistOptions" }, "metadata": { "$ref": "#/components/schemas/ArtistMetadataLazyLoaded" }, "qualityProfile": { "$ref": "#/components/schemas/QualityProfileLazyLoaded" }, "metadataProfile": { "$ref": "#/components/schemas/MetadataProfileLazyLoaded" }, "albums": { "$ref": "#/components/schemas/AlbumListLazyLoaded" }, "name": { "type": "string", "nullable": true }, "foreignArtistId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ArtistEditorResource": { "type": "object", "properties": { "artistIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "monitored": { "type": "boolean", "nullable": true }, "monitorNewItems": { "$ref": "#/components/schemas/NewItemMonitorTypes" }, "qualityProfileId": { "type": "integer", "format": "int32", "nullable": true }, "metadataProfileId": { "type": "integer", "format": "int32", "nullable": true }, "rootFolderPath": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "applyTags": { "$ref": "#/components/schemas/ApplyTags" }, "moveFiles": { "type": "boolean" }, "deleteFiles": { "type": "boolean" } }, "additionalProperties": false }, "ArtistLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/Artist" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ArtistMetadata": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "foreignArtistId": { "type": "string", "nullable": true }, "oldForeignArtistIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "overview": { "type": "string", "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/ArtistStatusType" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCover" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Links" }, "nullable": true }, "genres": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" }, "nullable": true } }, "additionalProperties": false }, "ArtistMetadataLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ArtistMetadata" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ArtistResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistMetadataId": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ArtistStatusType" }, "ended": { "type": "boolean", "readOnly": true }, "artistName": { "type": "string", "nullable": true }, "foreignArtistId": { "type": "string", "nullable": true }, "mbId": { "type": "string", "nullable": true }, "tadbId": { "type": "integer", "format": "int32" }, "discogsId": { "type": "integer", "format": "int32" }, "allMusicId": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "artistType": { "type": "string", "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Links" }, "nullable": true }, "nextAlbum": { "$ref": "#/components/schemas/Album" }, "lastAlbum": { "$ref": "#/components/schemas/Album" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCover" }, "nullable": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" }, "nullable": true }, "remotePoster": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "qualityProfileId": { "type": "integer", "format": "int32" }, "metadataProfileId": { "type": "integer", "format": "int32" }, "monitored": { "type": "boolean" }, "monitorNewItems": { "$ref": "#/components/schemas/NewItemMonitorTypes" }, "rootFolderPath": { "type": "string", "nullable": true }, "genres": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cleanName": { "type": "string", "nullable": true }, "sortName": { "type": "string", "nullable": true }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "added": { "type": "string", "format": "date-time" }, "addOptions": { "$ref": "#/components/schemas/AddArtistOptions" }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "statistics": { "$ref": "#/components/schemas/ArtistStatisticsResource" } }, "additionalProperties": false }, "ArtistStatisticsResource": { "type": "object", "properties": { "albumCount": { "type": "integer", "format": "int32" }, "trackFileCount": { "type": "integer", "format": "int32" }, "trackCount": { "type": "integer", "format": "int32" }, "totalTrackCount": { "type": "integer", "format": "int32" }, "sizeOnDisk": { "type": "integer", "format": "int64" }, "percentOfTracks": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "ArtistStatusType": { "enum": [ "continuing", "ended" ], "type": "string" }, "ArtistTitleInfo": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "titleWithoutYear": { "type": "string", "nullable": true }, "year": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AuthenticationType": { "enum": [ "none", "basic", "forms" ], "type": "string" }, "BackupResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/BackupType" }, "size": { "type": "integer", "format": "int64" }, "time": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BackupType": { "enum": [ "scheduled", "manual", "update" ], "type": "string" }, "BlocklistBulkResource": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "BlocklistResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "albumIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "sourceTitle": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "customFormats": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFormatResource" }, "nullable": true }, "date": { "type": "string", "format": "date-time" }, "protocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "indexer": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "artist": { "$ref": "#/components/schemas/ArtistResource" } }, "additionalProperties": false }, "BlocklistResourcePagingResource": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "sortKey": { "type": "string", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/PagingResourceFilter" }, "nullable": true }, "totalRecords": { "type": "integer", "format": "int32" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistResource" }, "nullable": true } }, "additionalProperties": false }, "CertificateValidationType": { "enum": [ "enabled", "disabledForLocalAddresses", "disabled" ], "type": "string" }, "Command": { "type": "object", "properties": { "sendUpdatesToClient": { "type": "boolean" }, "updateScheduledTask": { "type": "boolean", "readOnly": true }, "completionMessage": { "type": "string", "nullable": true, "readOnly": true }, "requiresDiskAccess": { "type": "boolean", "readOnly": true }, "isExclusive": { "type": "boolean", "readOnly": true }, "isTypeExclusive": { "type": "boolean", "readOnly": true }, "isLongRunning": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "lastExecutionTime": { "type": "string", "format": "date-time", "nullable": true }, "lastStartTime": { "type": "string", "format": "date-time", "nullable": true }, "trigger": { "$ref": "#/components/schemas/CommandTrigger" }, "suppressMessages": { "type": "boolean" }, "clientUserAgent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommandPriority": { "enum": [ "normal", "high", "low" ], "type": "string" }, "CommandResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "commandName": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "body": { "$ref": "#/components/schemas/Command" }, "priority": { "$ref": "#/components/schemas/CommandPriority" }, "status": { "$ref": "#/components/schemas/CommandStatus" }, "result": { "$ref": "#/components/schemas/CommandResult" }, "queued": { "type": "string", "format": "date-time" }, "started": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "duration": { "$ref": "#/components/schemas/TimeSpan" }, "exception": { "type": "string", "nullable": true }, "trigger": { "$ref": "#/components/schemas/CommandTrigger" }, "clientUserAgent": { "type": "string", "nullable": true }, "stateChangeTime": { "type": "string", "format": "date-time", "nullable": true }, "sendUpdatesToClient": { "type": "boolean" }, "updateScheduledTask": { "type": "boolean" }, "lastExecutionTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CommandResult": { "enum": [ "unknown", "successful", "unsuccessful" ], "type": "string" }, "CommandStatus": { "enum": [ "queued", "started", "completed", "failed", "aborted", "cancelled", "orphaned" ], "type": "string" }, "CommandTrigger": { "enum": [ "unspecified", "manual", "scheduled" ], "type": "string" }, "CustomFilterResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "nullable": true } }, "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": { "enum": [ "sqLite", "postgreSQL" ], "type": "string" }, "DelayProfileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "enableUsenet": { "type": "boolean" }, "enableTorrent": { "type": "boolean" }, "preferredProtocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "usenetDelay": { "type": "integer", "format": "int32" }, "torrentDelay": { "type": "integer", "format": "int32" }, "bypassIfHighestQuality": { "type": "boolean" }, "bypassIfAboveCustomFormatScore": { "type": "boolean" }, "minimumCustomFormatScore": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DiskSpaceResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "freeSpace": { "type": "integer", "format": "int64" }, "totalSpace": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DownloadClientConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "downloadClientWorkingFolders": { "type": "string", "nullable": true }, "enableCompletedDownloadHandling": { "type": "boolean" }, "autoRedownloadFailed": { "type": "boolean" } }, "additionalProperties": false }, "DownloadClientResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "implementationName": { "type": "string", "nullable": true }, "implementation": { "type": "string", "nullable": true }, "configContract": { "type": "string", "nullable": true }, "infoLink": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/ProviderMessage" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadClientResource" }, "nullable": true }, "enable": { "type": "boolean" }, "protocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "priority": { "type": "integer", "format": "int32" }, "removeCompletedDownloads": { "type": "boolean" }, "removeFailedDownloads": { "type": "boolean" } }, "additionalProperties": false }, "DownloadProtocol": { "enum": [ "unknown", "usenet", "torrent" ], "type": "string" }, "EntityHistoryEventType": { "enum": [ "unknown", "grabbed", "artistFolderImported", "trackFileImported", "downloadFailed", "trackFileDeleted", "trackFileRenamed", "albumImportIncomplete", "downloadImported", "trackFileRetagged", "downloadIgnored" ], "type": "string" }, "Field": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "helpText": { "type": "string", "nullable": true }, "helpLink": { "type": "string", "nullable": true }, "value": { "nullable": true }, "type": { "type": "string", "nullable": true }, "advanced": { "type": "boolean" }, "selectOptions": { "type": "array", "items": { "$ref": "#/components/schemas/SelectOption" }, "nullable": true }, "selectOptionsProviderAction": { "type": "string", "nullable": true }, "section": { "type": "string", "nullable": true }, "hidden": { "type": "string", "nullable": true }, "placeholder": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileDateType": { "enum": [ "none", "albumReleaseDate" ], "type": "string" }, "HealthCheckResult": { "enum": [ "ok", "notice", "warning", "error" ], "type": "string" }, "HealthResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "source": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/HealthCheckResult" }, "message": { "type": "string", "nullable": true }, "wikiUrl": { "$ref": "#/components/schemas/HttpUri" } }, "additionalProperties": false }, "HistoryResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "trackId": { "type": "integer", "format": "int32" }, "sourceTitle": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "customFormats": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFormatResource" }, "nullable": true }, "qualityCutoffNotMet": { "type": "boolean" }, "date": { "type": "string", "format": "date-time" }, "downloadId": { "type": "string", "nullable": true }, "eventType": { "$ref": "#/components/schemas/EntityHistoryEventType" }, "data": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "album": { "$ref": "#/components/schemas/AlbumResource" }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "track": { "$ref": "#/components/schemas/TrackResource" } }, "additionalProperties": false }, "HistoryResourcePagingResource": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "sortKey": { "type": "string", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/PagingResourceFilter" }, "nullable": true }, "totalRecords": { "type": "integer", "format": "int32" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" }, "nullable": true } }, "additionalProperties": false }, "HostConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "bindAddress": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "sslPort": { "type": "integer", "format": "int32" }, "enableSsl": { "type": "boolean" }, "launchBrowser": { "type": "boolean" }, "authenticationMethod": { "$ref": "#/components/schemas/AuthenticationType" }, "analyticsEnabled": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "logLevel": { "type": "string", "nullable": true }, "consoleLogLevel": { "type": "string", "nullable": true }, "branch": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "sslCertPath": { "type": "string", "nullable": true }, "sslCertPassword": { "type": "string", "nullable": true }, "urlBase": { "type": "string", "nullable": true }, "instanceName": { "type": "string", "nullable": true }, "applicationUrl": { "type": "string", "nullable": true }, "updateAutomatically": { "type": "boolean" }, "updateMechanism": { "$ref": "#/components/schemas/UpdateMechanism" }, "updateScriptPath": { "type": "string", "nullable": true }, "proxyEnabled": { "type": "boolean" }, "proxyType": { "$ref": "#/components/schemas/ProxyType" }, "proxyHostname": { "type": "string", "nullable": true }, "proxyPort": { "type": "integer", "format": "int32" }, "proxyUsername": { "type": "string", "nullable": true }, "proxyPassword": { "type": "string", "nullable": true }, "proxyBypassFilter": { "type": "string", "nullable": true }, "proxyBypassLocalAddresses": { "type": "boolean" }, "certificateValidation": { "$ref": "#/components/schemas/CertificateValidationType" }, "backupFolder": { "type": "string", "nullable": true }, "backupInterval": { "type": "integer", "format": "int32" }, "backupRetention": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "HttpUri": { "type": "object", "properties": { "fullUri": { "type": "string", "nullable": true, "readOnly": true }, "scheme": { "type": "string", "nullable": true, "readOnly": true }, "host": { "type": "string", "nullable": true, "readOnly": true }, "port": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "path": { "type": "string", "nullable": true, "readOnly": true }, "query": { "type": "string", "nullable": true, "readOnly": true }, "fragment": { "type": "string", "nullable": true, "readOnly": true } }, "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": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "foreignId": { "type": "string", "nullable": true }, "artistName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportListMonitorType": { "enum": [ "none", "specificAlbum", "entireArtist" ], "type": "string" }, "ImportListResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "implementationName": { "type": "string", "nullable": true }, "implementation": { "type": "string", "nullable": true }, "configContract": { "type": "string", "nullable": true }, "infoLink": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/ProviderMessage" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/ImportListResource" }, "nullable": true }, "enableAutomaticAdd": { "type": "boolean" }, "shouldMonitor": { "$ref": "#/components/schemas/ImportListMonitorType" }, "shouldMonitorExisting": { "type": "boolean" }, "shouldSearch": { "type": "boolean" }, "rootFolderPath": { "type": "string", "nullable": true }, "monitorNewItems": { "$ref": "#/components/schemas/NewItemMonitorTypes" }, "qualityProfileId": { "type": "integer", "format": "int32" }, "metadataProfileId": { "type": "integer", "format": "int32" }, "listType": { "$ref": "#/components/schemas/ImportListType" }, "listOrder": { "type": "integer", "format": "int32" }, "minRefreshInterval": { "$ref": "#/components/schemas/TimeSpan" } }, "additionalProperties": false }, "ImportListType": { "enum": [ "program", "spotify", "lastFm", "other", "advanced" ], "type": "string" }, "IndexerConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "minimumAge": { "type": "integer", "format": "int32" }, "maximumSize": { "type": "integer", "format": "int32" }, "retention": { "type": "integer", "format": "int32" }, "rssSyncInterval": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IndexerResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "implementationName": { "type": "string", "nullable": true }, "implementation": { "type": "string", "nullable": true }, "configContract": { "type": "string", "nullable": true }, "infoLink": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/ProviderMessage" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/IndexerResource" }, "nullable": true }, "enableRss": { "type": "boolean" }, "enableAutomaticSearch": { "type": "boolean" }, "enableInteractiveSearch": { "type": "boolean" }, "supportsRss": { "type": "boolean" }, "supportsSearch": { "type": "boolean" }, "protocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "priority": { "type": "integer", "format": "int32" }, "downloadClientId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IsoCountry": { "type": "object", "properties": { "twoLetterCode": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "nameLower": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Links": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogFileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "filename": { "type": "string", "nullable": true }, "lastWriteTime": { "type": "string", "format": "date-time" }, "contentsUrl": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "time": { "type": "string", "format": "date-time" }, "exception": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true }, "logger": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogResourcePagingResource": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "sortKey": { "type": "string", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/PagingResourceFilter" }, "nullable": true }, "totalRecords": { "type": "integer", "format": "int32" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/LogResource" }, "nullable": true } }, "additionalProperties": false }, "ManualImportResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "album": { "$ref": "#/components/schemas/AlbumResource" }, "albumReleaseId": { "type": "integer", "format": "int32" }, "tracks": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResource" }, "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "releaseGroup": { "type": "string", "nullable": true }, "qualityWeight": { "type": "integer", "format": "int32" }, "downloadId": { "type": "string", "nullable": true }, "rejections": { "type": "array", "items": { "$ref": "#/components/schemas/Rejection" }, "nullable": true }, "audioTags": { "$ref": "#/components/schemas/ParsedTrackInfo" }, "additionalFile": { "type": "boolean" }, "replaceExistingFiles": { "type": "boolean" }, "disableReleaseSwitching": { "type": "boolean" } }, "additionalProperties": false }, "ManualImportUpdateResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "artistId": { "type": "integer", "format": "int32", "nullable": true }, "albumId": { "type": "integer", "format": "int32", "nullable": true }, "albumReleaseId": { "type": "integer", "format": "int32", "nullable": true }, "tracks": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResource" }, "nullable": true }, "trackIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "releaseGroup": { "type": "string", "nullable": true }, "downloadId": { "type": "string", "nullable": true }, "additionalFile": { "type": "boolean" }, "replaceExistingFiles": { "type": "boolean" }, "disableReleaseSwitching": { "type": "boolean" }, "rejections": { "type": "array", "items": { "$ref": "#/components/schemas/Rejection" }, "nullable": true } }, "additionalProperties": false }, "MediaCover": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "coverType": { "$ref": "#/components/schemas/MediaCoverTypes" }, "extension": { "type": "string", "nullable": true, "readOnly": true }, "remoteUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediaCoverTypes": { "enum": [ "unknown", "poster", "banner", "fanart", "screenshot", "headshot", "cover", "disc", "logo", "clearlogo" ], "type": "string" }, "MediaInfoModel": { "type": "object", "properties": { "audioFormat": { "type": "string", "nullable": true }, "audioBitrate": { "type": "integer", "format": "int32" }, "audioChannels": { "type": "integer", "format": "int32" }, "audioBits": { "type": "integer", "format": "int32" }, "audioSampleRate": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MediaInfoResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "audioChannels": { "type": "number", "format": "double" }, "audioBitRate": { "type": "string", "nullable": true }, "audioCodec": { "type": "string", "nullable": true }, "audioBits": { "type": "string", "nullable": true }, "audioSampleRate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediaManagementConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "autoUnmonitorPreviouslyDownloadedTracks": { "type": "boolean" }, "recycleBin": { "type": "string", "nullable": true }, "recycleBinCleanupDays": { "type": "integer", "format": "int32" }, "downloadPropersAndRepacks": { "$ref": "#/components/schemas/ProperDownloadTypes" }, "createEmptyArtistFolders": { "type": "boolean" }, "deleteEmptyFolders": { "type": "boolean" }, "fileDate": { "$ref": "#/components/schemas/FileDateType" }, "watchLibraryForChanges": { "type": "boolean" }, "rescanAfterRefresh": { "$ref": "#/components/schemas/RescanAfterRefreshType" }, "allowFingerprinting": { "$ref": "#/components/schemas/AllowFingerprinting" }, "setPermissionsLinux": { "type": "boolean" }, "chmodFolder": { "type": "string", "nullable": true }, "chownGroup": { "type": "string", "nullable": true }, "skipFreeSpaceCheckWhenImporting": { "type": "boolean" }, "minimumFreeSpaceWhenImporting": { "type": "integer", "format": "int32" }, "copyUsingHardlinks": { "type": "boolean" }, "importExtraFiles": { "type": "boolean" }, "extraFileExtensions": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Medium": { "type": "object", "properties": { "number": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "format": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediumResource": { "type": "object", "properties": { "mediumNumber": { "type": "integer", "format": "int32" }, "mediumName": { "type": "string", "nullable": true }, "mediumFormat": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Member": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "instrument": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MediaCover" }, "nullable": true } }, "additionalProperties": false }, "MetadataProfile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "primaryAlbumTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilePrimaryAlbumTypeItem" }, "nullable": true }, "secondaryAlbumTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileSecondaryAlbumTypeItem" }, "nullable": true }, "releaseStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileReleaseStatusItem" }, "nullable": true } }, "additionalProperties": false }, "MetadataProfileLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/MetadataProfile" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MetadataProfileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "primaryAlbumTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilePrimaryAlbumTypeItemResource" }, "nullable": true }, "secondaryAlbumTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileSecondaryAlbumTypeItemResource" }, "nullable": true }, "releaseStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileReleaseStatusItemResource" }, "nullable": true } }, "additionalProperties": false }, "MetadataProviderConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "metadataSource": { "type": "string", "nullable": true }, "writeAudioTags": { "$ref": "#/components/schemas/WriteAudioTagsType" }, "scrubAudioTags": { "type": "boolean" } }, "additionalProperties": false }, "MetadataResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "implementationName": { "type": "string", "nullable": true }, "implementation": { "type": "string", "nullable": true }, "configContract": { "type": "string", "nullable": true }, "infoLink": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/ProviderMessage" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataResource" }, "nullable": true }, "enable": { "type": "boolean" } }, "additionalProperties": false }, "MonitorTypes": { "enum": [ "all", "future", "missing", "existing", "latest", "first", "none", "unknown" ], "type": "string" }, "MonitoringOptions": { "type": "object", "properties": { "monitor": { "$ref": "#/components/schemas/MonitorTypes" }, "albumsToMonitor": { "type": "array", "items": { "type": "string" }, "nullable": true }, "monitored": { "type": "boolean" } }, "additionalProperties": false }, "NamingConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "renameTracks": { "type": "boolean" }, "replaceIllegalCharacters": { "type": "boolean" }, "colonReplacementFormat": { "type": "integer", "format": "int32" }, "standardTrackFormat": { "type": "string", "nullable": true }, "multiDiscTrackFormat": { "type": "string", "nullable": true }, "artistFolderFormat": { "type": "string", "nullable": true }, "includeArtistName": { "type": "boolean" }, "includeAlbumTitle": { "type": "boolean" }, "includeQuality": { "type": "boolean" }, "replaceSpaces": { "type": "boolean" }, "separator": { "type": "string", "nullable": true }, "numberStyle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewItemMonitorTypes": { "enum": [ "all", "none", "new" ], "type": "string" }, "NotificationResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "implementationName": { "type": "string", "nullable": true }, "implementation": { "type": "string", "nullable": true }, "configContract": { "type": "string", "nullable": true }, "infoLink": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/ProviderMessage" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "presets": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" }, "nullable": true }, "link": { "type": "string", "nullable": true }, "onGrab": { "type": "boolean" }, "onReleaseImport": { "type": "boolean" }, "onUpgrade": { "type": "boolean" }, "onRename": { "type": "boolean" }, "onAlbumDelete": { "type": "boolean" }, "onArtistDelete": { "type": "boolean" }, "onHealthIssue": { "type": "boolean" }, "onHealthRestored": { "type": "boolean" }, "onDownloadFailure": { "type": "boolean" }, "onImportFailure": { "type": "boolean" }, "onTrackRetag": { "type": "boolean" }, "onApplicationUpdate": { "type": "boolean" }, "supportsOnGrab": { "type": "boolean" }, "supportsOnReleaseImport": { "type": "boolean" }, "supportsOnUpgrade": { "type": "boolean" }, "supportsOnRename": { "type": "boolean" }, "supportsOnAlbumDelete": { "type": "boolean" }, "supportsOnArtistDelete": { "type": "boolean" }, "supportsOnHealthIssue": { "type": "boolean" }, "supportsOnHealthRestored": { "type": "boolean" }, "includeHealthWarnings": { "type": "boolean" }, "supportsOnDownloadFailure": { "type": "boolean" }, "supportsOnImportFailure": { "type": "boolean" }, "supportsOnTrackRetag": { "type": "boolean" }, "supportsOnApplicationUpdate": { "type": "boolean" }, "testCommand": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PagingResourceFilter": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParseResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "parsedAlbumInfo": { "$ref": "#/components/schemas/ParsedAlbumInfo" }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "albums": { "type": "array", "items": { "$ref": "#/components/schemas/AlbumResource" }, "nullable": true } }, "additionalProperties": false }, "ParsedAlbumInfo": { "type": "object", "properties": { "albumTitle": { "type": "string", "nullable": true }, "artistName": { "type": "string", "nullable": true }, "artistTitleInfo": { "$ref": "#/components/schemas/ArtistTitleInfo" }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "releaseDate": { "type": "string", "nullable": true }, "discography": { "type": "boolean" }, "discographyStart": { "type": "integer", "format": "int32" }, "discographyEnd": { "type": "integer", "format": "int32" }, "releaseGroup": { "type": "string", "nullable": true }, "releaseHash": { "type": "string", "nullable": true }, "releaseVersion": { "type": "string", "nullable": true }, "releaseTitle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParsedTrackInfo": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "cleanTitle": { "type": "string", "nullable": true }, "artistTitle": { "type": "string", "nullable": true }, "albumTitle": { "type": "string", "nullable": true }, "artistTitleInfo": { "$ref": "#/components/schemas/ArtistTitleInfo" }, "artistMBId": { "type": "string", "nullable": true }, "albumMBId": { "type": "string", "nullable": true }, "releaseMBId": { "type": "string", "nullable": true }, "recordingMBId": { "type": "string", "nullable": true }, "trackMBId": { "type": "string", "nullable": true }, "discNumber": { "type": "integer", "format": "int32" }, "discCount": { "type": "integer", "format": "int32" }, "country": { "$ref": "#/components/schemas/IsoCountry" }, "year": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true }, "catalogNumber": { "type": "string", "nullable": true }, "disambiguation": { "type": "string", "nullable": true }, "duration": { "$ref": "#/components/schemas/TimeSpan" }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "mediaInfo": { "$ref": "#/components/schemas/MediaInfoModel" }, "trackNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "releaseGroup": { "type": "string", "nullable": true }, "releaseHash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PingResource": { "type": "object", "properties": { "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PrimaryAlbumType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "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": { "type": "object", "properties": { "primaryAlbumType": { "$ref": "#/components/schemas/PrimaryAlbumType" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProfilePrimaryAlbumTypeItemResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "albumType": { "$ref": "#/components/schemas/PrimaryAlbumType" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProfileReleaseStatusItem": { "type": "object", "properties": { "releaseStatus": { "$ref": "#/components/schemas/ReleaseStatus" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProfileReleaseStatusItemResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "releaseStatus": { "$ref": "#/components/schemas/ReleaseStatus" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProfileSecondaryAlbumTypeItem": { "type": "object", "properties": { "secondaryAlbumType": { "$ref": "#/components/schemas/SecondaryAlbumType" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProfileSecondaryAlbumTypeItemResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "albumType": { "$ref": "#/components/schemas/SecondaryAlbumType" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ProperDownloadTypes": { "enum": [ "preferAndUpgrade", "doNotUpgrade", "doNotPrefer" ], "type": "string" }, "ProviderMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ProviderMessageType" } }, "additionalProperties": false }, "ProviderMessageType": { "enum": [ "info", "warning", "error" ], "type": "string" }, "ProxyType": { "enum": [ "http", "socks4", "socks5" ], "type": "string" }, "Quality": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "QualityDefinitionResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "quality": { "$ref": "#/components/schemas/Quality" }, "title": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "minSize": { "type": "number", "format": "double", "nullable": true }, "maxSize": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "QualityModel": { "type": "object", "properties": { "quality": { "$ref": "#/components/schemas/Quality" }, "revision": { "$ref": "#/components/schemas/Revision" } }, "additionalProperties": false }, "QualityProfile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "upgradeAllowed": { "type": "boolean" }, "cutoff": { "type": "integer", "format": "int32" }, "minFormatScore": { "type": "integer", "format": "int32" }, "cutoffFormatScore": { "type": "integer", "format": "int32" }, "formatItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileFormatItem" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileQualityItem" }, "nullable": true } }, "additionalProperties": false }, "QualityProfileLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/QualityProfile" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "QualityProfileQualityItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/Quality" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileQualityItem" }, "nullable": true }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "QualityProfileQualityItemResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/Quality" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileQualityItemResource" }, "nullable": true }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "QualityProfileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "upgradeAllowed": { "type": "boolean" }, "cutoff": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/QualityProfileQualityItemResource" }, "nullable": true }, "minFormatScore": { "type": "integer", "format": "int32" }, "cutoffFormatScore": { "type": "integer", "format": "int32" }, "formatItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileFormatItemResource" }, "nullable": true } }, "additionalProperties": false }, "QueueBulkResource": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "QueueResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32", "nullable": true }, "albumId": { "type": "integer", "format": "int32", "nullable": true }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "album": { "$ref": "#/components/schemas/AlbumResource" }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "customFormats": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFormatResource" }, "nullable": true }, "size": { "type": "number", "format": "double" }, "title": { "type": "string", "nullable": true }, "sizeleft": { "type": "number", "format": "double" }, "timeleft": { "$ref": "#/components/schemas/TimeSpan" }, "estimatedCompletionTime": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "trackedDownloadStatus": { "$ref": "#/components/schemas/TrackedDownloadStatus" }, "trackedDownloadState": { "$ref": "#/components/schemas/TrackedDownloadState" }, "statusMessages": { "type": "array", "items": { "$ref": "#/components/schemas/TrackedDownloadStatusMessage" }, "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "downloadId": { "type": "string", "nullable": true }, "protocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "downloadClient": { "type": "string", "nullable": true }, "indexer": { "type": "string", "nullable": true }, "outputPath": { "type": "string", "nullable": true }, "downloadForced": { "type": "boolean" } }, "additionalProperties": false }, "QueueResourcePagingResource": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "sortKey": { "type": "string", "nullable": true }, "sortDirection": { "$ref": "#/components/schemas/SortDirection" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/PagingResourceFilter" }, "nullable": true }, "totalRecords": { "type": "integer", "format": "int32" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/QueueResource" }, "nullable": true } }, "additionalProperties": false }, "QueueStatusResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "unknownCount": { "type": "integer", "format": "int32" }, "errors": { "type": "boolean" }, "warnings": { "type": "boolean" }, "unknownErrors": { "type": "boolean" }, "unknownWarnings": { "type": "boolean" } }, "additionalProperties": false }, "Ratings": { "type": "object", "properties": { "votes": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Rejection": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/RejectionType" } }, "additionalProperties": false }, "RejectionType": { "enum": [ "permanent", "temporary" ], "type": "string" }, "ReleaseProfileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "required": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ignored": { "type": "array", "items": { "type": "string" }, "nullable": true }, "indexerId": { "type": "integer", "format": "int32" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "ReleaseResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "guid": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "qualityWeight": { "type": "integer", "format": "int32" }, "age": { "type": "integer", "format": "int32" }, "ageHours": { "type": "number", "format": "double" }, "ageMinutes": { "type": "number", "format": "double" }, "size": { "type": "integer", "format": "int64" }, "indexerId": { "type": "integer", "format": "int32" }, "indexer": { "type": "string", "nullable": true }, "releaseGroup": { "type": "string", "nullable": true }, "subGroup": { "type": "string", "nullable": true }, "releaseHash": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "discography": { "type": "boolean" }, "sceneSource": { "type": "boolean" }, "airDate": { "type": "string", "nullable": true }, "artistName": { "type": "string", "nullable": true }, "albumTitle": { "type": "string", "nullable": true }, "approved": { "type": "boolean" }, "temporarilyRejected": { "type": "boolean" }, "rejected": { "type": "boolean" }, "rejections": { "type": "array", "items": { "type": "string" }, "nullable": true }, "publishDate": { "type": "string", "format": "date-time" }, "commentUrl": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string", "nullable": true }, "infoUrl": { "type": "string", "nullable": true }, "downloadAllowed": { "type": "boolean" }, "releaseWeight": { "type": "integer", "format": "int32" }, "customFormats": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFormatResource" }, "nullable": true }, "customFormatScore": { "type": "integer", "format": "int32" }, "magnetUrl": { "type": "string", "nullable": true }, "infoHash": { "type": "string", "nullable": true }, "seeders": { "type": "integer", "format": "int32", "nullable": true }, "leechers": { "type": "integer", "format": "int32", "nullable": true }, "protocol": { "$ref": "#/components/schemas/DownloadProtocol" }, "artistId": { "type": "integer", "format": "int32", "nullable": true }, "albumId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReleaseStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RemotePathMappingResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "host": { "type": "string", "nullable": true }, "remotePath": { "type": "string", "nullable": true }, "localPath": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenameTrackResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "trackNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "trackFileId": { "type": "integer", "format": "int32" }, "existingPath": { "type": "string", "nullable": true }, "newPath": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RescanAfterRefreshType": { "enum": [ "always", "afterManual", "never" ], "type": "string" }, "RetagTrackResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "trackNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "trackFileId": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/TagDifference" }, "nullable": true } }, "additionalProperties": false }, "Revision": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "real": { "type": "integer", "format": "int32" }, "isRepack": { "type": "boolean" } }, "additionalProperties": false }, "RootFolderResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "defaultMetadataProfileId": { "type": "integer", "format": "int32" }, "defaultQualityProfileId": { "type": "integer", "format": "int32" }, "defaultMonitorOption": { "$ref": "#/components/schemas/MonitorTypes" }, "defaultNewItemMonitorOption": { "$ref": "#/components/schemas/NewItemMonitorTypes" }, "defaultTags": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "accessible": { "type": "boolean" }, "freeSpace": { "type": "integer", "format": "int64", "nullable": true }, "totalSpace": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "RuntimeMode": { "enum": [ "console", "service", "tray" ], "type": "string" }, "SecondaryAlbumType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SelectOption": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "hint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortDirection": { "enum": [ "default", "ascending", "descending" ], "type": "string" }, "SystemResource": { "type": "object", "properties": { "appName": { "type": "string", "nullable": true }, "instanceName": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildTime": { "type": "string", "format": "date-time" }, "isDebug": { "type": "boolean" }, "isProduction": { "type": "boolean" }, "isAdmin": { "type": "boolean" }, "isUserInteractive": { "type": "boolean" }, "startupPath": { "type": "string", "nullable": true }, "appData": { "type": "string", "nullable": true }, "osName": { "type": "string", "nullable": true }, "osVersion": { "type": "string", "nullable": true }, "isNetCore": { "type": "boolean" }, "isLinux": { "type": "boolean" }, "isOsx": { "type": "boolean" }, "isWindows": { "type": "boolean" }, "isDocker": { "type": "boolean" }, "mode": { "$ref": "#/components/schemas/RuntimeMode" }, "branch": { "type": "string", "nullable": true }, "databaseType": { "$ref": "#/components/schemas/DatabaseType" }, "databaseVersion": { "$ref": "#/components/schemas/Version" }, "authentication": { "$ref": "#/components/schemas/AuthenticationType" }, "migrationVersion": { "type": "integer", "format": "int32" }, "urlBase": { "type": "string", "nullable": true }, "runtimeVersion": { "$ref": "#/components/schemas/Version" }, "runtimeName": { "type": "string", "nullable": true }, "startTime": { "type": "string", "format": "date-time" }, "packageVersion": { "type": "string", "nullable": true }, "packageAuthor": { "type": "string", "nullable": true }, "packageUpdateMechanism": { "$ref": "#/components/schemas/UpdateMechanism" }, "packageUpdateMechanismMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TagDetailsResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true }, "delayProfileIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "importListIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "notificationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "restrictionIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "indexerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "artistIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "TagDifference": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "oldValue": { "type": "string", "nullable": true }, "newValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TagResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "taskName": { "type": "string", "nullable": true }, "interval": { "type": "integer", "format": "int32" }, "lastExecution": { "type": "string", "format": "date-time" }, "lastStartTime": { "type": "string", "format": "date-time" }, "nextExecution": { "type": "string", "format": "date-time" }, "lastDuration": { "$ref": "#/components/schemas/TimeSpan" } }, "additionalProperties": false }, "TimeSpan": { "type": "object", "properties": { "ticks": { "type": "integer", "format": "int64" }, "days": { "type": "integer", "format": "int32", "readOnly": true }, "hours": { "type": "integer", "format": "int32", "readOnly": true }, "milliseconds": { "type": "integer", "format": "int32", "readOnly": true }, "minutes": { "type": "integer", "format": "int32", "readOnly": true }, "seconds": { "type": "integer", "format": "int32", "readOnly": true }, "totalDays": { "type": "number", "format": "double", "readOnly": true }, "totalHours": { "type": "number", "format": "double", "readOnly": true }, "totalMilliseconds": { "type": "number", "format": "double", "readOnly": true }, "totalMinutes": { "type": "number", "format": "double", "readOnly": true }, "totalSeconds": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "Track": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "foreignTrackId": { "type": "string", "nullable": true }, "oldForeignTrackIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "foreignRecordingId": { "type": "string", "nullable": true }, "oldForeignRecordingIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "albumReleaseId": { "type": "integer", "format": "int32" }, "artistMetadataId": { "type": "integer", "format": "int32" }, "trackNumber": { "type": "string", "nullable": true }, "absoluteTrackNumber": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "explicit": { "type": "boolean" }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "mediumNumber": { "type": "integer", "format": "int32" }, "trackFileId": { "type": "integer", "format": "int32" }, "hasFile": { "type": "boolean", "readOnly": true }, "albumRelease": { "$ref": "#/components/schemas/AlbumReleaseLazyLoaded" }, "artistMetadata": { "$ref": "#/components/schemas/ArtistMetadataLazyLoaded" }, "trackFile": { "$ref": "#/components/schemas/TrackFileLazyLoaded" }, "artist": { "$ref": "#/components/schemas/ArtistLazyLoaded" }, "albumId": { "type": "integer", "format": "int32" }, "album": { "$ref": "#/components/schemas/Album" } }, "additionalProperties": false }, "TrackFile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "modified": { "type": "string", "format": "date-time" }, "dateAdded": { "type": "string", "format": "date-time" }, "originalFilePath": { "type": "string", "nullable": true }, "sceneName": { "type": "string", "nullable": true }, "releaseGroup": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "mediaInfo": { "$ref": "#/components/schemas/MediaInfoModel" }, "albumId": { "type": "integer", "format": "int32" }, "tracks": { "$ref": "#/components/schemas/TrackListLazyLoaded" }, "artist": { "$ref": "#/components/schemas/ArtistLazyLoaded" }, "album": { "$ref": "#/components/schemas/AlbumLazyLoaded" } }, "additionalProperties": false }, "TrackFileLazyLoaded": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/TrackFile" }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TrackFileListResource": { "type": "object", "properties": { "trackFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "sceneName": { "type": "string", "nullable": true }, "releaseGroup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TrackFileResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "dateAdded": { "type": "string", "format": "date-time" }, "sceneName": { "type": "string", "nullable": true }, "releaseGroup": { "type": "string", "nullable": true }, "quality": { "$ref": "#/components/schemas/QualityModel" }, "qualityWeight": { "type": "integer", "format": "int32" }, "mediaInfo": { "$ref": "#/components/schemas/MediaInfoResource" }, "qualityCutoffNotMet": { "type": "boolean" }, "audioTags": { "$ref": "#/components/schemas/ParsedTrackInfo" } }, "additionalProperties": false }, "TrackListLazyLoaded": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Track" }, "nullable": true, "readOnly": true }, "isLoaded": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TrackResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "artistId": { "type": "integer", "format": "int32" }, "foreignTrackId": { "type": "string", "nullable": true }, "foreignRecordingId": { "type": "string", "nullable": true }, "trackFileId": { "type": "integer", "format": "int32" }, "albumId": { "type": "integer", "format": "int32" }, "explicit": { "type": "boolean" }, "absoluteTrackNumber": { "type": "integer", "format": "int32" }, "trackNumber": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "trackFile": { "$ref": "#/components/schemas/TrackFileResource" }, "mediumNumber": { "type": "integer", "format": "int32" }, "hasFile": { "type": "boolean" }, "artist": { "$ref": "#/components/schemas/ArtistResource" }, "ratings": { "$ref": "#/components/schemas/Ratings" }, "grabbed": { "type": "boolean" } }, "additionalProperties": false }, "TrackedDownloadState": { "enum": [ "downloading", "downloadFailed", "downloadFailedPending", "importPending", "importing", "importFailed", "imported", "ignored" ], "type": "string" }, "TrackedDownloadStatus": { "enum": [ "ok", "warning", "error" ], "type": "string" }, "TrackedDownloadStatusMessage": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UiConfigResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstDayOfWeek": { "type": "integer", "format": "int32" }, "calendarWeekColumnHeader": { "type": "string", "nullable": true }, "shortDateFormat": { "type": "string", "nullable": true }, "longDateFormat": { "type": "string", "nullable": true }, "timeFormat": { "type": "string", "nullable": true }, "showRelativeDates": { "type": "boolean" }, "enableColorImpairedMode": { "type": "boolean" }, "uiLanguage": { "type": "integer", "format": "int32" }, "expandAlbumByDefault": { "type": "boolean" }, "expandSingleByDefault": { "type": "boolean" }, "expandEPByDefault": { "type": "boolean" }, "expandBroadcastByDefault": { "type": "boolean" }, "expandOtherByDefault": { "type": "boolean" }, "theme": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Version" }, "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 }, "Version": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32", "readOnly": true }, "minor": { "type": "integer", "format": "int32", "readOnly": true }, "build": { "type": "integer", "format": "int32", "readOnly": true }, "revision": { "type": "integer", "format": "int32", "readOnly": true }, "majorRevision": { "type": "integer", "format": "int32", "readOnly": true }, "minorRevision": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "WriteAudioTagsType": { "enum": [ "no", "newFiles", "allFiles", "sync" ], "type": "string" } }, "securitySchemes": { "X-Api-Key": { "type": "apiKey", "description": "Apikey passed as header", "name": "X-Api-Key", "in": "header" }, "apikey": { "type": "apiKey", "description": "Apikey passed as header", "name": "apikey", "in": "query" } } }, "security": [ { "X-Api-Key": [ ] }, { "apikey": [ ] } ] }