diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index 4aa450f51..94193ed40 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -955,6 +955,60 @@ stages:
cliProjectVersion: '$(readarrVersion)'
cliSources: './frontend'
- task: SonarCloudAnalyze@1
+
+ - job: Api_Docs
+ displayName: API Docs
+ dependsOn: Prepare
+ condition: |
+ and
+ (
+ and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/develop')),
+ and(succeeded(), eq(dependencies.Prepare.outputs['setVar.backendNotUpdated'], '0'))
+ )
+
+ pool:
+ vmImage: ${{ variables.windowsImage }}
+
+ steps:
+ - task: UseDotNet@2
+ displayName: 'Install .net core'
+ inputs:
+ version: $(dotnetVersion)
+ - checkout: self
+ submodules: true
+ persistCredentials: true
+ fetchDepth: 1
+ - bash: ./docs.sh Windows
+ displayName: Create openapi.json
+ - bash: |
+ git config --global user.email "development@lidarr.audio"
+ git config --global user.name "Servarr"
+ git checkout -b api-docs
+ git add .
+ git status
+ if git status | grep modified
+ then
+ git commit -am 'Automated API Docs update'
+ git push -f --set-upstream origin api-docs
+ curl -X POST -H "Authorization: token ${GITHUBTOKEN}" -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/readarr/readarr/pulls -d '{"head":"api-docs","base":"develop","title":"Update API docs"}'
+ else
+ echo "No changes since last run"
+ fi
+ displayName: Commit API Doc Change
+ continueOnError: true
+ env:
+ GITHUBTOKEN: $(githubToken)
+ - task: CopyFiles@2
+ displayName: 'Copy openapi.json to: $(Build.ArtifactStagingDirectory)'
+ inputs:
+ SourceFolder: '$(Build.SourcesDirectory)'
+ Contents: |
+ **/*openapi.json
+ TargetFolder: '$(Build.ArtifactStagingDirectory)/api_docs'
+ - publish: $(Build.ArtifactStagingDirectory)/api_docs
+ artifact: 'APIDocs'
+ displayName: Publish API Docs Bundle
+ condition: and(succeeded(), eq(variables['System.JobAttempt'], '1'))
- job: Analyze_Backend
displayName: Backend
diff --git a/docs.sh b/docs.sh
new file mode 100644
index 000000000..e9a54b2eb
--- /dev/null
+++ b/docs.sh
@@ -0,0 +1,38 @@
+PLATFORM=$1
+
+if [ "$PLATFORM" = "Windows" ]; then
+ RUNTIME="win-x64"
+elif [ "$PLATFORM" = "Linux" ]; then
+ WHERE="linux-x64"
+elif [ "$PLATFORM" = "Mac" ]; then
+ WHERE="osx-x64"
+else
+ echo "Platform must be provided as first arguement: Windows, Linux or Mac"
+ exit 1
+fi
+
+outputFolder='_output'
+testPackageFolder='_tests'
+
+rm -rf $outputFolder
+rm -rf $testPackageFolder
+
+slnFile=src/Readarr.sln
+
+platform=Posix
+
+dotnet clean $slnFile -c Debug
+dotnet clean $slnFile -c Release
+
+dotnet msbuild -restore $slnFile -p:Configuration=Debug -p:Platform=$platform -p:RuntimeIdentifiers=$RUNTIME -t:PublishAllRids
+
+dotnet new tool-manifest
+dotnet tool install --version 6.3.0 Swashbuckle.AspNetCore.Cli
+
+dotnet tool run swagger tofile --output ./src/Readarr.Api.V1/openapi.json "$outputFolder/net6.0/$RUNTIME/Readarr.console.dll" v1 &
+
+sleep 45
+
+kill %1
+
+exit 0
\ No newline at end of file
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
index ec7637d5c..0393025f9 100644
--- a/src/Directory.Packages.props
+++ b/src/Directory.Packages.props
@@ -45,6 +45,7 @@
+
diff --git a/src/NzbDrone.Host/Readarr.Host.csproj b/src/NzbDrone.Host/Readarr.Host.csproj
index 0a34ef2ea..92798ce17 100644
--- a/src/NzbDrone.Host/Readarr.Host.csproj
+++ b/src/NzbDrone.Host/Readarr.Host.csproj
@@ -6,6 +6,7 @@
+
diff --git a/src/NzbDrone.Host/Startup.cs b/src/NzbDrone.Host/Startup.cs
index c8a837210..6fb3eef0f 100644
--- a/src/NzbDrone.Host/Startup.cs
+++ b/src/NzbDrone.Host/Startup.cs
@@ -9,6 +9,7 @@ using Microsoft.AspNetCore.HttpOverrides;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
+using Microsoft.OpenApi.Models;
using NLog.Extensions.Logging;
using NzbDrone.Common.EnvironmentInfo;
using NzbDrone.Common.Instrumentation;
@@ -92,6 +93,78 @@ namespace NzbDrone.Host
})
.AddControllersAsServices();
+ services.AddSwaggerGen(c =>
+ {
+ c.SwaggerDoc("v1", new OpenApiInfo
+ {
+ Version = "1.0.0",
+ Title = "Readarr",
+ Description = "Readarr API docs",
+ License = new OpenApiLicense
+ {
+ Name = "GPL-3.0",
+ Url = new Uri("https://github.com/Readarr/Readarr/blob/develop/LICENSE")
+ }
+ });
+
+ var apiKeyHeader = new OpenApiSecurityScheme
+ {
+ Name = "X-Api-Key",
+ Type = SecuritySchemeType.ApiKey,
+ Scheme = "apiKey",
+ Description = "Apikey passed as header",
+ In = ParameterLocation.Header,
+ Reference = new OpenApiReference
+ {
+ Type = ReferenceType.SecurityScheme,
+ Id = "X-Api-Key"
+ },
+ };
+
+ c.AddSecurityDefinition("X-Api-Key", apiKeyHeader);
+
+ c.AddSecurityRequirement(new OpenApiSecurityRequirement
+ {
+ { apiKeyHeader, Array.Empty() }
+ });
+
+ var apikeyQuery = new OpenApiSecurityScheme
+ {
+ Name = "apikey",
+ Type = SecuritySchemeType.ApiKey,
+ Scheme = "apiKey",
+ Description = "Apikey passed as header",
+ In = ParameterLocation.Query,
+ Reference = new OpenApiReference
+ {
+ Type = ReferenceType.SecurityScheme,
+ Id = "apikey"
+ },
+ };
+
+ c.AddServer(new OpenApiServer
+ {
+ Url = "{protocol}://{hostpath}",
+ Variables = new Dictionary
+ {
+ { "protocol", new OpenApiServerVariable { Default = "http", Enum = new List { "http", "https" } } },
+ { "hostpath", new OpenApiServerVariable { Default = "localhost:8787" } }
+ }
+ });
+
+ c.AddSecurityDefinition("apikey", apikeyQuery);
+
+ c.AddSecurityRequirement(new OpenApiSecurityRequirement
+ {
+ { apikeyQuery, Array.Empty() }
+ });
+ });
+
+ services.ConfigureSwaggerGen(options =>
+ {
+ options.CustomSchemaIds(x => x.FullName);
+ });
+
services
.AddSignalR()
.AddJsonProtocol(options =>
@@ -188,6 +261,15 @@ namespace NzbDrone.Host
app.UseWebSockets();
+ // Enable middleware to serve generated Swagger as a JSON endpoint.
+ if (BuildInfo.IsDebug)
+ {
+ app.UseSwagger(c =>
+ {
+ c.RouteTemplate = "docs/{documentName}/openapi.json";
+ });
+ }
+
app.UseEndpoints(x =>
{
x.MapHub("/signalr/messages").RequireAuthorization("SignalR");
diff --git a/src/Readarr.Api.V1/swagger.json b/src/Readarr.Api.V1/openapi.json
similarity index 70%
rename from src/Readarr.Api.V1/swagger.json
rename to src/Readarr.Api.V1/openapi.json
index 223b78020..c1cd5a66c 100644
--- a/src/Readarr.Api.V1/swagger.json
+++ b/src/Readarr.Api.V1/openapi.json
@@ -3,9 +3,49 @@
"info": {
"title": "Readarr",
"description": "Readarr API docs",
- "version": "0.1.0"
+ "license": {
+ "name": "GPL-3.0",
+ "url": "https://github.com/Readarr/Readarr/blob/develop/LICENSE"
+ },
+ "version": "1.0.0"
},
+ "servers": [
+ {
+ "url": "{protocol}://{hostpath}",
+ "variables": {
+ "protocol": {
+ "default": "http",
+ "enum": [
+ "http",
+ "https"
+ ]
+ },
+ "hostpath": {
+ "default": "localhost:8787"
+ }
+ }
+ }
+ ],
"paths": {
+ "/api": {
+ "get": {
+ "tags": [
+ "ApiInfo"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Http.ApiInfoResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/login": {
"post": {
"tags": [
@@ -80,45 +120,91 @@
}
}
},
- "/api/v1/author/{id}": {
+ "/api/v1/author": {
"get": {
"tags": [
"Author"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ }
+ }
}
}
+ }
+ },
+ "post": {
+ "tags": [
+ "Author"
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/author/{id}": {
"put": {
"tags": [
"Author"
@@ -137,17 +223,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
}
}
@@ -158,17 +244,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
}
}
@@ -195,85 +281,39 @@
"description": "Success"
}
}
- }
- },
- "/api/v1/author": {
+ },
"get": {
"tags": [
"Author"
],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "text/plain": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- }
- },
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- }
- },
- "text/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- }
- },
- "post": {
- "tags": [
- "Author"
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/AuthorResource"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
}
}
@@ -290,17 +330,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
}
}
@@ -319,17 +359,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/AuthorEditorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorEditorResource"
}
}
}
@@ -375,7 +415,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BackupResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Backup.BackupResource"
}
}
},
@@ -383,7 +423,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BackupResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Backup.BackupResource"
}
}
},
@@ -391,7 +431,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BackupResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Backup.BackupResource"
}
}
}
@@ -458,10 +498,10 @@
}
}
},
- "/api/v1/blacklist": {
+ "/api/v1/blocklist": {
"get": {
"tags": [
- "Blacklist"
+ "Blocklist"
],
"responses": {
"200": {
@@ -469,17 +509,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BlacklistResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Blocklist.BlocklistResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BlacklistResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Blocklist.BlocklistResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BlacklistResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Blocklist.BlocklistResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
@@ -487,10 +527,10 @@
}
}
},
- "/api/v1/blacklist/{id}": {
+ "/api/v1/blocklist/{id}": {
"delete": {
"tags": [
- "Blacklist"
+ "Blocklist"
],
"parameters": [
{
@@ -510,26 +550,26 @@
}
}
},
- "/api/v1/blacklist/bulk": {
+ "/api/v1/blocklist/bulk": {
"delete": {
"tags": [
- "Blacklist"
+ "Blocklist"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BlacklistBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Blocklist.BlocklistBulkResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BlacklistBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Blocklist.BlocklistBulkResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BlacklistBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Blocklist.BlocklistBulkResource"
}
}
}
@@ -590,7 +630,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
},
@@ -598,7 +638,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
},
@@ -606,7 +646,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -622,17 +662,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -643,17 +683,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -661,6 +701,29 @@
}
}
},
+ "/api/v1/book/{id}/overview": {
+ "get": {
+ "tags": [
+ "Book"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
"/api/v1/book/{id}": {
"put": {
"tags": [
@@ -680,17 +743,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -701,17 +764,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -760,17 +823,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -787,17 +850,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BooksMonitoredResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BooksMonitoredResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BooksMonitoredResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BooksMonitoredResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BooksMonitoredResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BooksMonitoredResource"
}
}
}
@@ -809,116 +872,59 @@
}
}
},
- "/api/v1/bookfile/{id}": {
- "get": {
- "tags": [
- "BookFile"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- }
- }
- }
- }
- },
+ "/api/v1/book/editor": {
"put": {
"tags": [
- "BookFile"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
+ "BookEditor"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
}
}
}
},
"responses": {
"200": {
- "description": "Success",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/BookFileResource"
- }
- }
- }
+ "description": "Success"
}
}
},
"delete": {
"tags": [
- "BookFile"
+ "BookEditor"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookEditorResource"
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Success"
@@ -978,7 +984,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
}
}
},
@@ -986,7 +992,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
}
}
},
@@ -994,7 +1000,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
}
}
}
@@ -1003,26 +1009,143 @@
}
}
},
- "/api/v1/bookfile/editor": {
+ "/api/v1/bookfile/{id}": {
"put": {
"tags": [
"BookFile"
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BookFileListResource"
- }
- },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BookFile"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "BookFile"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/bookfile/editor": {
+ "put": {
+ "tags": [
+ "BookFile"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
+ }
+ },
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookFileListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookFileListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
}
}
}
@@ -1043,17 +1166,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookFileListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookFileListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookFileListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.BookFileListResource"
}
}
}
@@ -1095,17 +1218,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookshelfResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Bookshelf.BookshelfResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookshelfResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Bookshelf.BookshelfResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/BookshelfResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Bookshelf.BookshelfResource"
}
}
}
@@ -1164,7 +1287,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
},
@@ -1172,7 +1295,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
},
@@ -1180,7 +1303,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -1211,17 +1334,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -1229,7 +1352,7 @@
}
}
},
- "/api/v1/calendar/readarr.ics": {
+ "/feed/v1/calendar/readarr.ics": {
"get": {
"tags": [
"CalendarFeed"
@@ -1277,67 +1400,6 @@
}
}
},
- "/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": [
@@ -1347,17 +1409,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
}
@@ -1368,17 +1430,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
}
@@ -1397,7 +1459,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
},
@@ -1405,7 +1467,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
},
@@ -1413,7 +1475,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CommandResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
}
@@ -1422,10 +1484,10 @@
}
}
},
- "/api/v1/customfilter/{id}": {
- "get": {
+ "/api/v1/command/{id}": {
+ "delete": {
"tags": [
- "CustomFilter"
+ "Command"
],
"parameters": [
{
@@ -1440,30 +1502,13 @@
],
"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"
- }
- }
- }
+ "description": "Success"
}
}
},
- "put": {
+ "get": {
"tags": [
- "CustomFilter"
+ "Command"
],
"parameters": [
{
@@ -1471,72 +1516,33 @@
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
}
}
],
- "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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Commands.CommandResource"
}
}
}
}
}
- },
- "delete": {
- "tags": [
- "CustomFilter"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
}
},
"/api/v1/customfilter": {
@@ -1552,7 +1558,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
},
@@ -1560,7 +1566,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
},
@@ -1568,7 +1574,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
}
@@ -1584,17 +1590,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
}
@@ -1605,17 +1611,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/CustomFilterResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
}
@@ -1623,49 +1629,87 @@
}
}
},
- "/api/v1/wanted/cutoff": {
- "get": {
+ "/api/v1/customfilter/{id}": {
+ "put": {
"tags": [
- "Cutoff"
+ "CustomFilter"
],
"parameters": [
{
- "name": "includeAuthor",
- "in": "query",
+ "name": "id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "default": false
+ "type": "string"
}
}
],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
}
}
}
- }
- },
- "/api/v1/wanted/cutoff/{id}": {
+ },
+ "delete": {
+ "tags": [
+ "CustomFilter"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
"get": {
"tags": [
- "Cutoff"
+ "CustomFilter"
],
"parameters": [
{
@@ -1684,17 +1728,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFilters.CustomFilterResource"
}
}
}
@@ -1702,26 +1746,16 @@
}
}
},
- "/api/v1/delayprofile": {
+ "/api/v1/customformat": {
"post": {
"tags": [
- "DelayProfile"
+ "CustomFormat"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
@@ -1732,17 +1766,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
@@ -1751,33 +1785,17 @@
},
"get": {
"tags": [
- "DelayProfile"
+ "CustomFormat"
],
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
@@ -1786,31 +1804,10 @@
}
}
},
- "/api/v1/delayprofile/{id}": {
- "delete": {
- "tags": [
- "DelayProfile"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- },
+ "/api/v1/customformat/{id}": {
"put": {
"tags": [
- "DelayProfile"
+ "CustomFormat"
],
"parameters": [
{
@@ -1826,17 +1823,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
@@ -1847,26 +1834,47 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
}
}
},
+ "delete": {
+ "tags": [
+ "CustomFormat"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
"get": {
"tags": [
- "DelayProfile"
+ "CustomFormat"
],
"parameters": [
{
@@ -1885,17 +1893,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DelayProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
}
}
}
@@ -1903,29 +1911,10 @@
}
}
},
- "/api/v1/delayprofile/reorder/{id}": {
- "put": {
+ "/api/v1/customformat/schema": {
+ "get": {
"tags": [
- "DelayProfile"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "afterId",
- "in": "query",
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
+ "CustomFormat"
],
"responses": {
"200": {
@@ -1934,19 +1923,18 @@
}
}
},
- "/api/v1/config/development/{id}": {
+ "/api/v1/wanted/cutoff": {
"get": {
"tags": [
- "DevelopmentConfig"
+ "Cutoff"
],
"parameters": [
{
- "name": "id",
- "in": "path",
- "required": true,
+ "name": "includeAuthor",
+ "in": "query",
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "boolean",
+ "default": false
}
}
],
@@ -1956,26 +1944,28 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
- },
- "put": {
+ }
+ },
+ "/api/v1/wanted/cutoff/{id}": {
+ "get": {
"tags": [
- "DevelopmentConfig"
+ "Cutoff"
],
"parameters": [
{
@@ -1983,46 +1973,28 @@
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
}
}
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -2030,39 +2002,56 @@
}
}
},
- "/api/v1/config/development": {
- "get": {
+ "/api/v1/delayprofile": {
+ "post": {
"tags": [
- "DevelopmentConfig"
+ "DelayProfile"
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DevelopmentConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
}
}
}
- }
- },
- "/api/v1/diskspace": {
+ },
"get": {
"tags": [
- "DiskSpace"
+ "DelayProfile"
],
"responses": {
"200": {
@@ -2072,7 +2061,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DiskSpaceResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
},
@@ -2080,7 +2069,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DiskSpaceResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
},
@@ -2088,7 +2077,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DiskSpaceResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
}
@@ -2097,10 +2086,10 @@
}
}
},
- "/api/v1/downloadclient/{id}": {
- "get": {
+ "/api/v1/delayprofile/{id}": {
+ "delete": {
"tags": [
- "DownloadClient"
+ "DelayProfile"
],
"parameters": [
{
@@ -2115,30 +2104,13 @@
],
"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"
- }
- }
- }
+ "description": "Success"
}
}
},
"put": {
"tags": [
- "DownloadClient"
+ "DelayProfile"
],
"parameters": [
{
@@ -2154,17 +2126,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
}
@@ -2175,26 +2147,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
}
}
}
},
- "delete": {
+ "get": {
"tags": [
- "DownloadClient"
+ "DelayProfile"
],
"parameters": [
{
@@ -2207,69 +2179,120 @@
}
}
],
- "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"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DownloadClientResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DownloadClientResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Delay.DelayProfileResource"
}
}
}
}
}
- },
- "post": {
+ }
+ },
+ "/api/v1/delayprofile/reorder/{id}": {
+ "put": {
"tags": [
- "DownloadClient"
+ "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/config/development": {
+ "get": {
+ "tags": [
+ "DevelopmentConfig"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/config/development/{id}": {
+ "put": {
+ "tags": [
+ "DevelopmentConfig"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
}
}
@@ -2280,17 +2303,55 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "DevelopmentConfig"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Prowlarr.Api.V1.Config.DevelopmentConfigResource"
}
}
}
@@ -2298,10 +2359,10 @@
}
}
},
- "/api/v1/downloadclient/schema": {
+ "/api/v1/diskspace": {
"get": {
"tags": [
- "DownloadClient"
+ "DiskSpace"
],
"responses": {
"200": {
@@ -2311,7 +2372,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DiskSpace.DiskSpaceResource"
}
}
},
@@ -2319,7 +2380,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DiskSpace.DiskSpaceResource"
}
}
},
@@ -2327,7 +2388,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DiskSpace.DiskSpaceResource"
}
}
}
@@ -2336,7 +2397,43 @@
}
}
},
- "/api/v1/downloadclient/test": {
+ "/api/v1/downloadclient": {
+ "get": {
+ "tags": [
+ "DownloadClient"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"post": {
"tags": [
"DownloadClient"
@@ -2345,48 +2442,53 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
}
}
},
"responses": {
"200": {
- "description": "Success"
- }
- }
- }
- },
- "/api/v1/downloadclient/testall": {
- "post": {
- "tags": [
- "DownloadClient"
- ],
- "responses": {
- "200": {
- "description": "Success"
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ }
+ }
}
}
}
},
- "/api/v1/downloadclient/action/{name}": {
- "post": {
+ "/api/v1/downloadclient/{id}": {
+ "put": {
"tags": [
"DownloadClient"
],
"parameters": [
{
- "name": "name",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
@@ -2398,70 +2500,47 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
}
}
}
}
},
- "put": {
+ "delete": {
"tags": [
- "DownloadClientConfig"
+ "DownloadClient"
],
"parameters": [
{
@@ -2469,46 +2548,49 @@
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
}
}
],
- "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"
+ }
+ }
+ },
+ "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/DownloadClientConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
}
}
}
@@ -2516,10 +2598,10 @@
}
}
},
- "/api/v1/config/downloadclient": {
+ "/api/v1/downloadclient/schema": {
"get": {
"tags": [
- "DownloadClientConfig"
+ "DownloadClient"
],
"responses": {
"200": {
@@ -2527,17 +2609,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/DownloadClientConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
}
}
}
@@ -2545,36 +2636,30 @@
}
}
},
- "/api/v1/filesystem": {
- "get": {
+ "/api/v1/downloadclient/test": {
+ "post": {
"tags": [
- "FileSystem"
+ "DownloadClient"
],
- "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
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Success"
@@ -2582,19 +2667,10 @@
}
}
},
- "/api/v1/filesystem/type": {
- "get": {
+ "/api/v1/downloadclient/testall": {
+ "post": {
"tags": [
- "FileSystem"
- ],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
+ "DownloadClient"
],
"responses": {
"200": {
@@ -2603,20 +2679,40 @@
}
}
},
- "/api/v1/filesystem/mediafiles": {
- "get": {
+ "/api/v1/downloadclient/action/{name}": {
+ "post": {
"tags": [
- "FileSystem"
+ "DownloadClient"
],
"parameters": [
{
- "name": "path",
- "in": "query",
+ "name": "name",
+ "in": "path",
+ "required": true,
"schema": {
"type": "string"
}
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success"
@@ -2624,21 +2720,10 @@
}
}
},
- "/api/v1/health/{id}": {
+ "/api/v1/config/downloadclient": {
"get": {
"tags": [
- "Health"
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
+ "DownloadClientConfig"
],
"responses": {
"200": {
@@ -2646,17 +2731,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/HealthResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HealthResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/HealthResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
}
}
@@ -2664,64 +2749,75 @@
}
}
},
- "/api/v1/health": {
- "get": {
+ "/api/v1/config/downloadclient/{id}": {
+ "put": {
"tags": [
- "Health"
+ "DownloadClientConfig"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HealthResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HealthResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HealthResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
}
}
}
}
- }
- },
- "/api/v1/history": {
+ },
"get": {
"tags": [
- "History"
+ "DownloadClientConfig"
],
"parameters": [
{
- "name": "includeAuthor",
- "in": "query",
- "schema": {
- "type": "boolean",
- "default": false
- }
- },
- {
- "name": "includeBook",
- "in": "query",
+ "name": "id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "default": false
+ "type": "integer",
+ "format": "int32"
}
}
],
@@ -2731,17 +2827,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/HistoryResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HistoryResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/HistoryResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.DownloadClientConfigResource"
}
}
}
@@ -2749,41 +2845,21 @@
}
}
},
- "/api/v1/history/since": {
+ "/api/v1/edition": {
"get": {
"tags": [
- "History"
+ "Edition"
],
"parameters": [
{
- "name": "date",
- "in": "query",
- "schema": {
- "type": "string",
- "format": "date-time"
- }
- },
- {
- "name": "eventType",
- "in": "query",
- "schema": {
- "$ref": "#/components/schemas/HistoryEventType"
- }
- },
- {
- "name": "includeAuthor",
- "in": "query",
- "schema": {
- "type": "boolean",
- "default": false
- }
- },
- {
- "name": "includeBook",
+ "name": "bookId",
"in": "query",
"schema": {
- "type": "boolean",
- "default": false
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
}
}
],
@@ -2795,7 +2871,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.EditionResource"
}
}
},
@@ -2803,7 +2879,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.EditionResource"
}
}
},
@@ -2811,7 +2887,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.EditionResource"
}
}
}
@@ -2820,61 +2896,99 @@
}
}
},
- "/api/v1/history/author": {
+ "/api/v1/filesystem": {
"get": {
"tags": [
- "History"
+ "FileSystem"
],
"parameters": [
{
- "name": "authorId",
- "in": "query",
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "bookId",
+ "name": "path",
"in": "query",
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "string"
}
},
{
- "name": "eventType",
+ "name": "includeFiles",
"in": "query",
"schema": {
- "$ref": "#/components/schemas/HistoryEventType"
+ "type": "boolean",
+ "default": false
}
},
{
- "name": "includeAuthor",
+ "name": "allowFoldersWithoutTrailingSlashes",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
- },
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/api/v1/filesystem/type": {
+ "get": {
+ "tags": [
+ "FileSystem"
+ ],
+ "parameters": [
{
- "name": "includeBook",
+ "name": "path",
"in": "query",
"schema": {
- "type": "boolean",
- "default": false
+ "type": "string"
}
}
],
"responses": {
"200": {
- "description": "Success",
- "content": {
- "text/plain": {
- "schema": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/api/v1/filesystem/mediafiles": {
+ "get": {
+ "tags": [
+ "FileSystem"
+ ],
+ "parameters": [
+ {
+ "name": "path",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/api/v1/health": {
+ "get": {
+ "tags": [
+ "Health"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
}
}
},
@@ -2882,7 +2996,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
}
}
},
@@ -2890,7 +3004,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/HistoryResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
}
}
}
@@ -2899,53 +3013,66 @@
}
}
},
- "/api/v1/history/failed": {
- "post": {
+ "/api/v1/health/{id}": {
+ "get": {
"tags": [
- "History"
+ "Health"
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- "text/json": {
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- "application/*+json": {
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- },
+ ],
"responses": {
"200": {
- "description": "Success"
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Health.HealthResource"
+ }
+ }
+ }
}
}
}
},
- "/api/v1/config/host/{id}": {
+ "/api/v1/history": {
"get": {
"tags": [
- "HostConfig"
+ "History"
],
"parameters": [
{
- "name": "id",
- "in": "path",
- "required": true,
+ "name": "includeAuthor",
+ "in": "query",
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "includeBook",
+ "in": "query",
+ "schema": {
+ "type": "boolean",
+ "default": false
}
}
],
@@ -2955,73 +3082,88 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.History.HistoryResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.History.HistoryResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.History.HistoryResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
- },
- "put": {
+ }
+ },
+ "/api/v1/history/since": {
+ "get": {
"tags": [
- "HostConfig"
+ "History"
],
"parameters": [
{
- "name": "id",
- "in": "path",
- "required": true,
+ "name": "date",
+ "in": "query",
"schema": {
- "type": "string"
+ "type": "string",
+ "format": "date-time"
}
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HostConfigResource"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/HostConfigResource"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/HostConfigResource"
- }
+ },
+ {
+ "name": "eventType",
+ "in": "query",
+ "schema": {
+ "$ref": "#/components/schemas/NzbDrone.Core.History.EntityHistoryEventType"
+ }
+ },
+ {
+ "name": "includeAuthor",
+ "in": "query",
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "includeBook",
+ "in": "query",
+ "schema": {
+ "type": "boolean",
+ "default": false
}
}
- },
+ ],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
}
}
@@ -3029,10 +3171,51 @@
}
}
},
- "/api/v1/config/host": {
+ "/api/v1/history/author": {
"get": {
"tags": [
- "HostConfig"
+ "History"
+ ],
+ "parameters": [
+ {
+ "name": "authorId",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "bookId",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "eventType",
+ "in": "query",
+ "schema": {
+ "$ref": "#/components/schemas/NzbDrone.Core.History.EntityHistoryEventType"
+ }
+ },
+ {
+ "name": "includeAuthor",
+ "in": "query",
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "includeBook",
+ "in": "query",
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
],
"responses": {
"200": {
@@ -3040,17 +3223,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/HostConfigResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
+ }
}
}
}
@@ -3058,10 +3250,10 @@
}
}
},
- "/api/v1/importlist/{id}": {
- "get": {
+ "/api/v1/history/failed/{id}": {
+ "post": {
"tags": [
- "ImportList"
+ "History"
],
"parameters": [
{
@@ -3074,32 +3266,46 @@
}
}
],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ }
+ },
+ "/api/v1/config/host": {
+ "get": {
+ "tags": [
+ "HostConfig"
+ ],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/config/host/{id}": {
"put": {
"tags": [
- "ImportList"
+ "HostConfig"
],
"parameters": [
{
@@ -3115,17 +3321,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
}
}
@@ -3136,26 +3342,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
}
}
}
}
}
},
- "delete": {
+ "get": {
"tags": [
- "ImportList"
+ "HostConfig"
],
"parameters": [
{
@@ -3170,11 +3376,28 @@
],
"responses": {
"200": {
- "description": "Success"
- }
- }
- }
- },
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.HostConfigResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/v1/importlist": {
"get": {
"tags": [
@@ -3188,7 +3411,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
},
@@ -3196,7 +3419,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
},
@@ -3204,7 +3427,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3220,17 +3443,75 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/importlist/{id}": {
+ "put": {
+ "tags": [
+ "ImportList"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3241,17 +3522,76 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImportList"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
+ "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/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3272,7 +3612,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
},
@@ -3280,7 +3620,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
},
@@ -3288,7 +3628,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3306,17 +3646,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3359,17 +3699,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
}
}
}
@@ -3381,45 +3721,91 @@
}
}
},
- "/api/v1/importlistexclusion/{id}": {
+ "/api/v1/importlistexclusion": {
"get": {
"tags": [
"ImportListExclusion"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ }
+ }
}
}
+ }
+ },
+ "post": {
+ "tags": [
+ "ImportListExclusion"
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/importlistexclusion/{id}": {
"put": {
"tags": [
"ImportListExclusion"
@@ -3438,17 +3824,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
}
}
@@ -3459,17 +3845,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
}
}
}
@@ -3496,12 +3882,50 @@
"description": "Success"
}
}
+ },
+ "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/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListExclusionResource"
+ }
+ }
+ }
+ }
+ }
}
},
- "/api/v1/importlistexclusion": {
+ "/api/v1/indexer": {
"get": {
"tags": [
- "ImportListExclusion"
+ "Indexer"
],
"responses": {
"200": {
@@ -3511,7 +3935,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
},
@@ -3519,7 +3943,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
},
@@ -3527,7 +3951,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3537,23 +3961,23 @@
},
"post": {
"tags": [
- "ImportListExclusion"
+ "Indexer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3564,17 +3988,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ImportListExclusionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3583,7 +4007,7 @@
}
},
"/api/v1/indexer/{id}": {
- "get": {
+ "put": {
"tags": [
"Indexer"
],
@@ -3593,35 +4017,53 @@
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "string"
}
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
}
}
},
- "put": {
+ "delete": {
"tags": [
"Indexer"
],
@@ -3631,53 +4073,18 @@
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
}
}
],
- "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"
- }
- }
- }
+ "description": "Success"
}
}
},
- "delete": {
+ "get": {
"tags": [
"Indexer"
],
@@ -3692,90 +4099,23 @@
}
}
],
- "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"
- ],
- "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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3796,7 +4136,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
},
@@ -3804,7 +4144,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
},
@@ -3812,7 +4152,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3830,17 +4170,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3883,17 +4223,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
}
}
}
@@ -3905,45 +4245,36 @@
}
}
},
- "/api/v1/config/indexer/{id}": {
+ "/api/v1/config/indexer": {
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/config/indexer/{id}": {
"put": {
"tags": [
"IndexerConfig"
@@ -3962,17 +4293,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
}
}
@@ -3983,46 +4314,55 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
}
}
}
}
- }
- },
- "/api/v1/config/indexer": {
+ },
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/IndexerConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.IndexerConfigResource"
}
}
}
@@ -4042,39 +4382,37 @@
}
}
},
- "/api/v1/language/{id}": {
+ "/api/v1/language": {
"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"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LanguageResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/LanguageResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
+ }
}
}
}
@@ -4082,37 +4420,39 @@
}
}
},
- "/api/v1/language": {
+ "/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": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LanguageResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LanguageResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LanguageResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Languages.LanguageResource"
}
}
}
@@ -4160,17 +4500,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/LogResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Logs.LogResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LogResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Logs.LogResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/LogResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Logs.LogResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
@@ -4191,7 +4531,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
},
@@ -4199,7 +4539,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
},
@@ -4207,7 +4547,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
}
@@ -4227,6 +4567,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
@@ -4239,7 +4580,7 @@
}
},
"/api/v1/manualimport": {
- "put": {
+ "post": {
"tags": [
"ManualImport"
],
@@ -4249,7 +4590,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportUpdateResource"
}
}
},
@@ -4257,7 +4598,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportUpdateResource"
}
}
},
@@ -4265,7 +4606,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportUpdateResource"
}
}
}
@@ -4329,7 +4670,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportResource"
}
}
},
@@ -4337,7 +4678,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportResource"
}
}
},
@@ -4345,7 +4686,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ManualImportResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ManualImport.ManualImportResource"
}
}
}
@@ -4374,6 +4715,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "(.+)\\.(jpg|png|gif)",
"type": "string"
}
}
@@ -4405,6 +4747,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "(.+)\\.(jpg|png|gif)",
"type": "string"
}
}
@@ -4416,45 +4759,36 @@
}
}
},
- "/api/v1/config/mediamanagement/{id}": {
+ "/api/v1/config/mediamanagement": {
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/config/mediamanagement/{id}": {
"put": {
"tags": [
"MediaManagementConfig"
@@ -4473,17 +4807,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
}
}
@@ -4494,46 +4828,55 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
}
}
}
}
- }
- },
- "/api/v1/config/mediamanagement": {
+ },
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MediaManagementConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MediaManagementConfigResource"
}
}
}
@@ -4541,74 +4884,62 @@
}
}
},
- "/api/v1/metadata/{id}": {
+ "/api/v1/metadata": {
"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"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
}
}
}
}
}
},
- "put": {
+ "post": {
"tags": [
"Metadata"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
@@ -4619,24 +4950,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/metadata/{id}": {
+ "put": {
"tags": [
"Metadata"
],
@@ -4646,95 +4979,105 @@
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "string"
}
}
],
- "responses": {
- "200": {
- "description": "Success"
- }
- }
- }
- },
- "/api/v1/metadata": {
- "get": {
- "tags": [
- "Metadata"
- ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MetadataResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MetadataResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MetadataResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
}
}
},
- "post": {
+ "delete": {
"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"
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- },
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
+ "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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
@@ -4755,7 +5098,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
},
@@ -4763,7 +5106,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
},
@@ -4771,7 +5114,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
@@ -4789,17 +5132,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
@@ -4842,17 +5185,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
}
}
}
@@ -4873,17 +5216,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -4894,17 +5237,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -4923,7 +5266,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
},
@@ -4931,7 +5274,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
},
@@ -4939,7 +5282,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -4988,17 +5331,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -5009,17 +5352,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -5047,17 +5390,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -5076,17 +5419,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource"
}
}
}
@@ -5094,45 +5437,36 @@
}
}
},
- "/api/v1/config/metadataprovider/{id}": {
+ "/api/v1/config/metadataprovider": {
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/config/metadataprovider/{id}": {
"put": {
"tags": [
"MetadataProviderConfig"
@@ -5151,17 +5485,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
}
}
@@ -5172,46 +5506,55 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
}
}
}
}
- }
- },
- "/api/v1/config/metadataprovider": {
+ },
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/MetadataProviderConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.MetadataProviderConfigResource"
}
}
}
@@ -5240,17 +5583,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
@@ -5280,17 +5623,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
}
}
}
@@ -5298,45 +5641,36 @@
}
}
},
- "/api/v1/config/naming/{id}": {
+ "/api/v1/config/naming": {
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/config/naming/{id}": {
"put": {
"tags": [
"NamingConfig"
@@ -5355,17 +5689,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
}
}
@@ -5376,46 +5710,55 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
}
}
}
}
- }
- },
- "/api/v1/config/naming": {
+ },
"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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NamingConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.NamingConfigResource"
}
}
}
@@ -5522,45 +5865,91 @@
}
}
},
- "/api/v1/notification/{id}": {
+ "/api/v1/notification": {
"get": {
"tags": [
"Notification"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ }
+ }
}
}
+ }
+ },
+ "post": {
+ "tags": [
+ "Notification"
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/notification/{id}": {
"put": {
"tags": [
"Notification"
@@ -5579,17 +5968,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5600,17 +5989,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5637,85 +6026,39 @@
"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"
- }
- }
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- }
- },
- "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",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5736,7 +6079,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
},
@@ -5744,7 +6087,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
},
@@ -5752,7 +6095,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5770,17 +6113,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5823,17 +6166,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
}
}
}
@@ -5865,17 +6208,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ParseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Parse.ParseResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Parse.ParseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ParseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Parse.ParseResource"
}
}
}
@@ -5883,7 +6226,26 @@
}
}
},
- "/api/v1/qualitydefinition/{id}": {
+ "/ping": {
+ "get": {
+ "tags": [
+ "Ping"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Http.Ping.PingResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/qualitydefinition/{id}": {
"put": {
"tags": [
"QualityDefinition"
@@ -5902,17 +6264,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
}
@@ -5923,17 +6285,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
}
@@ -5961,17 +6323,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
}
@@ -5992,7 +6354,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
},
@@ -6000,7 +6362,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
},
@@ -6008,7 +6370,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
}
@@ -6028,7 +6390,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
},
@@ -6036,7 +6398,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
},
@@ -6044,7 +6406,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityDefinitionResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Qualities.QualityDefinitionResource"
}
}
}
@@ -6066,17 +6428,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6087,17 +6449,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6116,7 +6478,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
},
@@ -6124,7 +6486,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
},
@@ -6132,7 +6494,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6181,17 +6543,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6202,17 +6564,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6240,17 +6602,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6269,17 +6631,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QualityProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileResource"
}
}
}
@@ -6288,44 +6650,6 @@
}
},
"/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"
@@ -6349,7 +6673,7 @@
}
},
{
- "name": "blacklist",
+ "name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
@@ -6370,6 +6694,44 @@
"description": "Success"
}
}
+ },
+ "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/Readarr.Api.V1.Queue.QueueResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
+ }
+ }
+ }
+ }
+ }
}
},
"/api/v1/queue/bulk": {
@@ -6387,7 +6749,7 @@
}
},
{
- "name": "blacklist",
+ "name": "blocklist",
"in": "query",
"schema": {
"type": "boolean",
@@ -6407,17 +6769,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
}
}
@@ -6466,17 +6828,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QueueResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Queue.QueueResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QueueResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Queue.QueueResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QueueResourcePagingResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResource`1[[Readarr.Api.V1.Queue.QueueResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]"
}
}
}
@@ -6516,17 +6878,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/QueueBulkResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueBulkResource"
}
}
}
@@ -6538,46 +6900,6 @@
}
}
},
- "/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": [
@@ -6628,7 +6950,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QueueResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
}
},
@@ -6636,7 +6958,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QueueResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
}
},
@@ -6644,7 +6966,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QueueResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
}
}
@@ -6653,10 +6975,10 @@
}
}
},
- "/api/v1/queue/status/{id}": {
+ "/api/v1/queue/details/{id}": {
"get": {
"tags": [
- "QueueStatus"
+ "QueueDetails"
],
"parameters": [
{
@@ -6675,17 +6997,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
}
}
}
@@ -6704,17 +7026,57 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueStatusResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueStatusResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/QueueStatusResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueStatusResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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/Readarr.Api.V1.Queue.QueueStatusResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueStatusResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueStatusResource"
}
}
}
@@ -6731,17 +7093,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -6752,17 +7114,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -6799,7 +7161,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
},
@@ -6807,7 +7169,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
},
@@ -6815,7 +7177,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -6846,17 +7208,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -6864,45 +7226,91 @@
}
}
},
- "/api/v1/releaseprofile/{id}": {
+ "/api/v1/releaseprofile": {
"get": {
"tags": [
"ReleaseProfile"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ }
+ }
}
}
+ }
+ },
+ "post": {
+ "tags": [
+ "ReleaseProfile"
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/releaseprofile/{id}": {
"put": {
"tags": [
"ReleaseProfile"
@@ -6921,17 +7329,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
}
}
@@ -6942,17 +7350,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
}
}
@@ -6979,64 +7387,66 @@
"description": "Success"
}
}
- }
- },
- "/api/v1/releaseprofile": {
+ },
"get": {
"tags": [
"ReleaseProfile"
],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Release.ReleaseProfileResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/release/push": {
"post": {
"tags": [
- "ReleaseProfile"
+ "ReleasePush"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -7047,17 +7457,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseProfileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -7065,47 +7475,39 @@
}
}
},
- "/api/v1/release/push": {
- "post": {
+ "/api/v1/release/push/{id}": {
+ "get": {
"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"
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.ReleaseResource"
}
}
}
@@ -7113,85 +7515,91 @@
}
}
},
- "/api/v1/release/push/{id}": {
- "get": {
+ "/api/v1/remotepathmapping": {
+ "post": {
"tags": [
- "ReleasePush"
+ "RemotePathMapping"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/ReleaseResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
}
}
}
}
- }
- },
- "/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"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
+ }
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/remotepathmapping/{id}": {
"delete": {
"tags": [
"RemotePathMapping"
@@ -7231,17 +7639,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
}
}
@@ -7252,74 +7660,37 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
}
}
}
}
- }
- },
- "/api/v1/remotepathmapping": {
- "post": {
+ },
+ "get": {
"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"
- }
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- }
- },
- "get": {
- "tags": [
- "RemotePathMapping"
],
"responses": {
"200": {
@@ -7327,26 +7698,17 @@
"content": {
"text/plain": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
},
"text/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RemotePathMappingResource"
- }
+ "$ref": "#/components/schemas/Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource"
}
}
}
@@ -7385,7 +7747,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RenameBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RenameBookResource"
}
}
},
@@ -7393,7 +7755,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RenameBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RenameBookResource"
}
}
},
@@ -7401,7 +7763,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RenameBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RenameBookResource"
}
}
}
@@ -7441,7 +7803,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RetagBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RetagBookResource"
}
}
},
@@ -7449,7 +7811,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RetagBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RetagBookResource"
}
}
},
@@ -7457,7 +7819,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/RetagBookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.RetagBookResource"
}
}
}
@@ -7466,45 +7828,91 @@
}
}
},
- "/api/v1/rootfolder/{id}": {
- "get": {
+ "/api/v1/rootfolder": {
+ "post": {
"tags": [
"RootFolder"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
}
}
}
}
},
+ "get": {
+ "tags": [
+ "RootFolder"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
+ }
+ },
+ "text/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/rootfolder/{id}": {
"put": {
"tags": [
"RootFolder"
@@ -7523,17 +7931,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
}
}
@@ -7544,17 +7952,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
}
}
@@ -7581,105 +7989,59 @@
"description": "Success"
}
}
- }
- },
- "/api/v1/rootfolder": {
- "post": {
+ },
+ "get": {
"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"
- }
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/RootFolderResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.RootFolders.RootFolderResource"
}
}
}
}
}
- },
+ }
+ },
+ "/api/v1/search": {
"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"
- }
- }
+ "Search"
+ ],
+ "parameters": [
+ {
+ "name": "term",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
],
"responses": {
"200": {
@@ -7711,7 +8073,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SeriesResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Series.SeriesResource"
}
}
},
@@ -7719,7 +8081,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SeriesResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Series.SeriesResource"
}
}
},
@@ -7727,7 +8089,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SeriesResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Series.SeriesResource"
}
}
}
@@ -7747,6 +8109,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "^(?!/*api/).*",
"type": "string"
}
}
@@ -7791,6 +8154,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "^(?!(api|feed)/).*",
"type": "string"
}
}
@@ -7809,7 +8173,24 @@
],
"responses": {
"200": {
- "description": "Success"
+ "description": "Success",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.SystemResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.SystemResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.SystemResource"
+ }
+ }
+ }
}
}
}
@@ -7862,74 +8243,62 @@
}
}
},
- "/api/v1/tag/{id}": {
+ "/api/v1/tag": {
"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"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
+ }
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
+ }
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
+ }
}
}
}
}
}
},
- "put": {
+ "post": {
"tags": [
"Tag"
],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
}
}
@@ -7940,24 +8309,26 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
}
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/tag/{id}": {
+ "put": {
"tags": [
"Tag"
],
@@ -7967,74 +8338,25 @@
"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"
- }
- }
- }
+ "type": "string"
}
}
- }
- },
- "post": {
- "tags": [
- "Tag"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"application/*+json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
}
}
@@ -8045,28 +8367,47 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
}
}
}
}
- }
- },
- "/api/v1/tag/detail/{id}": {
+ },
+ "delete": {
+ "tags": [
+ "Tag"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ }
+ }
+ },
"get": {
"tags": [
- "TagDetails"
+ "Tag"
],
"parameters": [
{
@@ -8085,17 +8426,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagResource"
}
}
}
@@ -8116,7 +8457,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagDetailsResource"
}
}
},
@@ -8124,7 +8465,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagDetailsResource"
}
}
},
@@ -8132,7 +8473,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TagDetailsResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagDetailsResource"
}
}
}
@@ -8141,6 +8482,46 @@
}
}
},
+ "/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/Readarr.Api.V1.Tags.TagDetailsResource"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagDetailsResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Tags.TagDetailsResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/api/v1/system/task": {
"get": {
"tags": [
@@ -8154,7 +8535,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
}
},
@@ -8162,7 +8543,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
}
},
@@ -8170,7 +8551,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
}
}
@@ -8201,17 +8582,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/TaskResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.System.Tasks.TaskResource"
}
}
}
@@ -8220,7 +8601,7 @@
}
},
"/api/v1/config/ui/{id}": {
- "get": {
+ "put": {
"tags": [
"UiConfig"
],
@@ -8230,35 +8611,53 @@
"in": "path",
"required": true,
"schema": {
- "type": "integer",
- "format": "int32"
+ "type": "string"
}
}
],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
+ }
+ },
+ "text/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
+ }
+ },
+ "application/*+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
}
}
}
}
},
- "put": {
+ "get": {
"tags": [
"UiConfig"
],
@@ -8268,46 +8667,28 @@
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
}
}
],
- "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"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
}
}
@@ -8326,17 +8707,17 @@
"content": {
"text/plain": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
},
"text/json": {
"schema": {
- "$ref": "#/components/schemas/UiConfigResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Config.UiConfigResource"
}
}
}
@@ -8357,7 +8738,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/UpdateResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Update.UpdateResource"
}
}
},
@@ -8365,7 +8746,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/UpdateResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Update.UpdateResource"
}
}
},
@@ -8373,7 +8754,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/UpdateResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Update.UpdateResource"
}
}
}
@@ -8395,7 +8776,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
},
@@ -8403,7 +8784,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
},
@@ -8411,7 +8792,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/LogFileResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogFileResource"
}
}
}
@@ -8431,6 +8812,7 @@
"in": "path",
"required": true,
"schema": {
+ "pattern": "[-.a-zA-Z0-9]+?\\.txt",
"type": "string"
}
}
@@ -8445,11 +8827,85 @@
},
"components": {
"schemas": {
- "AddAuthorOptions": {
+ "NzbDrone.Common.EnvironmentInfo.RuntimeMode": {
+ "enum": [
+ "console",
+ "service",
+ "tray"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Common.Http.HttpUri": {
"type": "object",
"properties": {
- "monitor": {
- "$ref": "#/components/schemas/MonitorTypes"
+ "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
+ },
+ "NzbDrone.Common.Http.Proxy.ProxyType": {
+ "enum": [
+ "http",
+ "socks4",
+ "socks5"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Authentication.AuthenticationType": {
+ "enum": [
+ "none",
+ "basic",
+ "forms"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Backup.BackupType": {
+ "enum": [
+ "scheduled",
+ "manual",
+ "update"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Books.AddAuthorOptions": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.MonitorTypes"
},
"booksToMonitor": {
"type": "array",
@@ -8467,11 +8923,11 @@
},
"additionalProperties": false
},
- "AddBookOptions": {
+ "NzbDrone.Core.Books.AddBookOptions": {
"type": "object",
"properties": {
"addType": {
- "$ref": "#/components/schemas/BookAddType"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.BookAddType"
},
"searchForNewBook": {
"type": "boolean"
@@ -8479,31 +8935,7 @@
},
"additionalProperties": false
},
- "AllowFingerprinting": {
- "enum": [
- "never",
- "newFiles",
- "allFiles"
- ],
- "type": "string"
- },
- "ApplyTags": {
- "enum": [
- "add",
- "remove",
- "replace"
- ],
- "type": "string"
- },
- "AuthenticationType": {
- "enum": [
- "none",
- "basic",
- "forms"
- ],
- "type": "string"
- },
- "Author": {
+ "NzbDrone.Core.Books.Author": {
"type": "object",
"properties": {
"id": {
@@ -8521,6 +8953,9 @@
"monitored": {
"type": "boolean"
},
+ "monitorNewItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.NewItemMonitorTypes"
+ },
"lastInfoSync": {
"type": "string",
"format": "date-time",
@@ -8556,22 +8991,22 @@
"nullable": true
},
"addOptions": {
- "$ref": "#/components/schemas/AddAuthorOptions"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AddAuthorOptions"
},
"metadata": {
- "$ref": "#/components/schemas/AuthorMetadataLazyLoaded"
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.AuthorMetadata, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
},
"qualityProfile": {
- "$ref": "#/components/schemas/QualityProfileLazyLoaded"
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Profiles.Qualities.QualityProfile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
},
"metadataProfile": {
- "$ref": "#/components/schemas/MetadataProfileLazyLoaded"
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Profiles.Metadata.MetadataProfile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
},
"books": {
- "$ref": "#/components/schemas/BookListLazyLoaded"
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"series": {
- "$ref": "#/components/schemas/SeriesListLazyLoaded"
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Series, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"name": {
"type": "string",
@@ -8584,69 +9019,7 @@
},
"additionalProperties": false
},
- "AuthorEditorResource": {
- "type": "object",
- "properties": {
- "authorIds": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "nullable": true
- },
- "monitored": {
- "type": "boolean",
- "nullable": true
- },
- "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
- },
- "AuthorLazyLoaded": {
- "type": "object",
- "properties": {
- "value": {
- "$ref": "#/components/schemas/Author"
- },
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
- }
- },
- "additionalProperties": false
- },
- "AuthorMetadata": {
+ "NzbDrone.Core.Books.AuthorMetadata": {
"type": "object",
"properties": {
"id": {
@@ -8711,19 +9084,19 @@
"nullable": true
},
"status": {
- "$ref": "#/components/schemas/AuthorStatusType"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AuthorStatusType"
},
"images": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MediaCover"
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Links"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
},
"nullable": true
},
@@ -8735,25 +9108,19 @@
"nullable": true
},
"ratings": {
- "$ref": "#/components/schemas/Ratings"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
}
},
"additionalProperties": false
},
- "AuthorMetadataLazyLoaded": {
- "type": "object",
- "properties": {
- "value": {
- "$ref": "#/components/schemas/AuthorMetadata"
- },
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
- }
- },
- "additionalProperties": false
+ "NzbDrone.Core.Books.AuthorStatusType": {
+ "enum": [
+ "continuing",
+ "ended"
+ ],
+ "type": "string"
},
- "AuthorResource": {
+ "NzbDrone.Core.Books.Book": {
"type": "object",
"properties": {
"id": {
@@ -8764,22 +9131,7 @@
"type": "integer",
"format": "int32"
},
- "status": {
- "$ref": "#/components/schemas/AuthorStatusType"
- },
- "ended": {
- "type": "boolean",
- "readOnly": true
- },
- "authorName": {
- "type": "string",
- "nullable": true
- },
- "authorNameLastFirst": {
- "type": "string",
- "nullable": true
- },
- "foreignAuthorId": {
+ "foreignBookId": {
"type": "string",
"nullable": true
},
@@ -8787,83 +9139,53 @@
"type": "string",
"nullable": true
},
- "overview": {
+ "title": {
"type": "string",
"nullable": true
},
- "disambiguation": {
+ "releaseDate": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
"links": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Links"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
},
"nullable": true
},
- "nextBook": {
- "$ref": "#/components/schemas/Book"
- },
- "lastBook": {
- "$ref": "#/components/schemas/Book"
- },
- "images": {
+ "genres": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MediaCover"
+ "type": "string"
},
"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"
- },
- "rootFolderPath": {
- "type": "string",
- "nullable": true
- },
- "genres": {
+ "relatedBooks": {
"type": "array",
"items": {
- "type": "string"
+ "type": "integer",
+ "format": "int32"
},
"nullable": true
},
- "cleanName": {
- "type": "string",
- "nullable": true
+ "ratings": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
},
- "sortName": {
+ "cleanTitle": {
"type": "string",
"nullable": true
},
- "sortNameLastFirst": {
- "type": "string",
- "nullable": true
+ "monitored": {
+ "type": "boolean"
},
- "tags": {
- "uniqueItems": true,
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
+ "anyEditionOk": {
+ "type": "boolean"
+ },
+ "lastInfoSync": {
+ "type": "string",
+ "format": "date-time",
"nullable": true
},
"added": {
@@ -8871,504 +9193,1454 @@
"format": "date-time"
},
"addOptions": {
- "$ref": "#/components/schemas/AddAuthorOptions"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AddBookOptions"
},
- "ratings": {
- "$ref": "#/components/schemas/Ratings"
+ "authorMetadata": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.AuthorMetadata, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
},
- "statistics": {
- "$ref": "#/components/schemas/AuthorStatisticsResource"
+ "author": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Author, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
+ },
+ "editions": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Edition, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
+ },
+ "bookFiles": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.MediaFiles.BookFile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
+ },
+ "seriesLinks": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.SeriesBookLink, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"additionalProperties": false
},
- "AuthorStatisticsResource": {
+ "NzbDrone.Core.Books.BookAddType": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Books.Edition": {
"type": "object",
"properties": {
- "bookFileCount": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "bookCount": {
+ "bookId": {
"type": "integer",
"format": "int32"
},
- "availableBookCount": {
- "type": "integer",
- "format": "int32"
+ "foreignEditionId": {
+ "type": "string",
+ "nullable": true
},
- "totalBookCount": {
+ "titleSlug": {
+ "type": "string",
+ "nullable": true
+ },
+ "isbn13": {
+ "type": "string",
+ "nullable": true
+ },
+ "asin": {
+ "type": "string",
+ "nullable": true
+ },
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "overview": {
+ "type": "string",
+ "nullable": true
+ },
+ "format": {
+ "type": "string",
+ "nullable": true
+ },
+ "isEbook": {
+ "type": "boolean"
+ },
+ "disambiguation": {
+ "type": "string",
+ "nullable": true
+ },
+ "publisher": {
+ "type": "string",
+ "nullable": true
+ },
+ "pageCount": {
"type": "integer",
"format": "int32"
},
- "sizeOnDisk": {
- "type": "integer",
- "format": "int64"
+ "releaseDate": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
},
- "percentOfBooks": {
- "type": "number",
- "format": "double",
- "readOnly": true
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCover"
+ },
+ "nullable": true
+ },
+ "links": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
+ },
+ "nullable": true
+ },
+ "ratings": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
+ },
+ "monitored": {
+ "type": "boolean"
+ },
+ "manualAdd": {
+ "type": "boolean"
+ },
+ "book": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
+ },
+ "bookFiles": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.MediaFiles.BookFile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Books.Links": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "AuthorStatusType": {
+ "NzbDrone.Core.Books.MonitorTypes": {
"enum": [
- "continuing",
- "ended"
+ "all",
+ "future",
+ "missing",
+ "existing",
+ "latest",
+ "first",
+ "none",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Books.MonitoringOptions": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.MonitorTypes"
+ },
+ "booksToMonitor": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "monitored": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Books.NewItemMonitorTypes": {
+ "enum": [
+ "all",
+ "none",
+ "new"
],
"type": "string"
},
- "AuthorTitleInfo": {
+ "NzbDrone.Core.Books.Ratings": {
+ "type": "object",
+ "properties": {
+ "votes": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "value": {
+ "type": "number",
+ "format": "double"
+ },
+ "popularity": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Books.Series": {
"type": "object",
"properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "foreignSeriesId": {
+ "type": "string",
+ "nullable": true
+ },
"title": {
"type": "string",
"nullable": true
},
- "titleWithoutYear": {
+ "description": {
"type": "string",
"nullable": true
},
- "year": {
+ "numbered": {
+ "type": "boolean"
+ },
+ "workCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "primaryWorkCount": {
"type": "integer",
"format": "int32"
+ },
+ "linkItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.SeriesBookLink, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
+ },
+ "books": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
+ },
+ "foreignAuthorId": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "BackupResource": {
+ "NzbDrone.Core.Books.SeriesBookLink": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "position": {
"type": "string",
"nullable": true
},
- "path": {
- "type": "string",
- "nullable": true
+ "seriesPosition": {
+ "type": "integer",
+ "format": "int32"
},
- "type": {
- "$ref": "#/components/schemas/BackupType"
+ "seriesId": {
+ "type": "integer",
+ "format": "int32"
},
- "time": {
- "type": "string",
- "format": "date-time"
+ "bookId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "series": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Series, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
+ },
+ "book": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
- "BackupType": {
+ "NzbDrone.Core.Configuration.AllowFingerprinting": {
"enum": [
- "scheduled",
- "manual",
- "update"
+ "never",
+ "newFiles",
+ "allFiles"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Configuration.RescanAfterRefreshType": {
+ "enum": [
+ "always",
+ "afterManual",
+ "never"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Configuration.WriteAudioTagsType": {
+ "enum": [
+ "no",
+ "newFiles",
+ "allFiles",
+ "sync"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Configuration.WriteBookTagsType": {
+ "enum": [
+ "newFiles",
+ "allFiles",
+ "sync"
],
"type": "string"
},
- "BlacklistBulkResource": {
+ "NzbDrone.Core.CustomFormats.CustomFormat": {
"type": "object",
"properties": {
- "ids": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "includeCustomFormatWhenRenaming": {
+ "type": "boolean"
+ },
+ "specifications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.CustomFormats.ICustomFormatSpecification"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.CustomFormats.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
+ },
+ "NzbDrone.Core.Datastore.DatabaseType": {
+ "enum": [
+ "sqLite",
+ "postgreSQL"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Author, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Author"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.AuthorMetadata, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AuthorMetadata"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Book"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Edition, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Edition"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Series, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Series"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Profiles.Metadata.MetadataProfile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Profiles.Metadata.MetadataProfile"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Profiles.Qualities.QualityProfile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Profiles.Qualities.QualityProfile"
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Book, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Book"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Edition, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Edition"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.Series, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Series"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.Books.SeriesBookLink, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.SeriesBookLink"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.LazyLoaded`1[[System.Collections.Generic.List`1[[NzbDrone.Core.MediaFiles.BookFile, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaFiles.BookFile"
+ },
+ "nullable": true,
+ "readOnly": true
+ },
+ "isLoaded": {
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Datastore.SortDirection": {
+ "enum": [
+ "default",
+ "ascending",
+ "descending"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.DecisionEngine.Rejection": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "$ref": "#/components/schemas/NzbDrone.Core.DecisionEngine.RejectionType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.DecisionEngine.RejectionType": {
+ "enum": [
+ "permanent",
+ "temporary"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadState": {
+ "enum": [
+ "downloading",
+ "downloadFailed",
+ "downloadFailedPending",
+ "importPending",
+ "importing",
+ "importFailed",
+ "imported",
+ "ignored"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadStatus": {
+ "enum": [
+ "ok",
+ "warning",
+ "error"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadStatusMessage": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "messages": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.HealthCheck.HealthCheckResult": {
+ "enum": [
+ "ok",
+ "notice",
+ "warning",
+ "error"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.History.EntityHistoryEventType": {
+ "enum": [
+ "unknown",
+ "grabbed",
+ "bookFileImported",
+ "downloadFailed",
+ "bookFileDeleted",
+ "bookFileRenamed",
+ "bookImportIncomplete",
+ "downloadImported",
+ "bookFileRetagged",
+ "downloadIgnored"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.ImportLists.ImportListMonitorType": {
+ "enum": [
+ "none",
+ "specificBook",
+ "entireAuthor"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.ImportLists.ImportListType": {
+ "enum": [
+ "program",
+ "goodreads",
+ "other"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Indexers.DownloadProtocol": {
+ "enum": [
+ "unknown",
+ "usenet",
+ "torrent"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.MediaCover.MediaCover": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "nullable": true
+ },
+ "coverType": {
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCoverTypes"
+ },
+ "extension": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.MediaCover.MediaCoverTypes": {
+ "enum": [
+ "unknown",
+ "poster",
+ "banner",
+ "fanart",
+ "screenshot",
+ "headshot",
+ "cover",
+ "disc",
+ "logo"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.MediaFiles.BookFile": {
+ "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/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "mediaInfo": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.MediaInfoModel"
+ },
+ "editionId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "calibreId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "part": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "author": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Author, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
+ },
+ "edition": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.LazyLoaded`1[[NzbDrone.Core.Books.Edition, Readarr.Core, Version=10.0.0.13362, Culture=neutral, PublicKeyToken=null]]"
+ },
+ "partCount": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.MediaFiles.FileDateType": {
+ "enum": [
+ "none",
+ "bookReleaseDate"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Messaging.Commands.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/NzbDrone.Core.Messaging.Commands.CommandTrigger"
+ },
+ "suppressMessages": {
+ "type": "boolean"
+ },
+ "clientUserAgent": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Messaging.Commands.CommandPriority": {
+ "enum": [
+ "normal",
+ "high",
+ "low"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Messaging.Commands.CommandStatus": {
+ "enum": [
+ "queued",
+ "started",
+ "completed",
+ "failed",
+ "aborted",
+ "cancelled",
+ "orphaned"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Messaging.Commands.CommandTrigger": {
+ "enum": [
+ "unspecified",
+ "manual",
+ "scheduled"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Parser.IsoCountry": {
+ "type": "object",
+ "properties": {
+ "twoLetterCode": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Parser.Model.AuthorTitleInfo": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "titleWithoutYear": {
+ "type": "string",
+ "nullable": true
+ },
+ "year": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Parser.Model.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
+ },
+ "NzbDrone.Core.Parser.Model.ParsedBookInfo": {
+ "type": "object",
+ "properties": {
+ "bookTitle": {
+ "type": "string",
+ "nullable": true
+ },
+ "authorName": {
+ "type": "string",
+ "nullable": true
+ },
+ "authorTitleInfo": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.AuthorTitleInfo"
+ },
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.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
+ },
+ "NzbDrone.Core.Parser.Model.ParsedTrackInfo": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "cleanTitle": {
+ "type": "string",
+ "nullable": true
+ },
+ "authors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "authorTitle": {
+ "type": "string",
+ "nullable": true,
+ "readOnly": true
+ },
+ "bookTitle": {
+ "type": "string",
+ "nullable": true
+ },
+ "seriesTitle": {
+ "type": "string",
+ "nullable": true
+ },
+ "seriesIndex": {
+ "type": "string",
+ "nullable": true
+ },
+ "isbn": {
+ "type": "string",
+ "nullable": true
+ },
+ "asin": {
+ "type": "string",
+ "nullable": true
+ },
+ "goodreadsId": {
+ "type": "string",
+ "nullable": true
+ },
+ "authorMBId": {
+ "type": "string",
+ "nullable": true
+ },
+ "bookMBId": {
+ "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/NzbDrone.Core.Parser.IsoCountry"
+ },
+ "year": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "publisher": {
+ "type": "string",
+ "nullable": true
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "source": {
+ "type": "string",
+ "nullable": true
+ },
+ "catalogNumber": {
+ "type": "string",
+ "nullable": true
+ },
+ "disambiguation": {
+ "type": "string",
+ "nullable": true
+ },
+ "duration": {
+ "$ref": "#/components/schemas/System.TimeSpan"
+ },
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "mediaInfo": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.MediaInfoModel"
+ },
+ "trackNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "releaseGroup": {
+ "type": "string",
+ "nullable": true
+ },
+ "releaseHash": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "BlacklistResource": {
+ "NzbDrone.Core.Profiles.Metadata.MetadataProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "authorId": {
- "type": "integer",
- "format": "int32"
- },
- "bookIds": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "nullable": true
- },
- "sourceTitle": {
+ "name": {
"type": "string",
"nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "minPopularity": {
+ "type": "number",
+ "format": "double"
},
- "date": {
- "type": "string",
- "format": "date-time"
+ "skipMissingDate": {
+ "type": "boolean"
},
- "protocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
+ "skipMissingIsbn": {
+ "type": "boolean"
},
- "indexer": {
+ "skipPartsAndSets": {
+ "type": "boolean"
+ },
+ "skipSeriesSecondary": {
+ "type": "boolean"
+ },
+ "allowedLanguages": {
"type": "string",
"nullable": true
},
- "message": {
+ "minPages": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "ignored": {
"type": "string",
"nullable": true
- },
- "author": {
- "$ref": "#/components/schemas/AuthorResource"
}
},
"additionalProperties": false
},
- "BlacklistResourcePagingResource": {
+ "NzbDrone.Core.Profiles.ProfileFormatItem": {
"type": "object",
"properties": {
- "page": {
+ "format": {
+ "$ref": "#/components/schemas/NzbDrone.Core.CustomFormats.CustomFormat"
+ },
+ "score": {
"type": "integer",
"format": "int32"
- },
- "pageSize": {
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Profiles.Qualities.QualityProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "sortKey": {
+ "name": {
"type": "string",
"nullable": true
},
- "sortDirection": {
- "$ref": "#/components/schemas/SortDirection"
+ "upgradeAllowed": {
+ "type": "boolean"
},
- "filters": {
+ "cutoff": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "minFormatScore": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "cutoffFormatScore": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "formatItems": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PagingResourceFilter"
+ "$ref": "#/components/schemas/NzbDrone.Core.Profiles.ProfileFormatItem"
},
"nullable": true
},
- "totalRecords": {
- "type": "integer",
- "format": "int32"
- },
- "records": {
+ "items": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BlacklistResource"
+ "$ref": "#/components/schemas/NzbDrone.Core.Profiles.Qualities.QualityProfileQualityItem"
},
"nullable": true
}
},
"additionalProperties": false
},
- "Book": {
+ "NzbDrone.Core.Profiles.Qualities.QualityProfileQualityItem": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "authorMetadataId": {
- "type": "integer",
- "format": "int32"
- },
- "foreignBookId": {
- "type": "string",
- "nullable": true
- },
- "titleSlug": {
- "type": "string",
- "nullable": true
- },
- "title": {
- "type": "string",
- "nullable": true
- },
- "releaseDate": {
+ "name": {
"type": "string",
- "format": "date-time",
"nullable": true
},
- "links": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Links"
- },
- "nullable": true
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.Quality"
},
- "genres": {
+ "items": {
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/NzbDrone.Core.Profiles.Qualities.QualityProfileQualityItem"
},
"nullable": true
},
- "ratings": {
- "$ref": "#/components/schemas/Ratings"
- },
- "cleanTitle": {
- "type": "string",
- "nullable": true
- },
- "monitored": {
- "type": "boolean"
- },
- "anyEditionOk": {
+ "allowed": {
"type": "boolean"
- },
- "lastInfoSync": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "added": {
- "type": "string",
- "format": "date-time"
- },
- "addOptions": {
- "$ref": "#/components/schemas/AddBookOptions"
- },
- "authorMetadata": {
- "$ref": "#/components/schemas/AuthorMetadataLazyLoaded"
- },
- "author": {
- "$ref": "#/components/schemas/AuthorLazyLoaded"
- },
- "editions": {
- "$ref": "#/components/schemas/EditionListLazyLoaded"
- },
- "bookFiles": {
- "$ref": "#/components/schemas/BookFileListLazyLoaded"
- },
- "seriesLinks": {
- "$ref": "#/components/schemas/SeriesBookLinkListLazyLoaded"
}
},
"additionalProperties": false
},
- "BookAddType": {
+ "NzbDrone.Core.Qualities.ProperDownloadTypes": {
"enum": [
- "automatic",
- "manual"
+ "preferAndUpgrade",
+ "doNotUpgrade",
+ "doNotPrefer"
],
"type": "string"
},
- "BookFile": {
+ "NzbDrone.Core.Qualities.Quality": {
"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"
- },
- "sceneName": {
- "type": "string",
- "nullable": true
- },
- "releaseGroup": {
+ "name": {
"type": "string",
"nullable": true
- },
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Qualities.QualityModel": {
+ "type": "object",
+ "properties": {
"quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.Quality"
},
- "mediaInfo": {
- "$ref": "#/components/schemas/MediaInfoModel"
- },
- "editionId": {
- "type": "integer",
- "format": "int32"
- },
- "calibreId": {
+ "revision": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.Revision"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NzbDrone.Core.Qualities.Revision": {
+ "type": "object",
+ "properties": {
+ "version": {
"type": "integer",
"format": "int32"
},
- "part": {
+ "real": {
"type": "integer",
"format": "int32"
},
- "author": {
- "$ref": "#/components/schemas/AuthorLazyLoaded"
- },
- "edition": {
- "$ref": "#/components/schemas/EditionLazyLoaded"
- },
- "partCount": {
- "type": "integer",
- "format": "int32"
+ "isRepack": {
+ "type": "boolean"
}
},
"additionalProperties": false
},
- "BookFileListLazyLoaded": {
+ "NzbDrone.Core.Security.CertificateValidationType": {
+ "enum": [
+ "enabled",
+ "disabledForLocalAddresses",
+ "disabled"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.ThingiProvider.ProviderMessage": {
"type": "object",
"properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BookFile"
- },
- "nullable": true,
- "readOnly": true
+ "message": {
+ "type": "string",
+ "nullable": true
},
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
+ "type": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessageType"
}
},
"additionalProperties": false
},
- "BookFileListResource": {
+ "NzbDrone.Core.ThingiProvider.ProviderMessageType": {
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
+ "type": "string"
+ },
+ "NzbDrone.Core.Update.UpdateChanges": {
"type": "object",
"properties": {
- "bookFileIds": {
+ "new": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "type": "string"
},
"nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "fixed": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
}
},
"additionalProperties": false
},
- "BookFileResource": {
+ "NzbDrone.Core.Update.UpdateMechanism": {
+ "enum": [
+ "builtIn",
+ "script",
+ "external",
+ "apt",
+ "docker"
+ ],
+ "type": "string"
+ },
+ "Prowlarr.Api.V1.Config.DevelopmentConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "authorId": {
- "type": "integer",
- "format": "int32"
- },
- "bookId": {
- "type": "integer",
- "format": "int32"
- },
- "path": {
+ "metadataSource": {
"type": "string",
"nullable": true
},
- "size": {
- "type": "integer",
- "format": "int64"
- },
- "dateAdded": {
+ "consoleLogLevel": {
"type": "string",
- "format": "date-time"
+ "nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "logSql": {
+ "type": "boolean"
},
- "qualityWeight": {
+ "logRotate": {
"type": "integer",
"format": "int32"
},
- "mediaInfo": {
- "$ref": "#/components/schemas/MediaInfoResource"
- },
- "qualityCutoffNotMet": {
+ "filterSentryEvents": {
"type": "boolean"
- },
- "audioTags": {
- "$ref": "#/components/schemas/ParsedTrackInfo"
}
},
"additionalProperties": false
},
- "BookLazyLoaded": {
- "type": "object",
- "properties": {
- "value": {
- "$ref": "#/components/schemas/Book"
- },
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
- }
- },
- "additionalProperties": false
+ "Readarr.Api.V1.Author.ApplyTags": {
+ "enum": [
+ "add",
+ "remove",
+ "replace"
+ ],
+ "type": "string"
},
- "BookListLazyLoaded": {
+ "Readarr.Api.V1.Author.AuthorEditorResource": {
"type": "object",
"properties": {
- "value": {
+ "authorIds": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Book"
+ "type": "integer",
+ "format": "int32"
},
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "isLoaded": {
+ "monitored": {
"type": "boolean",
- "readOnly": true
+ "nullable": true
+ },
+ "monitorNewItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.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/Readarr.Api.V1.Author.ApplyTags"
+ },
+ "moveFiles": {
+ "type": "boolean"
+ },
+ "deleteFiles": {
+ "type": "boolean"
}
},
"additionalProperties": false
},
- "BookResource": {
+ "Readarr.Api.V1.Author.AuthorResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "title": {
- "type": "string",
- "nullable": true
+ "authorMetadataId": {
+ "type": "integer",
+ "format": "int32"
},
- "authorTitle": {
- "type": "string",
- "nullable": true
+ "status": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AuthorStatusType"
},
- "seriesTitle": {
- "type": "string",
- "nullable": true
+ "ended": {
+ "type": "boolean",
+ "readOnly": true
},
- "disambiguation": {
+ "authorName": {
"type": "string",
"nullable": true
},
- "overview": {
+ "authorNameLastFirst": {
"type": "string",
"nullable": true
},
- "authorId": {
- "type": "integer",
- "format": "int32"
- },
- "foreignBookId": {
+ "foreignAuthorId": {
"type": "string",
"nullable": true
},
@@ -9376,156 +10648,81 @@
"type": "string",
"nullable": true
},
- "monitored": {
- "type": "boolean"
- },
- "anyEditionOk": {
- "type": "boolean"
- },
- "ratings": {
- "$ref": "#/components/schemas/Ratings"
- },
- "releaseDate": {
+ "overview": {
"type": "string",
- "format": "date-time",
"nullable": true
},
- "pageCount": {
- "type": "integer",
- "format": "int32"
+ "disambiguation": {
+ "type": "string",
+ "nullable": true
},
- "genres": {
+ "links": {
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
},
"nullable": true
},
- "author": {
- "$ref": "#/components/schemas/AuthorResource"
+ "nextBook": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Book"
},
- "images": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MediaCover"
- },
- "nullable": true
+ "lastBook": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Book"
},
- "links": {
+ "images": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Links"
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCover"
},
"nullable": true
},
- "statistics": {
- "$ref": "#/components/schemas/BookStatisticsResource"
- },
- "added": {
+ "remotePoster": {
"type": "string",
- "format": "date-time",
"nullable": true
},
- "addOptions": {
- "$ref": "#/components/schemas/AddBookOptions"
- },
- "remoteCover": {
+ "path": {
"type": "string",
"nullable": true
},
- "editions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EditionResource"
- },
- "nullable": true
- },
- "grabbed": {
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "BookResourcePagingResource": {
- "type": "object",
- "properties": {
- "page": {
+ "qualityProfileId": {
"type": "integer",
"format": "int32"
},
- "pageSize": {
+ "metadataProfileId": {
"type": "integer",
"format": "int32"
},
- "sortKey": {
- "type": "string",
- "nullable": true
+ "monitored": {
+ "type": "boolean"
},
- "sortDirection": {
- "$ref": "#/components/schemas/SortDirection"
+ "monitorNewItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.NewItemMonitorTypes"
},
- "filters": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PagingResourceFilter"
- },
+ "rootFolderPath": {
+ "type": "string",
"nullable": true
},
- "totalRecords": {
- "type": "integer",
- "format": "int32"
- },
- "records": {
+ "genres": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "type": "string"
},
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "BookshelfAuthorResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
},
- "monitored": {
- "type": "boolean",
+ "cleanName": {
+ "type": "string",
"nullable": true
},
- "books": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BookResource"
- },
+ "sortName": {
+ "type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "BookshelfResource": {
- "type": "object",
- "properties": {
- "authors": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BookshelfAuthorResource"
- },
+ },
+ "sortNameLastFirst": {
+ "type": "string",
"nullable": true
},
- "monitoringOptions": {
- "$ref": "#/components/schemas/MonitoringOptions"
- }
- },
- "additionalProperties": false
- },
- "BooksMonitoredResource": {
- "type": "object",
- "properties": {
- "bookIds": {
+ "tags": {
+ "uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
@@ -9533,20 +10730,34 @@
},
"nullable": true
},
- "monitored": {
- "type": "boolean"
+ "added": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "addOptions": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AddAuthorOptions"
+ },
+ "ratings": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
+ },
+ "statistics": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorStatisticsResource"
}
},
"additionalProperties": false
},
- "BookStatisticsResource": {
+ "Readarr.Api.V1.Author.AuthorStatisticsResource": {
"type": "object",
"properties": {
"bookFileCount": {
"type": "integer",
"format": "int32"
},
- "bookCount": {
+ "bookCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "availableBookCount": {
"type": "integer",
"format": "int32"
},
@@ -9566,393 +10777,347 @@
},
"additionalProperties": false
},
- "CertificateValidationType": {
- "enum": [
- "enabled",
- "disabledForLocalAddresses",
- "disabled"
- ],
- "type": "string"
- },
- "Command": {
+ "Readarr.Api.V1.Blocklist.BlocklistBulkResource": {
"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
- },
- "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",
+ "ids": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
"nullable": true
}
},
"additionalProperties": false
},
- "CommandPriority": {
- "enum": [
- "normal",
- "high",
- "low"
- ],
- "type": "string"
- },
- "CommandResource": {
+ "Readarr.Api.V1.Blocklist.BlocklistResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
- "type": "string",
- "nullable": true
+ "authorId": {
+ "type": "integer",
+ "format": "int32"
},
- "commandName": {
- "type": "string",
+ "bookIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
"nullable": true
},
- "message": {
+ "sourceTitle": {
"type": "string",
"nullable": true
},
- "body": {
- "$ref": "#/components/schemas/Command"
- },
- "priority": {
- "$ref": "#/components/schemas/CommandPriority"
- },
- "status": {
- "$ref": "#/components/schemas/CommandStatus"
- },
- "queued": {
- "type": "string",
- "format": "date-time"
- },
- "started": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
},
- "ended": {
- "type": "string",
- "format": "date-time",
+ "customFormats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
+ },
"nullable": true
},
- "duration": {
- "$ref": "#/components/schemas/TimeSpan"
- },
- "exception": {
+ "date": {
"type": "string",
- "nullable": true
+ "format": "date-time"
},
- "trigger": {
- "$ref": "#/components/schemas/CommandTrigger"
+ "protocol": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.DownloadProtocol"
},
- "clientUserAgent": {
+ "indexer": {
"type": "string",
"nullable": true
},
- "stateChangeTime": {
+ "message": {
"type": "string",
- "format": "date-time",
"nullable": true
},
- "sendUpdatesToClient": {
- "type": "boolean"
- },
- "updateScheduledTask": {
- "type": "boolean"
- },
- "lastExecutionTime": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "author": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"additionalProperties": false
},
- "CommandStatus": {
- "enum": [
- "queued",
- "started",
- "completed",
- "failed",
- "aborted",
- "cancelled",
- "orphaned"
- ],
- "type": "string"
- },
- "CommandTrigger": {
- "enum": [
- "unspecified",
- "manual",
- "scheduled"
- ],
- "type": "string"
- },
- "CustomFilterResource": {
+ "Readarr.Api.V1.BookFiles.BookFileListResource": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int32"
- },
- "type": {
- "type": "string",
- "nullable": true
- },
- "label": {
- "type": "string",
- "nullable": true
- },
- "filters": {
+ "bookFileIds": {
"type": "array",
"items": {
- "type": "object",
- "additionalProperties": { }
+ "type": "integer",
+ "format": "int32"
},
"nullable": true
+ },
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
}
},
"additionalProperties": false
},
- "DelayProfileResource": {
+ "Readarr.Api.V1.BookFiles.BookFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "enableUsenet": {
- "type": "boolean"
- },
- "enableTorrent": {
- "type": "boolean"
- },
- "preferredProtocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
- },
- "usenetDelay": {
+ "authorId": {
"type": "integer",
"format": "int32"
},
- "torrentDelay": {
+ "bookId": {
"type": "integer",
"format": "int32"
},
- "order": {
+ "path": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "dateAdded": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "qualityWeight": {
"type": "integer",
"format": "int32"
},
- "tags": {
- "uniqueItems": true,
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "nullable": true
+ "mediaInfo": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.BookFiles.MediaInfoResource"
+ },
+ "qualityCutoffNotMet": {
+ "type": "boolean"
+ },
+ "audioTags": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.ParsedTrackInfo"
}
},
"additionalProperties": false
},
- "DevelopmentConfigResource": {
+ "Readarr.Api.V1.BookFiles.MediaInfoResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "metadataSource": {
+ "audioChannels": {
+ "type": "number",
+ "format": "double"
+ },
+ "audioBitRate": {
"type": "string",
"nullable": true
},
- "consoleLogLevel": {
+ "audioCodec": {
"type": "string",
"nullable": true
},
- "logSql": {
- "type": "boolean"
+ "audioBits": {
+ "type": "string",
+ "nullable": true
},
- "logRotate": {
- "type": "integer",
- "format": "int32"
+ "audioSampleRate": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Books.BookEditorResource": {
+ "type": "object",
+ "properties": {
+ "bookIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
},
- "filterSentryEvents": {
- "type": "boolean"
+ "monitored": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "deleteFiles": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "addImportListExclusion": {
+ "type": "boolean",
+ "nullable": true
}
},
"additionalProperties": false
},
- "DiskSpaceResource": {
+ "Readarr.Api.V1.Books.BookResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "path": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "authorTitle": {
"type": "string",
"nullable": true
},
- "label": {
+ "seriesTitle": {
"type": "string",
"nullable": true
},
- "freeSpace": {
- "type": "integer",
- "format": "int64"
+ "disambiguation": {
+ "type": "string",
+ "nullable": true
},
- "totalSpace": {
- "type": "integer",
- "format": "int64"
- }
- },
- "additionalProperties": false
- },
- "DownloadClientConfigResource": {
- "type": "object",
- "properties": {
- "id": {
+ "overview": {
+ "type": "string",
+ "nullable": true
+ },
+ "authorId": {
"type": "integer",
"format": "int32"
},
- "downloadClientWorkingFolders": {
+ "foreignBookId": {
"type": "string",
"nullable": true
},
- "enableCompletedDownloadHandling": {
- "type": "boolean"
+ "titleSlug": {
+ "type": "string",
+ "nullable": true
},
- "removeCompletedDownloads": {
+ "monitored": {
"type": "boolean"
},
- "autoRedownloadFailed": {
+ "anyEditionOk": {
"type": "boolean"
},
- "removeFailedDownloads": {
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "DownloadClientResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
+ "ratings": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
},
- "name": {
+ "releaseDate": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "fields": {
+ "pageCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "genres": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Field"
+ "type": "string"
},
"nullable": true
},
- "implementationName": {
- "type": "string",
- "nullable": true
+ "author": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
},
- "implementation": {
- "type": "string",
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCover"
+ },
"nullable": true
},
- "configContract": {
- "type": "string",
+ "links": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
+ },
"nullable": true
},
- "infoLink": {
+ "statistics": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookStatisticsResource"
+ },
+ "added": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "message": {
- "$ref": "#/components/schemas/ProviderMessage"
+ "addOptions": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.AddBookOptions"
},
- "tags": {
- "uniqueItems": true,
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
+ "remoteCover": {
+ "type": "string",
"nullable": true
},
- "presets": {
+ "editions": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DownloadClientResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.EditionResource"
},
"nullable": true
},
- "enable": {
+ "grabbed": {
"type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Books.BookStatisticsResource": {
+ "type": "object",
+ "properties": {
+ "bookFileCount": {
+ "type": "integer",
+ "format": "int32"
},
- "protocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
+ "bookCount": {
+ "type": "integer",
+ "format": "int32"
},
- "priority": {
+ "totalBookCount": {
"type": "integer",
"format": "int32"
+ },
+ "sizeOnDisk": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "percentOfBooks": {
+ "type": "number",
+ "format": "double",
+ "readOnly": true
}
},
"additionalProperties": false
},
- "DownloadProtocol": {
- "enum": [
- "unknown",
- "usenet",
- "torrent"
- ],
- "type": "string"
+ "Readarr.Api.V1.Books.BooksMonitoredResource": {
+ "type": "object",
+ "properties": {
+ "bookIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
+ },
+ "monitored": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
},
- "Edition": {
+ "Readarr.Api.V1.Books.EditionResource": {
"type": "object",
"properties": {
"id": {
@@ -10018,19 +11183,19 @@
"images": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MediaCover"
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaCover.MediaCover"
},
"nullable": true
},
"links": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Links"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Links"
},
"nullable": true
},
"ratings": {
- "$ref": "#/components/schemas/Ratings"
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.Ratings"
},
"monitored": {
"type": "boolean"
@@ -10038,541 +11203,614 @@
"manualAdd": {
"type": "boolean"
},
- "book": {
- "$ref": "#/components/schemas/BookLazyLoaded"
+ "remoteCover": {
+ "type": "string",
+ "nullable": true
},
- "bookFiles": {
- "$ref": "#/components/schemas/BookFileListLazyLoaded"
+ "grabbed": {
+ "type": "boolean"
}
},
"additionalProperties": false
},
- "EditionLazyLoaded": {
+ "Readarr.Api.V1.Books.RenameBookResource": {
"type": "object",
"properties": {
- "value": {
- "$ref": "#/components/schemas/Edition"
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
+ "authorId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "bookId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "bookFileId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "existingPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "newPath": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "EditionListLazyLoaded": {
+ "Readarr.Api.V1.Books.RetagBookResource": {
"type": "object",
"properties": {
- "value": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "authorId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "bookId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "trackNumbers": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Edition"
+ "type": "integer",
+ "format": "int32"
},
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "isLoaded": {
+ "bookFileId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "path": {
+ "type": "string",
+ "nullable": true
+ },
+ "changes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.TagDifference"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Books.TagDifference": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string",
+ "nullable": true
+ },
+ "oldValue": {
+ "type": "string",
+ "nullable": true
+ },
+ "newValue": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Bookshelf.BookshelfAuthorResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "monitored": {
"type": "boolean",
- "readOnly": true
+ "nullable": true
+ },
+ "books": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Bookshelf.BookshelfResource": {
+ "type": "object",
+ "properties": {
+ "authors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Bookshelf.BookshelfAuthorResource"
+ },
+ "nullable": true
+ },
+ "monitoringOptions": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.MonitoringOptions"
+ },
+ "monitorNewItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.NewItemMonitorTypes"
}
},
"additionalProperties": false
},
- "EditionResource": {
+ "Readarr.Api.V1.Commands.CommandResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "bookId": {
- "type": "integer",
- "format": "int32"
- },
- "foreignEditionId": {
+ "name": {
"type": "string",
"nullable": true
},
- "titleSlug": {
+ "commandName": {
"type": "string",
"nullable": true
},
- "isbn13": {
+ "message": {
"type": "string",
"nullable": true
},
- "asin": {
- "type": "string",
- "nullable": true
+ "body": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Messaging.Commands.Command"
},
- "title": {
+ "priority": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Messaging.Commands.CommandPriority"
+ },
+ "status": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Messaging.Commands.CommandStatus"
+ },
+ "queued": {
"type": "string",
- "nullable": true
+ "format": "date-time"
},
- "language": {
+ "started": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "overview": {
+ "ended": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "format": {
+ "duration": {
+ "$ref": "#/components/schemas/System.TimeSpan"
+ },
+ "exception": {
"type": "string",
"nullable": true
},
- "isEbook": {
- "type": "boolean"
+ "trigger": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Messaging.Commands.CommandTrigger"
},
- "disambiguation": {
+ "clientUserAgent": {
"type": "string",
"nullable": true
},
- "publisher": {
+ "stateChangeTime": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "pageCount": {
- "type": "integer",
- "format": "int32"
+ "sendUpdatesToClient": {
+ "type": "boolean"
},
- "releaseDate": {
+ "updateScheduledTask": {
+ "type": "boolean"
+ },
+ "lastExecutionTime": {
"type": "string",
"format": "date-time",
"nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Config.DownloadClientConfigResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "images": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MediaCover"
- },
- "nullable": true
- },
- "links": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Links"
- },
+ "downloadClientWorkingFolders": {
+ "type": "string",
"nullable": true
},
- "ratings": {
- "$ref": "#/components/schemas/Ratings"
- },
- "monitored": {
+ "enableCompletedDownloadHandling": {
"type": "boolean"
},
- "manualAdd": {
+ "removeCompletedDownloads": {
"type": "boolean"
},
- "remoteCover": {
- "type": "string",
- "nullable": true
+ "autoRedownloadFailed": {
+ "type": "boolean"
},
- "grabbed": {
+ "removeFailedDownloads": {
"type": "boolean"
}
},
"additionalProperties": false
},
- "Field": {
+ "Readarr.Api.V1.Config.HostConfigResource": {
"type": "object",
"properties": {
- "order": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "bindAddress": {
"type": "string",
"nullable": true
},
- "label": {
+ "port": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sslPort": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "enableSsl": {
+ "type": "boolean"
+ },
+ "launchBrowser": {
+ "type": "boolean"
+ },
+ "authenticationMethod": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Authentication.AuthenticationType"
+ },
+ "analyticsEnabled": {
+ "type": "boolean"
+ },
+ "username": {
"type": "string",
"nullable": true
},
- "unit": {
+ "password": {
"type": "string",
"nullable": true
},
- "helpText": {
+ "logLevel": {
"type": "string",
"nullable": true
},
- "helpLink": {
+ "consoleLogLevel": {
"type": "string",
"nullable": true
},
- "value": {
+ "branch": {
+ "type": "string",
"nullable": true
},
- "type": {
+ "apiKey": {
"type": "string",
"nullable": true
},
- "advanced": {
- "type": "boolean"
- },
- "selectOptions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SelectOption"
- },
+ "sslCertPath": {
+ "type": "string",
"nullable": true
},
- "selectOptionsProviderAction": {
+ "sslCertPassword": {
"type": "string",
"nullable": true
},
- "section": {
+ "urlBase": {
"type": "string",
"nullable": true
},
- "hidden": {
+ "instanceName": {
"type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "FileDateType": {
- "enum": [
- "none",
- "bookReleaseDate"
- ],
- "type": "string"
- },
- "HealthCheckResult": {
- "enum": [
- "ok",
- "notice",
- "warning",
- "error"
- ],
- "type": "string"
- },
- "HealthResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
},
- "source": {
+ "applicationUrl": {
"type": "string",
"nullable": true
},
- "type": {
- "$ref": "#/components/schemas/HealthCheckResult"
+ "updateAutomatically": {
+ "type": "boolean"
},
- "message": {
+ "updateMechanism": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Update.UpdateMechanism"
+ },
+ "updateScriptPath": {
"type": "string",
"nullable": true
},
- "wikiUrl": {
- "$ref": "#/components/schemas/HttpUri"
- }
- },
- "additionalProperties": false
- },
- "HistoryEventType": {
- "enum": [
- "unknown",
- "grabbed",
- "authorFolderImported",
- "bookFileImported",
- "downloadFailed",
- "bookFileDeleted",
- "bookFileRenamed",
- "bookImportIncomplete",
- "downloadImported",
- "bookFileRetagged",
- "downloadIgnored"
- ],
- "type": "string"
- },
- "HistoryResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
+ "proxyEnabled": {
+ "type": "boolean"
},
- "bookId": {
- "type": "integer",
- "format": "int32"
+ "proxyType": {
+ "$ref": "#/components/schemas/NzbDrone.Common.Http.Proxy.ProxyType"
},
- "authorId": {
+ "proxyHostname": {
+ "type": "string",
+ "nullable": true
+ },
+ "proxyPort": {
"type": "integer",
"format": "int32"
},
- "sourceTitle": {
+ "proxyUsername": {
"type": "string",
"nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
- },
- "qualityCutoffNotMet": {
- "type": "boolean"
- },
- "date": {
+ "proxyPassword": {
"type": "string",
- "format": "date-time"
+ "nullable": true
},
- "downloadId": {
+ "proxyBypassFilter": {
"type": "string",
"nullable": true
},
- "eventType": {
- "$ref": "#/components/schemas/HistoryEventType"
+ "proxyBypassLocalAddresses": {
+ "type": "boolean"
},
- "data": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
+ "certificateValidation": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Security.CertificateValidationType"
+ },
+ "backupFolder": {
+ "type": "string",
"nullable": true
},
- "book": {
- "$ref": "#/components/schemas/BookResource"
+ "backupInterval": {
+ "type": "integer",
+ "format": "int32"
},
- "author": {
- "$ref": "#/components/schemas/AuthorResource"
+ "backupRetention": {
+ "type": "integer",
+ "format": "int32"
}
},
"additionalProperties": false
},
- "HistoryResourcePagingResource": {
+ "Readarr.Api.V1.Config.IndexerConfigResource": {
"type": "object",
"properties": {
- "page": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "pageSize": {
+ "minimumAge": {
"type": "integer",
"format": "int32"
},
- "sortKey": {
- "type": "string",
- "nullable": true
- },
- "sortDirection": {
- "$ref": "#/components/schemas/SortDirection"
+ "maximumSize": {
+ "type": "integer",
+ "format": "int32"
},
- "filters": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PagingResourceFilter"
- },
- "nullable": true
+ "retention": {
+ "type": "integer",
+ "format": "int32"
},
- "totalRecords": {
+ "rssSyncInterval": {
"type": "integer",
"format": "int32"
- },
- "records": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HistoryResource"
- },
- "nullable": true
}
},
"additionalProperties": false
},
- "HostConfigResource": {
+ "Readarr.Api.V1.Config.MediaManagementConfigResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "bindAddress": {
+ "autoUnmonitorPreviouslyDownloadedBooks": {
+ "type": "boolean"
+ },
+ "recycleBin": {
"type": "string",
"nullable": true
},
- "port": {
+ "recycleBinCleanupDays": {
"type": "integer",
"format": "int32"
},
- "sslPort": {
- "type": "integer",
- "format": "int32"
+ "downloadPropersAndRepacks": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.ProperDownloadTypes"
},
- "enableSsl": {
+ "createEmptyAuthorFolders": {
"type": "boolean"
},
- "launchBrowser": {
+ "deleteEmptyFolders": {
"type": "boolean"
},
- "authenticationMethod": {
- "$ref": "#/components/schemas/AuthenticationType"
+ "fileDate": {
+ "$ref": "#/components/schemas/NzbDrone.Core.MediaFiles.FileDateType"
},
- "analyticsEnabled": {
+ "watchLibraryForChanges": {
"type": "boolean"
},
- "username": {
- "type": "string",
- "nullable": true
- },
- "password": {
- "type": "string",
- "nullable": true
- },
- "logLevel": {
- "type": "string",
- "nullable": true
+ "rescanAfterRefresh": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Configuration.RescanAfterRefreshType"
},
- "consoleLogLevel": {
- "type": "string",
- "nullable": true
+ "allowFingerprinting": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Configuration.AllowFingerprinting"
},
- "branch": {
- "type": "string",
- "nullable": true
+ "setPermissionsLinux": {
+ "type": "boolean"
},
- "apiKey": {
+ "chmodFolder": {
"type": "string",
"nullable": true
},
- "sslCertPath": {
+ "chownGroup": {
"type": "string",
"nullable": true
},
- "sslCertPassword": {
- "type": "string",
- "nullable": true
+ "skipFreeSpaceCheckWhenImporting": {
+ "type": "boolean"
},
- "urlBase": {
- "type": "string",
- "nullable": true
+ "minimumFreeSpaceWhenImporting": {
+ "type": "integer",
+ "format": "int32"
},
- "updateAutomatically": {
+ "copyUsingHardlinks": {
"type": "boolean"
},
- "updateMechanism": {
- "$ref": "#/components/schemas/UpdateMechanism"
+ "importExtraFiles": {
+ "type": "boolean"
},
- "updateScriptPath": {
+ "extraFileExtensions": {
"type": "string",
"nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Config.MetadataProviderConfigResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "proxyEnabled": {
+ "writeAudioTags": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Configuration.WriteAudioTagsType"
+ },
+ "scrubAudioTags": {
"type": "boolean"
},
- "proxyType": {
- "$ref": "#/components/schemas/ProxyType"
+ "writeBookTags": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Configuration.WriteBookTagsType"
},
- "proxyHostname": {
- "type": "string",
- "nullable": true
+ "updateCovers": {
+ "type": "boolean"
},
- "proxyPort": {
+ "embedMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Config.NamingConfigResource": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "proxyUsername": {
- "type": "string",
- "nullable": true
+ "renameBooks": {
+ "type": "boolean"
},
- "proxyPassword": {
+ "replaceIllegalCharacters": {
+ "type": "boolean"
+ },
+ "standardBookFormat": {
"type": "string",
"nullable": true
},
- "proxyBypassFilter": {
+ "authorFolderFormat": {
"type": "string",
"nullable": true
},
- "proxyBypassLocalAddresses": {
+ "includeAuthorName": {
"type": "boolean"
},
- "certificateValidation": {
- "$ref": "#/components/schemas/CertificateValidationType"
+ "includeBookTitle": {
+ "type": "boolean"
},
- "backupFolder": {
+ "includeQuality": {
+ "type": "boolean"
+ },
+ "replaceSpaces": {
+ "type": "boolean"
+ },
+ "separator": {
"type": "string",
"nullable": true
},
- "backupInterval": {
- "type": "integer",
- "format": "int32"
- },
- "backupRetention": {
- "type": "integer",
- "format": "int32"
+ "numberStyle": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "HttpUri": {
+ "Readarr.Api.V1.Config.UiConfigResource": {
"type": "object",
"properties": {
- "fullUri": {
- "type": "string",
- "nullable": true,
- "readOnly": true
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "scheme": {
- "type": "string",
- "nullable": true,
- "readOnly": true
+ "firstDayOfWeek": {
+ "type": "integer",
+ "format": "int32"
},
- "host": {
+ "calendarWeekColumnHeader": {
"type": "string",
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "port": {
- "type": "integer",
- "format": "int32",
- "nullable": true,
- "readOnly": true
+ "shortDateFormat": {
+ "type": "string",
+ "nullable": true
},
- "path": {
+ "longDateFormat": {
"type": "string",
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "query": {
+ "timeFormat": {
"type": "string",
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "fragment": {
+ "showRelativeDates": {
+ "type": "boolean"
+ },
+ "enableColorImpairedMode": {
+ "type": "boolean"
+ },
+ "uiLanguage": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "theme": {
"type": "string",
- "nullable": true,
- "readOnly": true
+ "nullable": true
}
},
"additionalProperties": false
},
- "ImportListExclusionResource": {
+ "Readarr.Api.V1.CustomFilters.CustomFilterResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "foreignId": {
+ "type": {
"type": "string",
"nullable": true
},
- "authorName": {
+ "label": {
"type": "string",
"nullable": true
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": { }
+ },
+ "nullable": true
}
},
"additionalProperties": false
},
- "ImportListMonitorType": {
- "enum": [
- "none",
- "specificBook",
- "entireAuthor"
- ],
- "type": "string"
- },
- "ImportListResource": {
+ "Readarr.Api.V1.CustomFormats.CustomFormatResource": {
"type": "object",
"properties": {
"id": {
@@ -10583,14 +11821,28 @@
"type": "string",
"nullable": true
},
- "fields": {
+ "includeCustomFormatWhenRenaming": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "specifications": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Field"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatSpecificationSchema"
},
"nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.CustomFormats.CustomFormatSpecificationSchema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "implementationName": {
+ "name": {
"type": "string",
"nullable": true
},
@@ -10598,7 +11850,7 @@
"type": "string",
"nullable": true
},
- "configContract": {
+ "implementationName": {
"type": "string",
"nullable": true
},
@@ -10606,91 +11858,56 @@
"type": "string",
"nullable": true
},
- "message": {
- "$ref": "#/components/schemas/ProviderMessage"
+ "negate": {
+ "type": "boolean"
},
- "tags": {
- "uniqueItems": true,
+ "required": {
+ "type": "boolean"
+ },
+ "fields": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
},
"nullable": true
},
"presets": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ImportListResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatSpecificationSchema"
},
"nullable": true
- },
- "enableAutomaticAdd": {
- "type": "boolean"
- },
- "shouldMonitor": {
- "$ref": "#/components/schemas/ImportListMonitorType"
- },
- "shouldSearch": {
- "type": "boolean"
- },
- "rootFolderPath": {
- "type": "string",
- "nullable": true
- },
- "qualityProfileId": {
- "type": "integer",
- "format": "int32"
- },
- "metadataProfileId": {
- "type": "integer",
- "format": "int32"
- },
- "listType": {
- "$ref": "#/components/schemas/ImportListType"
- },
- "listOrder": {
- "type": "integer",
- "format": "int32"
}
},
"additionalProperties": false
},
- "ImportListType": {
- "enum": [
- "program",
- "goodreads",
- "other"
- ],
- "type": "string"
- },
- "IndexerConfigResource": {
+ "Readarr.Api.V1.DiskSpace.DiskSpaceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "minimumAge": {
- "type": "integer",
- "format": "int32"
+ "path": {
+ "type": "string",
+ "nullable": true
},
- "maximumSize": {
- "type": "integer",
- "format": "int32"
+ "label": {
+ "type": "string",
+ "nullable": true
},
- "retention": {
+ "freeSpace": {
"type": "integer",
- "format": "int32"
+ "format": "int64"
},
- "rssSyncInterval": {
+ "totalSpace": {
"type": "integer",
- "format": "int32"
+ "format": "int64"
}
},
"additionalProperties": false
},
- "IndexerResource": {
+ "Readarr.Api.V1.DownloadClient.DownloadClientResource": {
"type": "object",
"properties": {
"id": {
@@ -10704,7 +11921,7 @@
"fields": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Field"
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
},
"nullable": true
},
@@ -10725,7 +11942,7 @@
"nullable": true
},
"message": {
- "$ref": "#/components/schemas/ProviderMessage"
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessage"
},
"tags": {
"uniqueItems": true,
@@ -10739,27 +11956,15 @@
"presets": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/IndexerResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.DownloadClient.DownloadClientResource"
},
"nullable": true
},
- "enableRss": {
- "type": "boolean"
- },
- "enableAutomaticSearch": {
- "type": "boolean"
- },
- "enableInteractiveSearch": {
- "type": "boolean"
- },
- "supportsRss": {
- "type": "boolean"
- },
- "supportsSearch": {
+ "enable": {
"type": "boolean"
},
"protocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.DownloadProtocol"
},
"priority": {
"type": "integer",
@@ -10768,634 +11973,645 @@
},
"additionalProperties": false
},
- "IsoCountry": {
+ "Readarr.Api.V1.Health.HealthResource": {
"type": "object",
"properties": {
- "twoLetterCode": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "source": {
"type": "string",
"nullable": true
},
- "name": {
+ "type": {
+ "$ref": "#/components/schemas/NzbDrone.Core.HealthCheck.HealthCheckResult"
+ },
+ "message": {
"type": "string",
"nullable": true
+ },
+ "wikiUrl": {
+ "$ref": "#/components/schemas/NzbDrone.Common.Http.HttpUri"
}
},
"additionalProperties": false
},
- "LanguageResource": {
+ "Readarr.Api.V1.History.HistoryResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "bookId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "authorId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sourceTitle": {
"type": "string",
"nullable": true
},
- "nameLower": {
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "customFormats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
+ },
+ "nullable": true
+ },
+ "qualityCutoffNotMet": {
+ "type": "boolean"
+ },
+ "date": {
"type": "string",
- "nullable": true,
- "readOnly": true
- }
- },
- "additionalProperties": false
- },
- "Links": {
- "type": "object",
- "properties": {
- "url": {
+ "format": "date-time"
+ },
+ "downloadId": {
"type": "string",
"nullable": true
},
- "name": {
- "type": "string",
+ "eventType": {
+ "$ref": "#/components/schemas/NzbDrone.Core.History.EntityHistoryEventType"
+ },
+ "data": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "nullable": true
+ },
"nullable": true
+ },
+ "book": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
+ },
+ "author": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
}
},
"additionalProperties": false
},
- "LogFileResource": {
+ "Readarr.Api.V1.ImportLists.ImportListExclusionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "filename": {
- "type": "string",
- "nullable": true
- },
- "lastWriteTime": {
- "type": "string",
- "format": "date-time"
- },
- "contentsUrl": {
+ "foreignId": {
"type": "string",
"nullable": true
},
- "downloadUrl": {
+ "authorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
- "LogResource": {
+ "Readarr.Api.V1.ImportLists.ImportListResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "time": {
- "type": "string",
- "format": "date-time"
- },
- "exception": {
+ "name": {
"type": "string",
"nullable": true
},
- "exceptionType": {
- "type": "string",
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
+ },
"nullable": true
},
- "level": {
+ "implementationName": {
"type": "string",
"nullable": true
},
- "logger": {
+ "implementation": {
"type": "string",
"nullable": true
},
- "message": {
+ "configContract": {
"type": "string",
"nullable": true
},
- "method": {
+ "infoLink": {
"type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "LogResourcePagingResource": {
- "type": "object",
- "properties": {
- "page": {
- "type": "integer",
- "format": "int32"
},
- "pageSize": {
- "type": "integer",
- "format": "int32"
+ "message": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessage"
},
- "sortKey": {
- "type": "string",
+ "tags": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
"nullable": true
},
- "sortDirection": {
- "$ref": "#/components/schemas/SortDirection"
- },
- "filters": {
+ "presets": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PagingResourceFilter"
+ "$ref": "#/components/schemas/Readarr.Api.V1.ImportLists.ImportListResource"
},
"nullable": true
},
- "totalRecords": {
+ "enableAutomaticAdd": {
+ "type": "boolean"
+ },
+ "shouldMonitor": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ImportLists.ImportListMonitorType"
+ },
+ "shouldMonitorExisting": {
+ "type": "boolean"
+ },
+ "shouldSearch": {
+ "type": "boolean"
+ },
+ "rootFolderPath": {
+ "type": "string",
+ "nullable": true
+ },
+ "monitorNewItems": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.NewItemMonitorTypes"
+ },
+ "qualityProfileId": {
"type": "integer",
"format": "int32"
},
- "records": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LogResource"
- },
- "nullable": true
+ "metadataProfileId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "listType": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ImportLists.ImportListType"
+ },
+ "listOrder": {
+ "type": "integer",
+ "format": "int32"
}
},
"additionalProperties": false
},
- "ManualImportResource": {
+ "Readarr.Api.V1.Indexers.IndexerResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "path": {
- "type": "string",
- "nullable": true
- },
"name": {
"type": "string",
"nullable": true
},
- "size": {
- "type": "integer",
- "format": "int64"
- },
- "author": {
- "$ref": "#/components/schemas/AuthorResource"
- },
- "book": {
- "$ref": "#/components/schemas/BookResource"
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
+ },
+ "nullable": true
},
- "foreignEditionId": {
+ "implementationName": {
"type": "string",
"nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "implementation": {
+ "type": "string",
+ "nullable": true
},
- "qualityWeight": {
- "type": "integer",
- "format": "int32"
+ "configContract": {
+ "type": "string",
+ "nullable": true
},
- "downloadId": {
+ "infoLink": {
"type": "string",
"nullable": true
},
- "rejections": {
+ "message": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessage"
+ },
+ "tags": {
+ "uniqueItems": true,
"type": "array",
"items": {
- "$ref": "#/components/schemas/Rejection"
+ "type": "integer",
+ "format": "int32"
},
"nullable": true
},
- "audioTags": {
- "$ref": "#/components/schemas/ParsedTrackInfo"
+ "presets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Indexers.IndexerResource"
+ },
+ "nullable": true
},
- "additionalFile": {
+ "enableRss": {
"type": "boolean"
},
- "replaceExistingFiles": {
+ "enableAutomaticSearch": {
"type": "boolean"
},
- "disableReleaseSwitching": {
+ "enableInteractiveSearch": {
"type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "MediaCover": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "nullable": true
},
- "coverType": {
- "$ref": "#/components/schemas/MediaCoverTypes"
+ "supportsRss": {
+ "type": "boolean"
},
- "extension": {
- "type": "string",
- "nullable": true,
- "readOnly": true
+ "supportsSearch": {
+ "type": "boolean"
+ },
+ "protocol": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.DownloadProtocol"
+ },
+ "priority": {
+ "type": "integer",
+ "format": "int32"
}
},
"additionalProperties": false
},
- "MediaCoverTypes": {
- "enum": [
- "unknown",
- "poster",
- "banner",
- "fanart",
- "screenshot",
- "headshot",
- "cover",
- "disc",
- "logo"
- ],
- "type": "string"
- },
- "MediaInfoModel": {
+ "Readarr.Api.V1.Indexers.ReleaseResource": {
"type": "object",
"properties": {
- "audioFormat": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "guid": {
"type": "string",
"nullable": true
},
- "audioBitrate": {
- "type": "integer",
- "format": "int32"
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
},
- "audioChannels": {
+ "qualityWeight": {
"type": "integer",
"format": "int32"
},
- "audioBits": {
+ "age": {
"type": "integer",
"format": "int32"
},
- "audioSampleRate": {
+ "ageHours": {
+ "type": "number",
+ "format": "double"
+ },
+ "ageMinutes": {
+ "type": "number",
+ "format": "double"
+ },
+ "size": {
"type": "integer",
- "format": "int32"
- }
- },
- "additionalProperties": false
- },
- "MediaInfoResource": {
- "type": "object",
- "properties": {
- "id": {
+ "format": "int64"
+ },
+ "indexerId": {
"type": "integer",
"format": "int32"
},
- "audioChannels": {
- "type": "number",
- "format": "double"
+ "indexer": {
+ "type": "string",
+ "nullable": true
},
- "audioBitRate": {
+ "releaseGroup": {
"type": "string",
"nullable": true
},
- "audioCodec": {
+ "subGroup": {
"type": "string",
"nullable": true
},
- "audioBits": {
+ "releaseHash": {
"type": "string",
"nullable": true
},
- "audioSampleRate": {
+ "title": {
"type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "MediaManagementConfigResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
},
- "autoUnmonitorPreviouslyDownloadedBooks": {
+ "discography": {
"type": "boolean"
},
- "recycleBin": {
+ "sceneSource": {
+ "type": "boolean"
+ },
+ "airDate": {
"type": "string",
"nullable": true
},
- "recycleBinCleanupDays": {
- "type": "integer",
- "format": "int32"
+ "authorName": {
+ "type": "string",
+ "nullable": true
},
- "downloadPropersAndRepacks": {
- "$ref": "#/components/schemas/ProperDownloadTypes"
+ "bookTitle": {
+ "type": "string",
+ "nullable": true
},
- "createEmptyAuthorFolders": {
+ "approved": {
"type": "boolean"
},
- "deleteEmptyFolders": {
+ "temporarilyRejected": {
"type": "boolean"
},
- "fileDate": {
- "$ref": "#/components/schemas/FileDateType"
- },
- "watchLibraryForChanges": {
+ "rejected": {
"type": "boolean"
},
- "rescanAfterRefresh": {
- "$ref": "#/components/schemas/RescanAfterRefreshType"
+ "rejections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
},
- "allowFingerprinting": {
- "$ref": "#/components/schemas/AllowFingerprinting"
+ "publishDate": {
+ "type": "string",
+ "format": "date-time"
},
- "setPermissionsLinux": {
- "type": "boolean"
+ "commentUrl": {
+ "type": "string",
+ "nullable": true
},
- "chmodFolder": {
+ "downloadUrl": {
"type": "string",
"nullable": true
},
- "chownGroup": {
+ "infoUrl": {
"type": "string",
"nullable": true
},
- "skipFreeSpaceCheckWhenImporting": {
+ "downloadAllowed": {
"type": "boolean"
},
- "minimumFreeSpaceWhenImporting": {
+ "releaseWeight": {
"type": "integer",
"format": "int32"
},
- "copyUsingHardlinks": {
- "type": "boolean"
- },
- "importExtraFiles": {
- "type": "boolean"
- },
- "extraFileExtensions": {
- "type": "string",
+ "customFormats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
+ },
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "MetadataProfile": {
- "type": "object",
- "properties": {
- "id": {
+ },
+ "customFormatScore": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "magnetUrl": {
"type": "string",
"nullable": true
},
- "minPopularity": {
- "type": "number",
- "format": "double"
- },
- "skipMissingDate": {
- "type": "boolean"
+ "infoHash": {
+ "type": "string",
+ "nullable": true
},
- "skipMissingIsbn": {
- "type": "boolean"
+ "seeders": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
},
- "skipPartsAndSets": {
- "type": "boolean"
+ "leechers": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
},
- "skipSeriesSecondary": {
- "type": "boolean"
+ "protocol": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.DownloadProtocol"
},
- "allowedLanguages": {
- "type": "string",
+ "authorId": {
+ "type": "integer",
+ "format": "int32",
"nullable": true
},
- "minPages": {
+ "bookId": {
"type": "integer",
- "format": "int32"
- },
- "ignored": {
- "type": "string",
+ "format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
- "MetadataProfileLazyLoaded": {
+ "Readarr.Api.V1.Languages.LanguageResource": {
"type": "object",
"properties": {
- "value": {
- "$ref": "#/components/schemas/MetadataProfile"
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "isLoaded": {
- "type": "boolean",
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "nameLower": {
+ "type": "string",
+ "nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
- "MetadataProfileResource": {
+ "Readarr.Api.V1.Logs.LogFileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "filename": {
"type": "string",
"nullable": true
},
- "minPopularity": {
- "type": "number",
- "format": "double"
- },
- "skipMissingDate": {
- "type": "boolean"
- },
- "skipMissingIsbn": {
- "type": "boolean"
- },
- "skipPartsAndSets": {
- "type": "boolean"
- },
- "skipSeriesSecondary": {
- "type": "boolean"
+ "lastWriteTime": {
+ "type": "string",
+ "format": "date-time"
},
- "allowedLanguages": {
+ "contentsUrl": {
"type": "string",
"nullable": true
},
- "minPages": {
- "type": "integer",
- "format": "int32"
- },
- "ignored": {
+ "downloadUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
- "MetadataProviderConfigResource": {
+ "Readarr.Api.V1.Logs.LogResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "writeAudioTags": {
- "$ref": "#/components/schemas/WriteAudioTagsType"
+ "time": {
+ "type": "string",
+ "format": "date-time"
},
- "scrubAudioTags": {
- "type": "boolean"
+ "exception": {
+ "type": "string",
+ "nullable": true
},
- "writeBookTags": {
- "$ref": "#/components/schemas/WriteBookTagsType"
+ "exceptionType": {
+ "type": "string",
+ "nullable": true
},
- "updateCovers": {
- "type": "boolean"
+ "level": {
+ "type": "string",
+ "nullable": true
},
- "embedMetadata": {
- "type": "boolean"
+ "logger": {
+ "type": "string",
+ "nullable": true
+ },
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "method": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "MetadataResource": {
+ "Readarr.Api.V1.ManualImport.ManualImportResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
+ "path": {
+ "type": "string",
+ "nullable": true
+ },
"name": {
"type": "string",
"nullable": true
},
- "fields": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Field"
- },
- "nullable": true
+ "size": {
+ "type": "integer",
+ "format": "int64"
},
- "implementationName": {
- "type": "string",
- "nullable": true
+ "author": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
},
- "implementation": {
- "type": "string",
- "nullable": true
+ "book": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
},
- "configContract": {
+ "foreignEditionId": {
"type": "string",
"nullable": true
},
- "infoLink": {
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "releaseGroup": {
"type": "string",
"nullable": true
},
- "message": {
- "$ref": "#/components/schemas/ProviderMessage"
+ "qualityWeight": {
+ "type": "integer",
+ "format": "int32"
},
- "tags": {
- "uniqueItems": true,
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
+ "downloadId": {
+ "type": "string",
"nullable": true
},
- "presets": {
+ "rejections": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/MetadataResource"
+ "$ref": "#/components/schemas/NzbDrone.Core.DecisionEngine.Rejection"
},
"nullable": true
},
- "enable": {
+ "audioTags": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.ParsedTrackInfo"
+ },
+ "additionalFile": {
"type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "MonitoringOptions": {
- "type": "object",
- "properties": {
- "monitor": {
- "$ref": "#/components/schemas/MonitorTypes"
},
- "booksToMonitor": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "nullable": true
+ "replaceExistingFiles": {
+ "type": "boolean"
},
- "monitored": {
+ "disableReleaseSwitching": {
"type": "boolean"
}
},
"additionalProperties": false
},
- "MonitorTypes": {
- "enum": [
- "all",
- "future",
- "missing",
- "existing",
- "latest",
- "first",
- "none",
- "unknown"
- ],
- "type": "string"
- },
- "NamingConfigResource": {
+ "Readarr.Api.V1.ManualImport.ManualImportUpdateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "renameBooks": {
- "type": "boolean"
+ "path": {
+ "type": "string",
+ "nullable": true
},
- "replaceIllegalCharacters": {
- "type": "boolean"
+ "name": {
+ "type": "string",
+ "nullable": true
},
- "standardBookFormat": {
+ "authorId": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "bookId": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "foreignEditionId": {
"type": "string",
"nullable": true
},
- "authorFolderFormat": {
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "releaseGroup": {
"type": "string",
"nullable": true
},
- "includeAuthorName": {
- "type": "boolean"
+ "downloadId": {
+ "type": "string",
+ "nullable": true
},
- "includeBookTitle": {
+ "additionalFile": {
"type": "boolean"
},
- "includeQuality": {
+ "replaceExistingFiles": {
"type": "boolean"
},
- "replaceSpaces": {
+ "disableReleaseSwitching": {
"type": "boolean"
},
- "separator": {
- "type": "string",
- "nullable": true
- },
- "numberStyle": {
- "type": "string",
+ "rejections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NzbDrone.Core.DecisionEngine.Rejection"
+ },
"nullable": true
}
},
"additionalProperties": false
},
- "NotificationResource": {
+ "Readarr.Api.V1.Metadata.MetadataResource": {
"type": "object",
"properties": {
"id": {
@@ -11409,7 +12625,7 @@
"fields": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Field"
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
},
"nullable": true
},
@@ -11430,7 +12646,7 @@
"nullable": true
},
"message": {
- "$ref": "#/components/schemas/ProviderMessage"
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessage"
},
"tags": {
"uniqueItems": true,
@@ -11444,268 +12660,162 @@
"presets": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/NotificationResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Metadata.MetadataResource"
},
"nullable": true
},
- "link": {
- "type": "string",
- "nullable": true
- },
- "onGrab": {
- "type": "boolean"
- },
- "onReleaseImport": {
- "type": "boolean"
- },
- "onUpgrade": {
- "type": "boolean"
- },
- "onRename": {
- "type": "boolean"
- },
- "onHealthIssue": {
- "type": "boolean"
- },
- "onDownloadFailure": {
- "type": "boolean"
- },
- "onImportFailure": {
- "type": "boolean"
- },
- "onBookRetag": {
- "type": "boolean"
- },
- "supportsOnGrab": {
- "type": "boolean"
- },
- "supportsOnReleaseImport": {
- "type": "boolean"
- },
- "supportsOnUpgrade": {
- "type": "boolean"
- },
- "supportsOnRename": {
- "type": "boolean"
- },
- "supportsOnHealthIssue": {
- "type": "boolean"
- },
- "includeHealthWarnings": {
- "type": "boolean"
- },
- "supportsOnDownloadFailure": {
- "type": "boolean"
- },
- "supportsOnImportFailure": {
- "type": "boolean"
- },
- "supportsOnBookRetag": {
+ "enable": {
"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
},
- "ParsedBookInfo": {
+ "Readarr.Api.V1.Notifications.NotificationResource": {
"type": "object",
"properties": {
- "bookTitle": {
- "type": "string",
- "nullable": true
- },
- "authorName": {
- "type": "string",
- "nullable": true
- },
- "authorTitleInfo": {
- "$ref": "#/components/schemas/AuthorTitleInfo"
- },
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
- },
- "releaseDate": {
- "type": "string",
- "nullable": true
- },
- "discography": {
- "type": "boolean"
- },
- "discographyStart": {
- "type": "integer",
- "format": "int32"
- },
- "discographyEnd": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "releaseGroup": {
- "type": "string",
- "nullable": true
- },
- "releaseHash": {
- "type": "string",
- "nullable": true
- },
- "releaseVersion": {
- "type": "string",
- "nullable": true
- }
- },
- "additionalProperties": false
- },
- "ParsedTrackInfo": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "nullable": true
- },
- "cleanTitle": {
+ "name": {
"type": "string",
"nullable": true
},
- "authors": {
+ "fields": {
"type": "array",
"items": {
- "type": "string"
- },
- "nullable": true
- },
- "authorTitle": {
- "type": "string",
- "nullable": true,
- "readOnly": true
- },
- "bookTitle": {
- "type": "string",
- "nullable": true
- },
- "seriesTitle": {
- "type": "string",
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.Field"
+ },
"nullable": true
},
- "seriesIndex": {
+ "implementationName": {
"type": "string",
"nullable": true
},
- "isbn": {
+ "implementation": {
"type": "string",
"nullable": true
},
- "asin": {
+ "configContract": {
"type": "string",
"nullable": true
},
- "goodreadsId": {
+ "infoLink": {
"type": "string",
"nullable": true
},
- "authorMBId": {
- "type": "string",
- "nullable": true
+ "message": {
+ "$ref": "#/components/schemas/NzbDrone.Core.ThingiProvider.ProviderMessage"
},
- "bookMBId": {
- "type": "string",
+ "tags": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
"nullable": true
},
- "releaseMBId": {
- "type": "string",
+ "presets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Notifications.NotificationResource"
+ },
"nullable": true
},
- "recordingMBId": {
+ "link": {
"type": "string",
"nullable": true
},
- "trackMBId": {
- "type": "string",
- "nullable": true
+ "onGrab": {
+ "type": "boolean"
},
- "discNumber": {
- "type": "integer",
- "format": "int32"
+ "onReleaseImport": {
+ "type": "boolean"
},
- "discCount": {
- "type": "integer",
- "format": "int32"
+ "onUpgrade": {
+ "type": "boolean"
},
- "country": {
- "$ref": "#/components/schemas/IsoCountry"
+ "onRename": {
+ "type": "boolean"
},
- "year": {
- "type": "integer",
- "format": "int32"
+ "onAuthorDelete": {
+ "type": "boolean"
},
- "publisher": {
- "type": "string",
- "nullable": true
+ "onBookDelete": {
+ "type": "boolean"
},
- "label": {
- "type": "string",
- "nullable": true
+ "onBookFileDelete": {
+ "type": "boolean"
},
- "source": {
- "type": "string",
- "nullable": true
+ "onBookFileDeleteForUpgrade": {
+ "type": "boolean"
},
- "catalogNumber": {
- "type": "string",
- "nullable": true
+ "onHealthIssue": {
+ "type": "boolean"
},
- "disambiguation": {
- "type": "string",
- "nullable": true
+ "onDownloadFailure": {
+ "type": "boolean"
},
- "duration": {
- "$ref": "#/components/schemas/TimeSpan"
+ "onImportFailure": {
+ "type": "boolean"
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "onBookRetag": {
+ "type": "boolean"
},
- "mediaInfo": {
- "$ref": "#/components/schemas/MediaInfoModel"
+ "onApplicationUpdate": {
+ "type": "boolean"
},
- "trackNumbers": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "nullable": true
+ "supportsOnGrab": {
+ "type": "boolean"
},
- "language": {
- "type": "string",
- "nullable": true
+ "supportsOnReleaseImport": {
+ "type": "boolean"
},
- "releaseGroup": {
- "type": "string",
- "nullable": true
+ "supportsOnUpgrade": {
+ "type": "boolean"
},
- "releaseHash": {
+ "supportsOnRename": {
+ "type": "boolean"
+ },
+ "supportsOnAuthorDelete": {
+ "type": "boolean"
+ },
+ "supportsOnBookDelete": {
+ "type": "boolean"
+ },
+ "supportsOnBookFileDelete": {
+ "type": "boolean"
+ },
+ "supportsOnBookFileDeleteForUpgrade": {
+ "type": "boolean"
+ },
+ "supportsOnHealthIssue": {
+ "type": "boolean"
+ },
+ "includeHealthWarnings": {
+ "type": "boolean"
+ },
+ "supportsOnDownloadFailure": {
+ "type": "boolean"
+ },
+ "supportsOnImportFailure": {
+ "type": "boolean"
+ },
+ "supportsOnBookRetag": {
+ "type": "boolean"
+ },
+ "supportsOnApplicationUpdate": {
+ "type": "boolean"
+ },
+ "testCommand": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
- "ParseResource": {
+ "Readarr.Api.V1.Parse.ParseResource": {
"type": "object",
"properties": {
"id": {
@@ -11717,59 +12827,72 @@
"nullable": true
},
"parsedBookInfo": {
- "$ref": "#/components/schemas/ParsedBookInfo"
+ "$ref": "#/components/schemas/NzbDrone.Core.Parser.Model.ParsedBookInfo"
},
"author": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
},
"books": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
},
"nullable": true
}
},
"additionalProperties": false
},
- "ProperDownloadTypes": {
- "enum": [
- "preferAndUpgrade",
- "doNotUpgrade",
- "doNotPrefer"
- ],
- "type": "string"
- },
- "ProviderMessage": {
+ "Readarr.Api.V1.Profiles.Delay.DelayProfileResource": {
"type": "object",
"properties": {
- "message": {
- "type": "string",
- "nullable": true
+ "id": {
+ "type": "integer",
+ "format": "int32"
},
- "type": {
- "$ref": "#/components/schemas/ProviderMessageType"
+ "enableUsenet": {
+ "type": "boolean"
+ },
+ "enableTorrent": {
+ "type": "boolean"
+ },
+ "preferredProtocol": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.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
},
- "ProviderMessageType": {
- "enum": [
- "info",
- "warning",
- "error"
- ],
- "type": "string"
- },
- "ProxyType": {
- "enum": [
- "http",
- "socks4",
- "socks5"
- ],
- "type": "string"
- },
- "Quality": {
+ "Readarr.Api.V1.Profiles.Metadata.MetadataProfileResource": {
"type": "object",
"properties": {
"id": {
@@ -11779,54 +12902,88 @@
"name": {
"type": "string",
"nullable": true
+ },
+ "minPopularity": {
+ "type": "number",
+ "format": "double"
+ },
+ "skipMissingDate": {
+ "type": "boolean"
+ },
+ "skipMissingIsbn": {
+ "type": "boolean"
+ },
+ "skipPartsAndSets": {
+ "type": "boolean"
+ },
+ "skipSeriesSecondary": {
+ "type": "boolean"
+ },
+ "allowedLanguages": {
+ "type": "string",
+ "nullable": true
+ },
+ "minPages": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "ignored": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "QualityDefinitionResource": {
+ "Readarr.Api.V1.Profiles.Quality.ProfileFormatItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "quality": {
- "$ref": "#/components/schemas/Quality"
+ "format": {
+ "type": "integer",
+ "format": "int32"
},
- "title": {
+ "name": {
"type": "string",
"nullable": true
},
- "weight": {
+ "score": {
"type": "integer",
"format": "int32"
- },
- "minSize": {
- "type": "number",
- "format": "double",
- "nullable": true
- },
- "maxSize": {
- "type": "number",
- "format": "double",
- "nullable": true
}
},
"additionalProperties": false
},
- "QualityModel": {
+ "Readarr.Api.V1.Profiles.Quality.QualityProfileQualityItemResource": {
"type": "object",
"properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
"quality": {
- "$ref": "#/components/schemas/Quality"
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.Quality"
},
- "revision": {
- "$ref": "#/components/schemas/Revision"
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileQualityItemResource"
+ },
+ "nullable": true
+ },
+ "allowed": {
+ "type": "boolean"
}
},
"additionalProperties": false
},
- "QualityProfile": {
+ "Readarr.Api.V1.Profiles.Quality.QualityProfileResource": {
"type": "object",
"properties": {
"id": {
@@ -11847,109 +13004,100 @@
"items": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileQualityItem"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.QualityProfileQualityItemResource"
},
"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": {
+ "minFormatScore": {
"type": "integer",
"format": "int32"
},
- "name": {
- "type": "string",
- "nullable": true
- },
- "quality": {
- "$ref": "#/components/schemas/Quality"
+ "cutoffFormatScore": {
+ "type": "integer",
+ "format": "int32"
},
- "items": {
+ "formatItems": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileQualityItem"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Profiles.Quality.ProfileFormatItemResource"
},
"nullable": true
- },
- "allowed": {
- "type": "boolean"
}
},
"additionalProperties": false
},
- "QualityProfileQualityItemResource": {
+ "Readarr.Api.V1.Profiles.Release.ReleaseProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
- "type": "string",
- "nullable": true
+ "enabled": {
+ "type": "boolean"
},
- "quality": {
- "$ref": "#/components/schemas/Quality"
+ "required": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
},
- "items": {
+ "ignored": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/QualityProfileQualityItemResource"
+ "type": "string"
},
"nullable": true
},
- "allowed": {
- "type": "boolean"
+ "indexerId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "tags": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
}
},
"additionalProperties": false
},
- "QualityProfileResource": {
+ "Readarr.Api.V1.Qualities.QualityDefinitionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "quality": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.Quality"
+ },
+ "title": {
"type": "string",
"nullable": true
},
- "upgradeAllowed": {
- "type": "boolean"
- },
- "cutoff": {
+ "weight": {
"type": "integer",
"format": "int32"
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QualityProfileQualityItemResource"
- },
+ "minSize": {
+ "type": "number",
+ "format": "double",
+ "nullable": true
+ },
+ "maxSize": {
+ "type": "number",
+ "format": "double",
"nullable": true
}
},
"additionalProperties": false
},
- "QueueBulkResource": {
+ "Readarr.Api.V1.Queue.QueueBulkResource": {
"type": "object",
"properties": {
"ids": {
@@ -11963,7 +13111,7 @@
},
"additionalProperties": false
},
- "QueueResource": {
+ "Readarr.Api.V1.Queue.QueueResource": {
"type": "object",
"properties": {
"id": {
@@ -11981,13 +13129,20 @@
"nullable": true
},
"author": {
- "$ref": "#/components/schemas/AuthorResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Author.AuthorResource"
},
"book": {
- "$ref": "#/components/schemas/BookResource"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
},
"quality": {
- "$ref": "#/components/schemas/QualityModel"
+ "$ref": "#/components/schemas/NzbDrone.Core.Qualities.QualityModel"
+ },
+ "customFormats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.CustomFormats.CustomFormatResource"
+ },
+ "nullable": true
},
"size": {
"type": "number",
@@ -12002,7 +13157,7 @@
"format": "double"
},
"timeleft": {
- "$ref": "#/components/schemas/TimeSpan"
+ "$ref": "#/components/schemas/System.TimeSpan"
},
"estimatedCompletionTime": {
"type": "string",
@@ -12014,15 +13169,15 @@
"nullable": true
},
"trackedDownloadStatus": {
- "$ref": "#/components/schemas/TrackedDownloadStatus"
+ "$ref": "#/components/schemas/NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadStatus"
},
"trackedDownloadState": {
- "$ref": "#/components/schemas/TrackedDownloadState"
+ "$ref": "#/components/schemas/NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadState"
},
"statusMessages": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TrackedDownloadStatusMessage"
+ "$ref": "#/components/schemas/NzbDrone.Core.Download.TrackedDownloads.TrackedDownloadStatusMessage"
},
"nullable": true
},
@@ -12035,7 +13190,7 @@
"nullable": true
},
"protocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
+ "$ref": "#/components/schemas/NzbDrone.Core.Indexers.DownloadProtocol"
},
"downloadClient": {
"type": "string",
@@ -12055,46 +13210,7 @@
},
"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": {
+ "Readarr.Api.V1.Queue.QueueStatusResource": {
"type": "object",
"properties": {
"id": {
@@ -12128,318 +13244,364 @@
},
"additionalProperties": false
},
- "Ratings": {
+ "Readarr.Api.V1.RemotePathMappings.RemotePathMappingResource": {
"type": "object",
"properties": {
- "votes": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "value": {
- "type": "number",
- "format": "double"
+ "host": {
+ "type": "string",
+ "nullable": true
},
- "popularity": {
- "type": "number",
- "format": "double",
- "readOnly": true
- }
- },
- "additionalProperties": false
- },
- "Rejection": {
- "type": "object",
- "properties": {
- "reason": {
+ "remotePath": {
"type": "string",
"nullable": true
},
- "type": {
- "$ref": "#/components/schemas/RejectionType"
+ "localPath": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "RejectionType": {
- "enum": [
- "permanent",
- "temporary"
- ],
- "type": "string"
- },
- "ReleaseProfileResource": {
+ "Readarr.Api.V1.RootFolders.RootFolderResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "enabled": {
- "type": "boolean"
- },
- "required": {
+ "name": {
"type": "string",
"nullable": true
},
- "ignored": {
+ "path": {
"type": "string",
"nullable": true
},
- "preferred": {
+ "defaultMetadataProfileId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "defaultQualityProfileId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "defaultMonitorOption": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.MonitorTypes"
+ },
+ "defaultNewItemMonitorOption": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Books.NewItemMonitorTypes"
+ },
+ "defaultTags": {
+ "uniqueItems": true,
"type": "array",
"items": {
- "$ref": "#/components/schemas/StringInt32KeyValuePair"
+ "type": "integer",
+ "format": "int32"
},
"nullable": true
},
- "includePreferredWhenRenaming": {
+ "isCalibreLibrary": {
+ "type": "boolean"
+ },
+ "host": {
+ "type": "string",
+ "nullable": true
+ },
+ "port": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "urlBase": {
+ "type": "string",
+ "nullable": true
+ },
+ "username": {
+ "type": "string",
+ "nullable": true
+ },
+ "password": {
+ "type": "string",
+ "nullable": true
+ },
+ "library": {
+ "type": "string",
+ "nullable": true
+ },
+ "outputFormat": {
+ "type": "string",
+ "nullable": true
+ },
+ "outputProfile": {
+ "type": "string",
+ "nullable": true
+ },
+ "useSsl": {
+ "type": "boolean"
+ },
+ "accessible": {
"type": "boolean"
},
- "indexerId": {
- "type": "integer",
- "format": "int32"
+ "freeSpace": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "totalSpace": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Series.SeriesBookLinkResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "position": {
+ "type": "string",
+ "nullable": true
+ },
+ "seriesPosition": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "seriesId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "bookId": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Series.SeriesResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
},
- "tags": {
- "uniqueItems": true,
+ "links": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Series.SeriesBookLinkResource"
},
"nullable": true
}
},
"additionalProperties": false
},
- "ReleaseResource": {
+ "Readarr.Api.V1.System.Backup.BackupResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "guid": {
+ "name": {
"type": "string",
"nullable": true
},
- "quality": {
- "$ref": "#/components/schemas/QualityModel"
- },
- "qualityWeight": {
- "type": "integer",
- "format": "int32"
- },
- "age": {
- "type": "integer",
- "format": "int32"
- },
- "ageHours": {
- "type": "number",
- "format": "double"
+ "path": {
+ "type": "string",
+ "nullable": true
},
- "ageMinutes": {
- "type": "number",
- "format": "double"
+ "type": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Backup.BackupType"
},
"size": {
"type": "integer",
"format": "int64"
},
- "indexerId": {
- "type": "integer",
- "format": "int32"
- },
- "indexer": {
+ "time": {
"type": "string",
- "nullable": true
- },
- "releaseGroup": {
+ "format": "date-time"
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.System.SystemResource": {
+ "type": "object",
+ "properties": {
+ "appName": {
"type": "string",
"nullable": true
},
- "subGroup": {
+ "instanceName": {
"type": "string",
"nullable": true
},
- "releaseHash": {
+ "version": {
"type": "string",
"nullable": true
},
- "title": {
+ "buildTime": {
"type": "string",
- "nullable": true
+ "format": "date-time"
},
- "discography": {
+ "isDebug": {
"type": "boolean"
},
- "sceneSource": {
+ "isProduction": {
"type": "boolean"
},
- "airDate": {
+ "isAdmin": {
+ "type": "boolean"
+ },
+ "isUserInteractive": {
+ "type": "boolean"
+ },
+ "startupPath": {
"type": "string",
"nullable": true
},
- "authorName": {
+ "appData": {
"type": "string",
"nullable": true
},
- "bookTitle": {
+ "osName": {
"type": "string",
"nullable": true
},
- "approved": {
+ "osVersion": {
+ "type": "string",
+ "nullable": true
+ },
+ "isNetCore": {
"type": "boolean"
},
- "temporarilyRejected": {
+ "isLinux": {
"type": "boolean"
},
- "rejected": {
+ "isOsx": {
"type": "boolean"
},
- "rejections": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "nullable": true
+ "isWindows": {
+ "type": "boolean"
},
- "publishDate": {
- "type": "string",
- "format": "date-time"
+ "isDocker": {
+ "type": "boolean"
},
- "commentUrl": {
- "type": "string",
- "nullable": true
+ "mode": {
+ "$ref": "#/components/schemas/NzbDrone.Common.EnvironmentInfo.RuntimeMode"
},
- "downloadUrl": {
+ "branch": {
"type": "string",
"nullable": true
},
- "infoUrl": {
- "type": "string",
- "nullable": true
+ "databaseType": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.DatabaseType"
},
- "downloadAllowed": {
- "type": "boolean"
+ "databaseVersion": {
+ "$ref": "#/components/schemas/System.Version"
},
- "releaseWeight": {
- "type": "integer",
- "format": "int32"
+ "authentication": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Authentication.AuthenticationType"
},
- "preferredWordScore": {
+ "migrationVersion": {
"type": "integer",
"format": "int32"
},
- "magnetUrl": {
+ "urlBase": {
"type": "string",
"nullable": true
},
- "infoHash": {
+ "runtimeVersion": {
+ "$ref": "#/components/schemas/System.Version"
+ },
+ "runtimeName": {
"type": "string",
"nullable": true
},
- "seeders": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
},
- "leechers": {
- "type": "integer",
- "format": "int32",
+ "packageVersion": {
+ "type": "string",
"nullable": true
},
- "protocol": {
- "$ref": "#/components/schemas/DownloadProtocol"
- },
- "authorId": {
- "type": "integer",
- "format": "int32",
+ "packageAuthor": {
+ "type": "string",
"nullable": true
},
- "bookId": {
- "type": "integer",
- "format": "int32",
+ "packageUpdateMechanism": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Update.UpdateMechanism"
+ },
+ "packageUpdateMechanismMessage": {
+ "type": "string",
"nullable": true
}
},
"additionalProperties": false
},
- "RemotePathMappingResource": {
+ "Readarr.Api.V1.System.Tasks.TaskResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "host": {
- "type": "string",
- "nullable": true
- },
- "remotePath": {
+ "name": {
"type": "string",
"nullable": true
},
- "localPath": {
+ "taskName": {
"type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "RenameBookResource": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
},
- "authorId": {
- "type": "integer",
- "format": "int32"
- },
- "bookId": {
+ "interval": {
"type": "integer",
"format": "int32"
},
- "bookFileId": {
- "type": "integer",
- "format": "int32"
+ "lastExecution": {
+ "type": "string",
+ "format": "date-time"
},
- "existingPath": {
+ "lastStartTime": {
"type": "string",
- "nullable": true
+ "format": "date-time"
},
- "newPath": {
+ "nextExecution": {
"type": "string",
- "nullable": true
+ "format": "date-time"
+ },
+ "lastDuration": {
+ "$ref": "#/components/schemas/System.TimeSpan"
}
},
"additionalProperties": false
},
- "RescanAfterRefreshType": {
- "enum": [
- "always",
- "afterManual",
- "never"
- ],
- "type": "string"
- },
- "RetagBookResource": {
+ "Readarr.Api.V1.Tags.TagDetailsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
- "authorId": {
- "type": "integer",
- "format": "int32"
- },
- "bookId": {
- "type": "integer",
- "format": "int32"
+ "label": {
+ "type": "string",
+ "nullable": true
},
- "trackNumbers": {
+ "delayProfileIds": {
"type": "array",
"items": {
"type": "integer",
@@ -12447,476 +13609,428 @@
},
"nullable": true
},
- "bookFileId": {
- "type": "integer",
- "format": "int32"
- },
- "path": {
- "type": "string",
+ "importListIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
"nullable": true
},
- "changes": {
+ "notificationIds": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/TagDifference"
+ "type": "integer",
+ "format": "int32"
},
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "Revision": {
- "type": "object",
- "properties": {
- "version": {
- "type": "integer",
- "format": "int32"
},
- "real": {
- "type": "integer",
- "format": "int32"
+ "restrictionIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
},
- "isRepack": {
- "type": "boolean"
+ "authorIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "nullable": true
}
},
"additionalProperties": false
},
- "RootFolderResource": {
+ "Readarr.Api.V1.Tags.TagResource": {
"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"
- },
- "defaultTags": {
- "uniqueItems": true,
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "nullable": true
- },
- "isCalibreLibrary": {
- "type": "boolean"
- },
- "host": {
+ "label": {
"type": "string",
- "nullable": true
- },
- "port": {
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Api.V1.Update.UpdateResource": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
"format": "int32"
},
- "urlBase": {
- "type": "string",
- "nullable": true
+ "version": {
+ "$ref": "#/components/schemas/System.Version"
},
- "username": {
+ "branch": {
"type": "string",
"nullable": true
},
- "password": {
+ "releaseDate": {
"type": "string",
- "nullable": true
+ "format": "date-time"
},
- "library": {
+ "fileName": {
"type": "string",
"nullable": true
},
- "outputFormat": {
+ "url": {
"type": "string",
"nullable": true
},
- "outputProfile": {
+ "installed": {
+ "type": "boolean"
+ },
+ "installedOn": {
"type": "string",
+ "format": "date-time",
"nullable": true
},
- "useSsl": {
+ "installable": {
"type": "boolean"
},
- "accessible": {
+ "latest": {
"type": "boolean"
},
- "freeSpace": {
- "type": "integer",
- "format": "int64",
- "nullable": true
+ "changes": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Update.UpdateChanges"
},
- "totalSpace": {
- "type": "integer",
- "format": "int64",
+ "hash": {
+ "type": "string",
"nullable": true
}
},
"additionalProperties": false
},
- "SelectOption": {
+ "Readarr.Http.ApiInfoResource": {
"type": "object",
"properties": {
- "value": {
- "type": "integer",
- "format": "int32"
- },
- "name": {
+ "current": {
"type": "string",
"nullable": true
},
- "order": {
- "type": "integer",
- "format": "int32"
- },
- "hint": {
- "type": "string",
+ "deprecated": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
"nullable": true
}
},
"additionalProperties": false
},
- "Series": {
+ "Readarr.Http.ClientSchema.Field": {
"type": "object",
"properties": {
- "id": {
+ "order": {
"type": "integer",
"format": "int32"
},
- "foreignSeriesId": {
+ "name": {
"type": "string",
"nullable": true
},
- "title": {
+ "label": {
"type": "string",
"nullable": true
},
- "description": {
+ "unit": {
"type": "string",
"nullable": true
},
- "numbered": {
- "type": "boolean"
- },
- "workCount": {
- "type": "integer",
- "format": "int32"
- },
- "primaryWorkCount": {
- "type": "integer",
- "format": "int32"
- },
- "linkItems": {
- "$ref": "#/components/schemas/SeriesBookLinkListLazyLoaded"
- },
- "books": {
- "$ref": "#/components/schemas/BookListLazyLoaded"
- },
- "foreignAuthorId": {
+ "helpText": {
"type": "string",
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "SeriesBookLink": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
},
- "position": {
+ "helpLink": {
"type": "string",
"nullable": true
},
- "seriesId": {
- "type": "integer",
- "format": "int32"
+ "value": {
+ "nullable": true
},
- "bookId": {
- "type": "integer",
- "format": "int32"
+ "type": {
+ "type": "string",
+ "nullable": true
},
- "isPrimary": {
+ "advanced": {
"type": "boolean"
},
- "series": {
- "$ref": "#/components/schemas/SeriesLazyLoaded"
- },
- "book": {
- "$ref": "#/components/schemas/BookLazyLoaded"
- }
- },
- "additionalProperties": false
- },
- "SeriesBookLinkListLazyLoaded": {
- "type": "object",
- "properties": {
- "value": {
+ "selectOptions": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SeriesBookLink"
+ "$ref": "#/components/schemas/Readarr.Http.ClientSchema.SelectOption"
},
- "nullable": true,
- "readOnly": true
+ "nullable": true
},
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
+ "selectOptionsProviderAction": {
+ "type": "string",
+ "nullable": true
+ },
+ "section": {
+ "type": "string",
+ "nullable": true
+ },
+ "hidden": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "SeriesBookLinkResource": {
+ "Readarr.Http.ClientSchema.SelectOption": {
"type": "object",
"properties": {
- "id": {
+ "value": {
"type": "integer",
"format": "int32"
},
- "position": {
+ "name": {
"type": "string",
"nullable": true
},
- "seriesId": {
+ "order": {
"type": "integer",
"format": "int32"
},
- "bookId": {
- "type": "integer",
- "format": "int32"
+ "hint": {
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "SeriesLazyLoaded": {
+ "Readarr.Http.PagingResourceFilter": {
"type": "object",
"properties": {
- "value": {
- "$ref": "#/components/schemas/Series"
+ "key": {
+ "type": "string",
+ "nullable": true
},
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
- }
- },
- "additionalProperties": false
- },
- "SeriesListLazyLoaded": {
- "type": "object",
- "properties": {
"value": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Series"
- },
- "nullable": true,
- "readOnly": true
- },
- "isLoaded": {
- "type": "boolean",
- "readOnly": true
+ "type": "string",
+ "nullable": true
}
},
"additionalProperties": false
},
- "SeriesResource": {
+ "Readarr.Http.PagingResource`1[[Readarr.Api.V1.Blocklist.BlocklistResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
- "id": {
+ "page": {
"type": "integer",
"format": "int32"
},
- "title": {
- "type": "string",
- "nullable": true
+ "pageSize": {
+ "type": "integer",
+ "format": "int32"
},
- "description": {
+ "sortKey": {
"type": "string",
"nullable": true
},
- "links": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.SortDirection"
+ },
+ "filters": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SeriesBookLinkResource"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResourceFilter"
},
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "SortDirection": {
- "enum": [
- "default",
- "ascending",
- "descending"
- ],
- "type": "string"
- },
- "StringInt32KeyValuePair": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "nullable": true,
- "readOnly": true
},
- "value": {
+ "totalRecords": {
"type": "integer",
- "format": "int32",
- "readOnly": true
+ "format": "int32"
+ },
+ "records": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Blocklist.BlocklistResource"
+ },
+ "nullable": true
}
},
"additionalProperties": false
},
- "TagDetailsResource": {
+ "Readarr.Http.PagingResource`1[[Readarr.Api.V1.Books.BookResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
- "id": {
+ "page": {
"type": "integer",
"format": "int32"
},
- "label": {
+ "pageSize": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sortKey": {
"type": "string",
"nullable": true
},
- "delayProfileIds": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.SortDirection"
+ },
+ "filters": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResourceFilter"
},
"nullable": true
},
- "importListIds": {
+ "totalRecords": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "records": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Api.V1.Books.BookResource"
},
"nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Http.PagingResource`1[[Readarr.Api.V1.History.HistoryResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]": {
+ "type": "object",
+ "properties": {
+ "page": {
+ "type": "integer",
+ "format": "int32"
},
- "notificationIds": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- },
+ "pageSize": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sortKey": {
+ "type": "string",
"nullable": true
},
- "restrictionIds": {
+ "sortDirection": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.SortDirection"
+ },
+ "filters": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Http.PagingResourceFilter"
},
"nullable": true
},
- "authorIds": {
+ "totalRecords": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "records": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
+ "$ref": "#/components/schemas/Readarr.Api.V1.History.HistoryResource"
},
"nullable": true
}
},
"additionalProperties": false
},
- "TagDifference": {
+ "Readarr.Http.PagingResource`1[[Readarr.Api.V1.Logs.LogResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
- "field": {
- "type": "string",
- "nullable": true
+ "page": {
+ "type": "integer",
+ "format": "int32"
},
- "oldValue": {
+ "pageSize": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sortKey": {
"type": "string",
"nullable": true
},
- "newValue": {
- "type": "string",
+ "sortDirection": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.SortDirection"
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Http.PagingResourceFilter"
+ },
"nullable": true
- }
- },
- "additionalProperties": false
- },
- "TagResource": {
- "type": "object",
- "properties": {
- "id": {
+ },
+ "totalRecords": {
"type": "integer",
"format": "int32"
},
- "label": {
- "type": "string",
+ "records": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Logs.LogResource"
+ },
"nullable": true
}
},
"additionalProperties": false
},
- "TaskResource": {
+ "Readarr.Http.PagingResource`1[[Readarr.Api.V1.Queue.QueueResource, Readarr.Api.V1, Version=10.0.0.13370, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
- "id": {
+ "page": {
"type": "integer",
"format": "int32"
},
- "name": {
+ "pageSize": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "sortKey": {
"type": "string",
"nullable": true
},
- "taskName": {
- "type": "string",
+ "sortDirection": {
+ "$ref": "#/components/schemas/NzbDrone.Core.Datastore.SortDirection"
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Http.PagingResourceFilter"
+ },
"nullable": true
},
- "interval": {
+ "totalRecords": {
"type": "integer",
"format": "int32"
},
- "lastExecution": {
- "type": "string",
- "format": "date-time"
- },
- "lastStartTime": {
- "type": "string",
- "format": "date-time"
- },
- "nextExecution": {
+ "records": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Readarr.Api.V1.Queue.QueueResource"
+ },
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "Readarr.Http.Ping.PingResource": {
+ "type": "object",
+ "properties": {
+ "status": {
"type": "string",
- "format": "date-time"
- },
- "lastDuration": {
- "$ref": "#/components/schemas/TimeSpan"
+ "nullable": true
}
},
"additionalProperties": false
},
- "TimeSpan": {
+ "System.TimeSpan": {
"type": "object",
"properties": {
"ticks": {
"type": "integer",
- "format": "int64",
- "readOnly": true
+ "format": "int64"
},
"days": {
"type": "integer",
@@ -12971,160 +14085,7 @@
},
"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"
- }
- },
- "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"
- },
- "installable": {
- "type": "boolean"
- },
- "latest": {
- "type": "boolean"
- },
- "changes": {
- "$ref": "#/components/schemas/UpdateChanges"
- },
- "hash": {
- "type": "string",
- "nullable": true
- }
- },
- "additionalProperties": false
- },
- "Version": {
+ "System.Version": {
"type": "object",
"properties": {
"major": {
@@ -13159,24 +14120,29 @@
}
},
"additionalProperties": false
+ }
+ },
+ "securitySchemes": {
+ "X-Api-Key": {
+ "type": "apiKey",
+ "description": "Apikey passed as header",
+ "name": "X-Api-Key",
+ "in": "header"
},
- "WriteAudioTagsType": {
- "enum": [
- "no",
- "newFiles",
- "allFiles",
- "sync"
- ],
- "type": "string"
- },
- "WriteBookTagsType": {
- "enum": [
- "newFiles",
- "allFiles",
- "sync"
- ],
- "type": "string"
+ "apikey": {
+ "type": "apiKey",
+ "description": "Apikey passed as header",
+ "name": "apikey",
+ "in": "query"
}
}
- }
+ },
+ "security": [
+ {
+ "X-Api-Key": [ ]
+ },
+ {
+ "apikey": [ ]
+ }
+ ]
}
\ No newline at end of file