From 089658e4698dd604b99e153cf2b8580a8c5df37d Mon Sep 17 00:00:00 2001 From: Joe Milazzo Date: Sun, 20 Nov 2022 14:32:21 -0600 Subject: [PATCH] UX Alignment and bugfixes (#1663) * Refactored the design of reading list page to follow more in line with list view. Added release date on the reading list items, if it's set in underlying chapter. Fixed a bug where reordering the list items could sometimes not update correctly with drag and drop. * Removed a bug marker that I just fixed * When generating library covers, make them much smaller as they are only ever icons. * Fixed library settings not showing the correct image. * Fixed a bug where duplicate collection tags could be created. Fixed a bug where collection tag normalized title was being set to uppercase. Redesigned the edit collection tag modal to align with new library settings and provide inline name checks. * Updated edit reading list modal to align with new library settings modal pattern. Refactored the backend to ensure it flows correctly without allowing duplicate names. Don't show Continue point on series detail if the whole series is read. * Added some more unit tests around continue point * Fixed a bug on series detail when bulk selecting between volume and chapters, the code which determines which chapters are selected didn't take into account mixed layout for Storyline tab. * Refactored to generate an OpenAPI spec at root of Kavita. This will be loaded by a new API site for easy hosting. Deprecated EnableSwaggerUi preference as after validation new system works, this will be removed and instances can use our hosting to hit their server (or run a debug build). * Test GA * Reverted GA and instead do it in the build step. This will just force developers to commit it in. * GA please work * Removed redundant steps from test since build already does it. * Try another GA * Moved all test actions into initial build step, which should drastically cut down on time. Only run sonar if the secret is present (so not for forks). Updated build requirements for develop and stable docker pushes. * Fixed env variable * Okay not possible to do secrets in if statement * Fixed the build step to output the openapi.json where it's expected. --- .github/workflows/sonar-scan.yml | 43 +- API.Tests/Services/ReaderServiceTests.cs | 66 + API/API.csproj | 6 +- API/Controllers/CollectionController.cs | 24 +- API/Controllers/LibraryController.cs | 6 +- API/Controllers/ReadingListController.cs | 38 +- API/Controllers/UploadController.cs | 3 +- API/DTOs/ReadingLists/ReadingListItemDto.cs | 7 +- API/DTOs/Settings/ServerSettingDTO.cs | 4 +- .../Repositories/CollectionTagRepository.cs | 8 + API/Data/Repositories/LibraryRepository.cs | 2 +- .../Repositories/ReadingListRepository.cs | 17 +- API/Entities/Enums/ServerSettingKey.cs | 4 +- API/Services/ImageService.cs | 10 +- API/Startup.cs | 48 +- CONTRIBUTING.md | 9 +- UI/Web/src/app/_models/reading-list.ts | 1 + .../app/_services/collection-tag.service.ts | 4 + .../src/app/_services/reading-list.service.ts | 4 + .../edit-collection-tags.component.html | 102 +- .../edit-collection-tags.component.scss | 3 + .../edit-collection-tags.component.ts | 67 +- .../cards/card-item/card-item.component.scss | 3 +- .../cards/list-item/list-item.component.html | 2 +- .../cards/list-item/list-item.component.scss | 7 +- .../all-collections.component.ts | 2 +- .../edit-reading-list-modal.component.html | 55 +- .../edit-reading-list-modal.component.scss | 3 + .../edit-reading-list-modal.component.ts | 65 +- .../draggable-ordered-list.component.html | 3 +- .../draggable-ordered-list.component.ts | 4 + .../reading-list-detail.component.html | 6 +- .../reading-list-detail.component.ts | 10 +- .../reading-list-item.component.html | 64 +- .../reading-list-item.component.scss | 25 + .../reading-list-item.component.ts | 2 + .../app/reading-list/reading-list.module.ts | 4 +- .../reading-lists.component.html | 2 +- .../reading-lists/reading-lists.component.ts | 3 + .../series-detail.component.html | 2 +- .../series-detail/series-detail.component.ts | 7 +- .../library-settings-modal.component.ts | 23 +- UI/Web/src/theme/themes/dark.scss | 1 + openapi.json | 13362 ++++++++++++++++ 44 files changed, 13878 insertions(+), 253 deletions(-) create mode 100644 openapi.json diff --git a/.github/workflows/sonar-scan.yml b/.github/workflows/sonar-scan.yml index e0f98f393..d3a885b2e 100644 --- a/.github/workflows/sonar-scan.yml +++ b/.github/workflows/sonar-scan.yml @@ -22,6 +22,10 @@ jobs: with: dotnet-version: 6.0.x + - name: Install Swashbuckle CLI + shell: powershell + run: dotnet tool install -g --version 6.4.0 Swashbuckle.AspNetCore.Cli + - name: Install dependencies run: dotnet restore @@ -35,29 +39,6 @@ jobs: name: csproj path: Kavita.Common/Kavita.Common.csproj - test: - name: Install Sonar & Test - needs: build - runs-on: windows-latest - steps: - - name: Checkout Repo - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - - name: Setup .NET Core - uses: actions/setup-dotnet@v2 - with: - dotnet-version: 6.0.x - - - name: Install dependencies - run: dotnet restore - - - name: Set up JDK 11 - uses: actions/setup-java@v1 - with: - java-version: 1.11 - - name: Cache SonarCloud packages uses: actions/cache@v1 with: @@ -93,9 +74,10 @@ jobs: - name: Test run: dotnet test --no-restore --verbosity normal + version: name: Bump version on Develop push - needs: [ build, test ] + needs: [ build ] runs-on: ubuntu-latest if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/develop' }} steps: @@ -108,6 +90,10 @@ jobs: with: dotnet-version: 6.0.x + - name: Install Swashbuckle CLI + shell: powershell + run: dotnet tool install -g --version 6.4.0 Swashbuckle.AspNetCore.Cli + - name: Install dependencies run: dotnet restore @@ -194,6 +180,11 @@ jobs: uses: actions/setup-dotnet@v2 with: dotnet-version: 6.0.x + + - name: Install Swashbuckle CLI + shell: powershell + run: dotnet tool install -g --version 6.4.0 Swashbuckle.AspNetCore.Cli + - run: ./monorepo-build.sh - name: Login to Docker Hub @@ -307,6 +298,10 @@ jobs: uses: actions/setup-dotnet@v2 with: dotnet-version: 6.0.x + - name: Install Swashbuckle CLI + shell: powershell + run: dotnet tool install -g --version 6.4.0 Swashbuckle.AspNetCore.Cli + - run: ./monorepo-build.sh - name: Login to Docker Hub diff --git a/API.Tests/Services/ReaderServiceTests.cs b/API.Tests/Services/ReaderServiceTests.cs index 71ecc1543..7c1011a69 100644 --- a/API.Tests/Services/ReaderServiceTests.cs +++ b/API.Tests/Services/ReaderServiceTests.cs @@ -1734,6 +1734,72 @@ public class ReaderServiceTests Assert.Equal("1", nextChapter.Range); } + [Fact] + public async Task GetContinuePoint_ShouldReturnLooseChapter_WhenAllVolumesAndAFewLooseChaptersRead() + { + _context.Series.Add(new Series() + { + Name = "Test", + Library = new Library() { + Name = "Test LIb", + Type = LibraryType.Manga, + }, + Volumes = new List() + { + EntityFactory.CreateVolume("0", new List() + { + EntityFactory.CreateChapter("100", false, new List(), 1), + EntityFactory.CreateChapter("101", false, new List(), 1), + EntityFactory.CreateChapter("102", false, new List(), 1), + }), + EntityFactory.CreateVolume("1", new List() + { + EntityFactory.CreateChapter("1", false, new List(), 1), + EntityFactory.CreateChapter("2", false, new List(), 1), + }), + EntityFactory.CreateVolume("2", new List() + { + EntityFactory.CreateChapter("21", false, new List(), 1), + }), + } + }); + + var user = new AppUser() + { + UserName = "majora2007" + }; + _context.AppUser.Add(user); + + await _context.SaveChangesAsync(); + + var readerService = new ReaderService(_unitOfWork, Substitute.For>(), Substitute.For()); + + // Mark everything but chapter 101 as read + await readerService.MarkSeriesAsRead(user, 1); + await _unitOfWork.CommitAsync(); + + // Unmark last chapter as read + await readerService.SaveReadingProgress(new ProgressDto() + { + PageNum = 0, + ChapterId = (await _unitOfWork.VolumeRepository.GetVolumeByIdAsync(1)).Chapters.ElementAt(1).Id, + SeriesId = 1, + VolumeId = 1 + }, 1); + await readerService.SaveReadingProgress(new ProgressDto() + { + PageNum = 0, + ChapterId = (await _unitOfWork.VolumeRepository.GetVolumeByIdAsync(1)).Chapters.ElementAt(2).Id, + SeriesId = 1, + VolumeId = 1 + }, 1); + await _context.SaveChangesAsync(); + + var nextChapter = await readerService.GetContinuePoint(1, 1); + + Assert.Equal("101", nextChapter.Range); + } + [Fact] public async Task GetContinuePoint_ShouldReturnFirstChapter_WhenAllRead() { diff --git a/API/API.csproj b/API/API.csproj index 1310f09a4..652e37a6c 100644 --- a/API/API.csproj +++ b/API/API.csproj @@ -5,10 +5,13 @@ net6.0 true Linux - true true true + + + + false @@ -91,6 +94,7 @@ runtime; build; native; contentfiles; analyzers; buildtransitive + diff --git a/API/Controllers/CollectionController.cs b/API/Controllers/CollectionController.cs index 33bde22b6..1bdca14ea 100644 --- a/API/Controllers/CollectionController.cs +++ b/API/Controllers/CollectionController.cs @@ -9,7 +9,6 @@ using API.Extensions; using API.SignalR; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; -using Microsoft.AspNetCore.SignalR; namespace API.Controllers; @@ -63,6 +62,19 @@ public class CollectionController : BaseApiController return await _unitOfWork.CollectionTagRepository.SearchTagDtosAsync(queryString, user.Id); } + /// + /// Checks if a collection exists with the name + /// + /// If empty or null, will return true as that is invalid + /// + [Authorize(Policy = "RequireAdminRole")] + [HttpGet("name-exists")] + public async Task> DoesNameExists(string name) + { + if (string.IsNullOrEmpty(name.Trim())) return Ok(true); + return Ok(await _unitOfWork.CollectionTagRepository.TagExists(name)); + } + /// /// Updates an existing tag with a new title, promotion status, and summary. /// UI does not contain controls to update title @@ -71,14 +83,18 @@ public class CollectionController : BaseApiController /// [Authorize(Policy = "RequireAdminRole")] [HttpPost("update")] - public async Task UpdateTagPromotion(CollectionTagDto updatedTag) + public async Task UpdateTag(CollectionTagDto updatedTag) { var existingTag = await _unitOfWork.CollectionTagRepository.GetTagAsync(updatedTag.Id); if (existingTag == null) return BadRequest("This tag does not exist"); + var title = updatedTag.Title.Trim(); + if (string.IsNullOrEmpty(title)) return BadRequest("Title cannot be empty"); + if (!title.Equals(existingTag.Title) && await _unitOfWork.CollectionTagRepository.TagExists(updatedTag.Title)) + return BadRequest("A tag with this name already exists"); + existingTag.Title = title; existingTag.Promoted = updatedTag.Promoted; - existingTag.Title = updatedTag.Title.Trim(); - existingTag.NormalizedTitle = Services.Tasks.Scanner.Parser.Parser.Normalize(updatedTag.Title).ToUpper(); + existingTag.NormalizedTitle = Services.Tasks.Scanner.Parser.Parser.Normalize(updatedTag.Title); existingTag.Summary = updatedTag.Summary.Trim(); if (_unitOfWork.HasChanges()) diff --git a/API/Controllers/LibraryController.cs b/API/Controllers/LibraryController.cs index 394fd7fa3..b8655322f 100644 --- a/API/Controllers/LibraryController.cs +++ b/API/Controllers/LibraryController.cs @@ -298,13 +298,15 @@ public class LibraryController : BaseApiController /// /// Checks if the library name exists or not /// - /// + /// If empty or null, will return true as that is invalid /// [Authorize(Policy = "RequireAdminRole")] [HttpGet("name-exists")] public async Task> IsLibraryNameValid(string name) { - return Ok(await _unitOfWork.LibraryRepository.LibraryExists(name.Trim())); + var trimmed = name.Trim(); + if (string.IsNullOrEmpty(trimmed)) return Ok(true); + return Ok(await _unitOfWork.LibraryRepository.LibraryExists(trimmed)); } /// diff --git a/API/Controllers/ReadingListController.cs b/API/Controllers/ReadingListController.cs index b6ee2724d..72678780c 100644 --- a/API/Controllers/ReadingListController.cs +++ b/API/Controllers/ReadingListController.cs @@ -218,22 +218,15 @@ public class ReadingListController : BaseApiController } dto.Title = dto.Title.Trim(); - if (!string.IsNullOrEmpty(dto.Title)) - { - readingList.Summary = dto.Summary; - if (!readingList.Title.Equals(dto.Title)) - { - var hasExisting = user.ReadingLists.Any(l => l.Title.Equals(dto.Title)); - if (hasExisting) - { - return BadRequest("A list of this name already exists"); - } - readingList.Title = dto.Title; - readingList.NormalizedTitle = Services.Tasks.Scanner.Parser.Parser.Normalize(readingList.Title); - } - } + if (string.IsNullOrEmpty(dto.Title)) return BadRequest("Title must be set"); + if (!dto.Title.Equals(readingList.Title) && await _unitOfWork.ReadingListRepository.ReadingListExists(dto.Title)) + return BadRequest("Reading list already exists"); + + readingList.Summary = dto.Summary; + readingList.Title = dto.Title; + readingList.NormalizedTitle = Services.Tasks.Scanner.Parser.Parser.Normalize(readingList.Title); readingList.Promoted = dto.Promoted; readingList.CoverImageLocked = dto.CoverImageLocked; @@ -246,10 +239,10 @@ public class ReadingListController : BaseApiController _unitOfWork.ReadingListRepository.Update(readingList); } - - _unitOfWork.ReadingListRepository.Update(readingList); + if (!_unitOfWork.HasChanges()) return Ok("Updated"); + if (await _unitOfWork.CommitAsync()) { return Ok("Updated"); @@ -498,4 +491,17 @@ public class ReadingListController : BaseApiController return Ok(-1); } + + /// + /// Checks if a reading list exists with the name + /// + /// If empty or null, will return true as that is invalid + /// + [Authorize(Policy = "RequireAdminRole")] + [HttpGet("name-exists")] + public async Task> DoesNameExists(string name) + { + if (string.IsNullOrEmpty(name)) return true; + return Ok(await _unitOfWork.ReadingListRepository.ReadingListExists(name)); + } } diff --git a/API/Controllers/UploadController.cs b/API/Controllers/UploadController.cs index dc4986910..3a52866e0 100644 --- a/API/Controllers/UploadController.cs +++ b/API/Controllers/UploadController.cs @@ -297,7 +297,8 @@ public class UploadController : BaseApiController try { - var filePath = _imageService.CreateThumbnailFromBase64(uploadFileDto.Url, $"{ImageService.GetLibraryFormat(uploadFileDto.Id)}"); + var filePath = _imageService.CreateThumbnailFromBase64(uploadFileDto.Url, + $"{ImageService.GetLibraryFormat(uploadFileDto.Id)}", ImageService.LibraryThumbnailWidth); if (!string.IsNullOrEmpty(filePath)) { diff --git a/API/DTOs/ReadingLists/ReadingListItemDto.cs b/API/DTOs/ReadingLists/ReadingListItemDto.cs index 39f844d8b..89be1d351 100644 --- a/API/DTOs/ReadingLists/ReadingListItemDto.cs +++ b/API/DTOs/ReadingLists/ReadingListItemDto.cs @@ -1,4 +1,5 @@ -using API.Entities.Enums; +using System; +using API.Entities.Enums; namespace API.DTOs.ReadingLists; @@ -18,6 +19,10 @@ public class ReadingListItemDto public int LibraryId { get; set; } public string Title { get; set; } /// + /// Release Date from Chapter + /// + public DateTime ReleaseDate { get; set; } + /// /// Used internally only /// public int ReadingListId { get; set; } diff --git a/API/DTOs/Settings/ServerSettingDTO.cs b/API/DTOs/Settings/ServerSettingDTO.cs index 332d06a69..9084e52e7 100644 --- a/API/DTOs/Settings/ServerSettingDTO.cs +++ b/API/DTOs/Settings/ServerSettingDTO.cs @@ -1,4 +1,5 @@ -using System.ComponentModel.DataAnnotations; +using System; +using System.ComponentModel.DataAnnotations; using API.Services; namespace API.DTOs.Settings; @@ -50,6 +51,7 @@ public class ServerSettingDto /// /// If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT. /// + [Obsolete("Being removed in v0.7 in favor of dedicated hosted api")] public bool EnableSwaggerUi { get; set; } /// /// The amount of Backups before cleanup diff --git a/API/Data/Repositories/CollectionTagRepository.cs b/API/Data/Repositories/CollectionTagRepository.cs index e4fcf5e50..1c86d4826 100644 --- a/API/Data/Repositories/CollectionTagRepository.cs +++ b/API/Data/Repositories/CollectionTagRepository.cs @@ -33,6 +33,7 @@ public interface ICollectionTagRepository Task RemoveTagsWithoutSeries(); Task> GetAllTagsAsync(); Task> GetAllCoverImagesAsync(); + Task TagExists(string title); } public class CollectionTagRepository : ICollectionTagRepository { @@ -101,6 +102,13 @@ public class CollectionTagRepository : ICollectionTagRepository .ToListAsync(); } + public async Task TagExists(string title) + { + var normalized = Services.Tasks.Scanner.Parser.Parser.Normalize(title); + return await _context.CollectionTag + .AnyAsync(x => x.NormalizedTitle.Equals(normalized)); + } + public async Task> GetAllTagDtosAsync() { diff --git a/API/Data/Repositories/LibraryRepository.cs b/API/Data/Repositories/LibraryRepository.cs index 39ab5999e..04687c9f7 100644 --- a/API/Data/Repositories/LibraryRepository.cs +++ b/API/Data/Repositories/LibraryRepository.cs @@ -283,7 +283,7 @@ public class LibraryRepository : ILibraryRepository { return await _context.Library .AsNoTracking() - .AnyAsync(x => x.Name == libraryName); + .AnyAsync(x => x.Name.Equals(libraryName)); } public async Task> GetLibrariesForUserAsync(AppUser user) diff --git a/API/Data/Repositories/ReadingListRepository.cs b/API/Data/Repositories/ReadingListRepository.cs index 3401205d1..327a470fe 100644 --- a/API/Data/Repositories/ReadingListRepository.cs +++ b/API/Data/Repositories/ReadingListRepository.cs @@ -19,7 +19,6 @@ public interface IReadingListRepository Task> AddReadingProgressModifiers(int userId, IList items); Task GetReadingListDtoByTitleAsync(int userId, string title); Task> GetReadingListItemsByIdAsync(int readingListId); - Task> GetReadingListDtosForSeriesAndUserAsync(int userId, int seriesId, bool includePromoted); void Remove(ReadingListItem item); @@ -29,6 +28,7 @@ public interface IReadingListRepository Task Count(); Task GetCoverImageAsync(int readingListId); Task> GetAllCoverImagesAsync(); + Task ReadingListExists(string name); } public class ReadingListRepository : IReadingListRepository @@ -75,6 +75,13 @@ public class ReadingListRepository : IReadingListRepository .ToListAsync(); } + public async Task ReadingListExists(string name) + { + var normalized = Services.Tasks.Scanner.Parser.Parser.Normalize(name); + return await _context.ReadingList + .AnyAsync(x => x.NormalizedTitle.Equals(normalized)); + } + public void Remove(ReadingListItem item) { _context.ReadingListItem.Remove(item); @@ -137,6 +144,7 @@ public class ReadingListRepository : IReadingListRepository { TotalPages = chapter.Pages, ChapterNumber = chapter.Range, + ReleaseDate = chapter.ReleaseDate, readingListItem = data }) .Join(_context.Volume, s => s.readingListItem.VolumeId, volume => volume.Id, (data, volume) => new @@ -144,6 +152,7 @@ public class ReadingListRepository : IReadingListRepository data.readingListItem, data.TotalPages, data.ChapterNumber, + data.ReleaseDate, VolumeId = volume.Id, VolumeNumber = volume.Name, }) @@ -157,7 +166,8 @@ public class ReadingListRepository : IReadingListRepository data.TotalPages, data.ChapterNumber, data.VolumeNumber, - data.VolumeId + data.VolumeId, + data.ReleaseDate, }) .Select(data => new ReadingListItemDto() { @@ -172,7 +182,8 @@ public class ReadingListRepository : IReadingListRepository VolumeNumber = data.VolumeNumber, LibraryId = data.LibraryId, VolumeId = data.VolumeId, - ReadingListId = data.readingListItem.ReadingListId + ReadingListId = data.readingListItem.ReadingListId, + ReleaseDate = data.ReleaseDate }) .Where(o => userLibraries.Contains(o.LibraryId)) .OrderBy(rli => rli.Order) diff --git a/API/Entities/Enums/ServerSettingKey.cs b/API/Entities/Enums/ServerSettingKey.cs index 604d286ff..5c4fbd601 100644 --- a/API/Entities/Enums/ServerSettingKey.cs +++ b/API/Entities/Enums/ServerSettingKey.cs @@ -1,4 +1,5 @@ -using System.ComponentModel; +using System; +using System.ComponentModel; namespace API.Entities.Enums; @@ -85,6 +86,7 @@ public enum ServerSettingKey /// If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT. /// [Description("EnableSwaggerUi")] + [Obsolete("Being removed in v0.7 in favor of dedicated hosted api")] EnableSwaggerUi = 15, /// /// Total Number of Backups to maintain before cleaning. Default 30, min 1. diff --git a/API/Services/ImageService.cs b/API/Services/ImageService.cs index 9500b43ed..b9fc252f7 100644 --- a/API/Services/ImageService.cs +++ b/API/Services/ImageService.cs @@ -17,8 +17,9 @@ public interface IImageService /// /// base64 encoded image /// + /// Width of thumbnail /// File name with extension of the file. This will always write to - string CreateThumbnailFromBase64(string encodedImage, string fileName); + string CreateThumbnailFromBase64(string encodedImage, string fileName, int thumbnailWidth = 0); string WriteCoverThumbnail(Stream stream, string fileName, string outputDirectory, bool saveAsWebP = false); /// @@ -46,6 +47,10 @@ public class ImageService : IImageService /// Width of the Thumbnail generation /// private const int ThumbnailWidth = 320; + /// + /// Width of a cover for Library + /// + public const int LibraryThumbnailWidth = 32; public ImageService(ILogger logger, IDirectoryService directoryService) { @@ -114,7 +119,6 @@ public class ImageService : IImageService var fileName = file.Name.Replace(file.Extension, string.Empty); var outputFile = Path.Join(outputPath, fileName + ".webp"); - using var sourceImage = await SixLabors.ImageSharp.Image.LoadAsync(filePath); await sourceImage.SaveAsWebpAsync(outputFile); return outputFile; @@ -139,7 +143,7 @@ public class ImageService : IImageService /// - public string CreateThumbnailFromBase64(string encodedImage, string fileName) + public string CreateThumbnailFromBase64(string encodedImage, string fileName, int thumbnailWidth = ThumbnailWidth) { try { diff --git a/API/Startup.cs b/API/Startup.cs index a22422d6a..55694a923 100644 --- a/API/Startup.cs +++ b/API/Startup.cs @@ -1,9 +1,11 @@ using System; +using System.Collections.Generic; using System.IO; using System.IO.Compression; using System.Linq; using System.Net; using System.Net.Sockets; +using System.Reflection; using System.Threading.Tasks; using API.Data; using API.Entities; @@ -103,15 +105,20 @@ public class Startup services.AddIdentityServices(_config); services.AddSwaggerGen(c => { - c.SwaggerDoc("v1", new OpenApiInfo() + c.SwaggerDoc("v1", new OpenApiInfo { + Version = BuildInfo.Version.ToString(), + Title = "Kavita", Description = "Kavita provides a set of APIs that are authenticated by JWT. JWT token can be copied from local storage.", - Title = "Kavita API", - Version = "v1", + License = new OpenApiLicense + { + Name = "GPL-3.0", + Url = new Uri("https://github.com/Kareadita/Kavita/blob/develop/LICENSE") + } }); - - var filePath = Path.Combine(AppContext.BaseDirectory, "API.xml"); + var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; + var filePath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(filePath, true); c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme { In = ParameterLocation.Header, @@ -119,6 +126,7 @@ public class Startup Name = "Authorization", Type = SecuritySchemeType.ApiKey }); + c.AddSecurityRequirement(new OpenApiSecurityRequirement { { new OpenApiSecurityScheme @@ -133,30 +141,15 @@ public class Startup } }); - c.AddServer(new OpenApiServer() + c.AddServer(new OpenApiServer { - Description = "Custom Url", - Url = "/" + Url = "{protocol}://{hostpath}", + Variables = new Dictionary + { + { "protocol", new OpenApiServerVariable { Default = "http", Enum = new List { "http", "https" } } }, + { "hostpath", new OpenApiServerVariable { Default = "localhost:5000" } } + } }); - - c.AddServer(new OpenApiServer() - { - Description = "Local Server", - Url = "http://localhost:5000/", - }); - - c.AddServer(new OpenApiServer() - { - Url = "https://demo.kavitareader.com/", - Description = "Kavita Demo" - }); - - c.AddServer(new OpenApiServer() - { - Url = "http://" + GetLocalIpAddress() + ":5000/", - Description = "Local IP" - }); - }); services.AddResponseCompression(options => { @@ -256,6 +249,7 @@ public class Startup { c.SwaggerEndpoint("/swagger/v1/swagger.json", "Kavita API " + BuildInfo.Version); }); + } }); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e1fae0be..4d81e02a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,9 @@ Setup guides, FAQ, the more information we have on the [wiki](https://wiki.kavit - Rider (optional to Visual Studio) (https://www.jetbrains.com/rider/) - HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc) - [Git](https://git-scm.com/downloads) -- [NodeJS](https://nodejs.org/en/download/) (Node 14.X.X or higher) -- .NET 5.0+ +- [NodeJS](https://nodejs.org/en/download/) (Node 16.X.X or higher) +- .NET 6.0+ +- dotnet tool install -g --version 6.4.0 Swashbuckle.AspNetCore.Cli ### Getting started ### @@ -47,8 +48,8 @@ Setup guides, FAQ, the more information we have on the [wiki](https://wiki.kavit - You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability - We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it - Each PR should come from its own [feature branch](http://martinfowler.com/bliki/FeatureBranch.html) not develop in your fork, it should have a meaningful branch name (what is being added/fixed) - - new-feature (Good) - - fix-bug (Good) + - new-feature (Bad) + - fix-bug (Bad) - patch (Bad) - develop (Bad) - feature/parser-enhancements (Great) diff --git a/UI/Web/src/app/_models/reading-list.ts b/UI/Web/src/app/_models/reading-list.ts index 3a1dd7297..54ba3ec8a 100644 --- a/UI/Web/src/app/_models/reading-list.ts +++ b/UI/Web/src/app/_models/reading-list.ts @@ -12,6 +12,7 @@ export interface ReadingListItem { volumeNumber: string; libraryId: number; id: number; + releaseDate: string; } export interface ReadingList { diff --git a/UI/Web/src/app/_services/collection-tag.service.ts b/UI/Web/src/app/_services/collection-tag.service.ts index 6c58753c3..b53f4d5b7 100644 --- a/UI/Web/src/app/_services/collection-tag.service.ts +++ b/UI/Web/src/app/_services/collection-tag.service.ts @@ -36,4 +36,8 @@ export class CollectionTagService { addByMultiple(tagId: number, seriesIds: Array, tagTitle: string = '') { return this.httpClient.post(this.baseUrl + 'collection/update-for-series', {collectionTagId: tagId, collectionTagTitle: tagTitle, seriesIds}, {responseType: 'text' as 'json'}); } + + tagNameExists(name: string) { + return this.httpClient.get(this.baseUrl + 'collection/name-exists?name=' + name); + } } diff --git a/UI/Web/src/app/_services/reading-list.service.ts b/UI/Web/src/app/_services/reading-list.service.ts index dae0708b6..486c51f0f 100644 --- a/UI/Web/src/app/_services/reading-list.service.ts +++ b/UI/Web/src/app/_services/reading-list.service.ts @@ -87,4 +87,8 @@ export class ReadingListService { if (readingList?.promoted && !isAdmin) return false; return true; } + + nameExists(name: string) { + return this.httpClient.get(this.baseUrl + 'readinglist/name-exists?name=' + name); + } } diff --git a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.html b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.html index 5d90fe9cd..ec8c1a170 100644 --- a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.html +++ b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.html @@ -3,22 +3,50 @@ -
-
    -
  • - {{tabs[TabID.General].title}} - - -
    -
    - - +
    +
      +
    • + {{TabID.General}} + + +
      +
      + + +
      +
      + This field is required +
      +
      + Name must be unique +
      +
      - - +
      +
      + + + + Promotion means that the tag can be seen server-wide, not just for admin users. All series that have this tag will still have user-access restrictions placed on them. + +
      +
      +
      + +
      + + +
      + + +       +
      • + +
    • + {{TabID.Series}} +
      Applies to Series
      @@ -35,36 +63,30 @@
    -
    -
    - +
    + +
    -
    • -
  • - {{tabs[TabID.CoverImage].title}} - - - - -
    • -
+ +
  • + {{TabID.CoverImage}} + + + +
    • + -
    - +
    - - +
    diff --git a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.scss b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.scss index e69de29bb..3fd15f534 100644 --- a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.scss +++ b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.scss @@ -0,0 +1,3 @@ +.form-switch { + margin-top: 2.4rem; +} \ No newline at end of file diff --git a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.ts b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.ts index ee084dce4..b94427051 100644 --- a/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.ts +++ b/UI/Web/src/app/cards/_modals/edit-collection-tags/edit-collection-tags.component.ts @@ -1,8 +1,8 @@ -import { ChangeDetectionStrategy, ChangeDetectorRef, Component, Input, OnInit } from '@angular/core'; -import { FormControl, FormGroup } from '@angular/forms'; +import { ChangeDetectionStrategy, ChangeDetectorRef, Component, Input, OnDestroy, OnInit } from '@angular/core'; +import { FormControl, FormGroup, Validators } from '@angular/forms'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { ToastrService } from 'ngx-toastr'; -import { forkJoin } from 'rxjs'; +import { debounceTime, distinctUntilChanged, forkJoin, Subject, switchMap, takeUntil, tap } from 'rxjs'; import { ConfirmService } from 'src/app/shared/confirm.service'; import { Breakpoint, UtilityService } from 'src/app/shared/_services/utility.service'; import { SelectionModel } from 'src/app/typeahead/typeahead.component'; @@ -17,8 +17,9 @@ import { UploadService } from 'src/app/_services/upload.service'; enum TabID { - General = 0, - CoverImage = 1, + General = 'General', + CoverImage = 'Cover Image', + Series = 'Series' } @Component({ @@ -27,7 +28,7 @@ enum TabID { styleUrls: ['./edit-collection-tags.component.scss'], changeDetection: ChangeDetectionStrategy.OnPush }) -export class EditCollectionTagsComponent implements OnInit { +export class EditCollectionTagsComponent implements OnInit, OnDestroy { @Input() tag!: CollectionTag; series: Array = []; @@ -38,11 +39,12 @@ export class EditCollectionTagsComponent implements OnInit { selectAll: boolean = true; libraryNames!: any; collectionTagForm!: FormGroup; - tabs = [{title: 'General', id: TabID.General}, {title: 'Cover Image', id: TabID.CoverImage}]; active = TabID.General; imageUrls: Array = []; selectedCover: string = ''; + private readonly onDestroy = new Subject(); + get hasSomeSelected() { return this.selections != null && this.selections.hasSomeSelected(); } @@ -66,15 +68,38 @@ export class EditCollectionTagsComponent implements OnInit { this.pagination = {totalPages: 1, totalItems: 200, itemsPerPage: 200, currentPage: 0}; } this.collectionTagForm = new FormGroup({ - summary: new FormControl(this.tag.summary, []), - coverImageLocked: new FormControl(this.tag.coverImageLocked, []), - coverImageIndex: new FormControl(0, []), - + title: new FormControl(this.tag.title, { nonNullable: true, validators: [Validators.required] }), + summary: new FormControl(this.tag.summary, { nonNullable: true, validators: [] }), + coverImageLocked: new FormControl(this.tag.coverImageLocked, { nonNullable: true, validators: [] }), + coverImageIndex: new FormControl(0, { nonNullable: true, validators: [] }), + promoted: new FormControl(this.tag.promoted, { nonNullable: true, validators: [] }), }); + + this.collectionTagForm.get('title')?.valueChanges.pipe( + debounceTime(100), + distinctUntilChanged(), + switchMap(name => this.collectionService.tagNameExists(name)), + tap(exists => { + const isExistingName = this.collectionTagForm.get('title')?.value === this.tag.title; + if (!exists || isExistingName) { + this.collectionTagForm.get('title')?.setErrors(null); + } else { + this.collectionTagForm.get('title')?.setErrors({duplicateName: true}) + } + this.cdRef.markForCheck(); + }), + takeUntil(this.onDestroy) + ).subscribe(); + this.imageUrls.push(this.imageService.randomize(this.imageService.getCollectionCoverImage(this.tag.id))); this.loadSeries(); } + ngOnDestroy() { + this.onDestroy.next(); + this.onDestroy.complete(); + } + onPageChange(pageNum: number) { this.pagination.currentPage = pageNum; this.loadSeries(); @@ -83,6 +108,7 @@ export class EditCollectionTagsComponent implements OnInit { toggleAll() { this.selectAll = !this.selectAll; this.series.forEach(s => this.selections.toggle(s, this.selectAll)); + this.cdRef.markForCheck(); } loadSeries() { @@ -91,9 +117,9 @@ export class EditCollectionTagsComponent implements OnInit { this.libraryService.getLibraryNames() ]).subscribe(results => { const series = results[0]; - this.pagination = series.pagination; this.series = series.result; + this.imageUrls.push(...this.series.map(s => this.imageService.getSeriesCoverImage(s.id))); this.selections = new SelectionModel(true, this.series); this.isLoading = false; @@ -114,18 +140,6 @@ export class EditCollectionTagsComponent implements OnInit { this.cdRef.markForCheck(); } - togglePromotion() { - const originalPromotion = this.tag.promoted; - this.tag.promoted = !this.tag.promoted; - this.cdRef.markForCheck(); - this.collectionService.updateTag(this.tag).subscribe(res => { - this.toastr.success('Tag updated successfully'); - }, err => { - this.tag.promoted = originalPromotion; - this.cdRef.markForCheck(); - }); - } - libraryName(libraryId: number) { return this.libraryNames[libraryId]; } @@ -140,12 +154,13 @@ export class EditCollectionTagsComponent implements OnInit { const tag: CollectionTag = {...this.tag}; tag.summary = this.collectionTagForm.get('summary')?.value; tag.coverImageLocked = this.collectionTagForm.get('coverImageLocked')?.value; + tag.promoted = this.collectionTagForm.get('promoted')?.value; if (unselectedIds.length == this.series.length && !await this.confirmSerivce.confirm('Warning! No series are selected, saving will delete the tag. Are you sure you want to continue?')) { return; } - const apis = [this.collectionService.updateTag(this.tag), + const apis = [this.collectionService.updateTag(tag), this.collectionService.updateSeriesForTag(tag, this.selections.unselected().map(s => s.id)) ]; @@ -153,7 +168,7 @@ export class EditCollectionTagsComponent implements OnInit { apis.push(this.uploadService.updateCollectionCoverImage(this.tag.id, this.selectedCover)); } - forkJoin(apis).subscribe(results => { + forkJoin(apis).subscribe(() => { this.modal.close({success: true, coverImageUpdated: selectedIndex > 0}); this.toastr.success('Tag updated'); }); diff --git a/UI/Web/src/app/cards/card-item/card-item.component.scss b/UI/Web/src/app/cards/card-item/card-item.component.scss index acaf835c4..cd3b100cf 100644 --- a/UI/Web/src/app/cards/card-item/card-item.component.scss +++ b/UI/Web/src/app/cards/card-item/card-item.component.scss @@ -1,6 +1,5 @@ -$triangle-size: 30px; $image-height: 230px; $image-width: 160px; @@ -75,7 +74,7 @@ $image-width: 160px; width: 0; height: 0; border-style: solid; - border-width: 0 $triangle-size $triangle-size 0; + border-width: 0 var(--card-progress-triangle-size) var(--card-progress-triangle-size) 0; border-color: transparent var(--primary-color) transparent transparent; } diff --git a/UI/Web/src/app/cards/list-item/list-item.component.html b/UI/Web/src/app/cards/list-item/list-item.component.html index bba132ad4..391acd274 100644 --- a/UI/Web/src/app/cards/list-item/list-item.component.html +++ b/UI/Web/src/app/cards/list-item/list-item.component.html @@ -11,7 +11,7 @@
    -
    +
    -
    -
      -
    • - {{tabs[0].title}} +
      +
        +
      • + {{TabID.General}} -

        - This list is currently {{readingList.promoted ? 'promoted' : 'not promoted'}} (). - Promotion means that the list can be seen server-wide, not just for admin users. All series that are within this list will still have user-access restrictions placed on them. -

        -
        - - +
        +
        + + +
        +
        + This field is required +
        +
        + Name must be unique +
        +
        +
        +
        +
        + + + + Promotion means that the tag can be seen server-wide, not just for admin users. All series that have this tag will still have user-access restrictions placed on them. + +
        +
        - -
        + +
        • -
      • - {{tabs[1].title}} +
      • + {{TabID.CoverImage}} -
      -
      +
      - - +
      diff --git a/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.scss b/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.scss index e69de29bb..3fd15f534 100644 --- a/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.scss +++ b/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.scss @@ -0,0 +1,3 @@ +.form-switch { + margin-top: 2.4rem; +} \ No newline at end of file diff --git a/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.ts b/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.ts index ed8c757d5..bfd775968 100644 --- a/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.ts +++ b/UI/Web/src/app/reading-list/_modals/edit-reading-list-modal/edit-reading-list-modal.component.ts @@ -1,21 +1,26 @@ -import { Component, Input, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, ChangeDetectorRef, Component, Input, OnDestroy, OnInit } from '@angular/core'; import { FormGroup, FormControl, Validators } from '@angular/forms'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { ToastrService } from 'ngx-toastr'; -import { forkJoin } from 'rxjs'; +import { debounceTime, distinctUntilChanged, forkJoin, Subject, switchMap, takeUntil, tap } from 'rxjs'; import { Breakpoint, UtilityService } from 'src/app/shared/_services/utility.service'; import { ReadingList } from 'src/app/_models/reading-list'; import { ImageService } from 'src/app/_services/image.service'; import { ReadingListService } from 'src/app/_services/reading-list.service'; import { UploadService } from 'src/app/_services/upload.service'; +enum TabID { + General = 'General', + CoverImage = 'Cover Image' +} @Component({ selector: 'app-edit-reading-list-modal', templateUrl: './edit-reading-list-modal.component.html', - styleUrls: ['./edit-reading-list-modal.component.scss'] + styleUrls: ['./edit-reading-list-modal.component.scss'], + changeDetection: ChangeDetectionStrategy.OnPush }) -export class EditReadingListModalComponent implements OnInit { +export class EditReadingListModalComponent implements OnInit, OnDestroy { @Input() readingList!: ReadingList; reviewGroup!: FormGroup; @@ -26,29 +31,49 @@ export class EditReadingListModalComponent implements OnInit { */ selectedCover: string = ''; coverImageLocked: boolean = false; - imageUrls: Array = []; + active = TabID.General; - tabs = [{title: 'General', disabled: false}, {title: 'Cover', disabled: false}]; - active = this.tabs[0]; + private readonly onDestroy = new Subject(); - get Breakpoint() { - return Breakpoint; - } + get Breakpoint() { return Breakpoint; } + get TabID() { return TabID; } constructor(private ngModal: NgbActiveModal, private readingListService: ReadingListService, public utilityService: UtilityService, private uploadService: UploadService, private toastr: ToastrService, - private imageService: ImageService) { } + private imageService: ImageService, private readonly cdRef: ChangeDetectorRef) { } ngOnInit(): void { this.reviewGroup = new FormGroup({ - title: new FormControl(this.readingList.title, [Validators.required]), - summary: new FormControl(this.readingList.summary, []) + title: new FormControl(this.readingList.title, { nonNullable: true, validators: [Validators.required] }), + summary: new FormControl(this.readingList.summary, { nonNullable: true, validators: [] }), + promoted: new FormControl(this.readingList.promoted, { nonNullable: true, validators: [] }), }); + this.reviewGroup.get('title')?.valueChanges.pipe( + debounceTime(100), + distinctUntilChanged(), + switchMap(name => this.readingListService.nameExists(name)), + tap(exists => { + const isExistingName = this.reviewGroup.get('title')?.value === this.readingList.title; + if (!exists || isExistingName) { + this.reviewGroup.get('title')?.setErrors(null); + } else { + this.reviewGroup.get('title')?.setErrors({duplicateName: true}) + } + this.cdRef.markForCheck(); + }), + takeUntil(this.onDestroy) + ).subscribe(); + this.imageUrls.push(this.imageService.randomize(this.imageService.getReadingListCoverImage(this.readingList.id))); } + ngOnDestroy() { + this.onDestroy.next(); + this.onDestroy.complete(); + } + close() { this.ngModal.dismiss(undefined); } @@ -56,7 +81,7 @@ export class EditReadingListModalComponent implements OnInit { save() { if (this.reviewGroup.value.title.trim() === '') return; - const model = {...this.reviewGroup.value, readingListId: this.readingList.id, promoted: this.readingList.promoted, coverImageLocked: this.coverImageLocked}; + const model = {...this.reviewGroup.value, readingListId: this.readingList.id, coverImageLocked: this.coverImageLocked}; const apis = [this.readingListService.update(model)]; if (this.selectedCover !== '') { @@ -67,22 +92,12 @@ export class EditReadingListModalComponent implements OnInit { this.readingList.title = model.title; this.readingList.summary = model.summary; this.readingList.coverImageLocked = this.coverImageLocked; + this.readingList.promoted = model.promoted; this.ngModal.close(this.readingList); this.toastr.success('Reading List updated'); }); } - togglePromotion() { - const originalPromotion = this.readingList.promoted; - this.readingList.promoted = !this.readingList.promoted; - const model = {...this.reviewGroup.value, readingListId: this.readingList.id, promoted: this.readingList.promoted, coverImageLocked: this.coverImageLocked}; - this.readingListService.update(model).subscribe(res => { - /* No Operation */ - }, err => { - this.readingList.promoted = originalPromotion; - }); - } - updateSelectedIndex(index: number) { this.coverImageIndex = index; } diff --git a/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.html b/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.html index a2eaf43a8..e8fa22c44 100644 --- a/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.html +++ b/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.html @@ -1,5 +1,4 @@
      -
      @@ -12,7 +11,7 @@
      - diff --git a/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.ts b/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.ts index 2755575a8..c24ce752e 100644 --- a/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.ts +++ b/UI/Web/src/app/reading-list/draggable-ordered-list/draggable-ordered-list.component.ts @@ -21,6 +21,10 @@ export interface ItemRemoveEvent { export class DraggableOrderedListComponent implements OnInit { @Input() accessibilityMode: boolean = false; + /** + * Shows the remove button on the list item + */ + @Input() showRemoveButton: boolean = true; @Input() items: Array = []; @Output() orderUpdated: EventEmitter = new EventEmitter(); @Output() itemRemove: EventEmitter = new EventEmitter(); diff --git a/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.html b/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.html index 6cc8c45b3..691bebb36 100644 --- a/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.html +++ b/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.html @@ -54,7 +54,7 @@
      -
      +
      Nothing added @@ -67,10 +67,10 @@
      - + + [promoted]="item.promoted" (read)="readChapter($event)" (remove)="itemRemoved($event, position)">
      diff --git a/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.ts b/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.ts index 3f6fde7a8..5f4d78065 100644 --- a/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.ts +++ b/UI/Web/src/app/reading-list/reading-list-detail/reading-list-detail.component.ts @@ -88,7 +88,8 @@ export class ReadingListDetailComponent implements OnInit { this.isAdmin = this.accountService.hasAdminRole(user); this.hasDownloadingRole = this.accountService.hasDownloadRole(user); - this.actions = this.actionFactoryService.getReadingListActions(this.handleReadingListActionCallback.bind(this)).filter(action => this.readingListService.actionListFilter(action, readingList, this.isAdmin)); + this.actions = this.actionFactoryService.getReadingListActions(this.handleReadingListActionCallback.bind(this)) + .filter(action => this.readingListService.actionListFilter(action, readingList, this.isAdmin)); this.cdRef.markForCheck(); } }); @@ -153,10 +154,11 @@ export class ReadingListDetailComponent implements OnInit { this.readingListService.updatePosition(this.readingList.id, event.item.id, event.fromPosition, event.toPosition).subscribe(() => { /* No Operation */ }); } - itemRemoved(event: ItemRemoveEvent) { + itemRemoved(item: ReadingListItem, position: number) { if (!this.readingList) return; - this.readingListService.deleteItem(this.readingList.id, event.item.id).subscribe(() => { - this.items.splice(event.position, 1); + this.readingListService.deleteItem(this.readingList.id, item.id).subscribe(() => { + this.items.splice(position, 1); + this.items = [...this.items]; this.cdRef.markForCheck(); this.toastr.success('Item removed'); }); diff --git a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.html b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.html index 837ee3071..bda6ed045 100644 --- a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.html +++ b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.html @@ -1,25 +1,45 @@ -
      - -
      -
      - {{title}}  - - - {{item.pagesRead}} / {{item.pagesTotal}} - UNREAD - READ - -
      - - -   - +
      +
      + +
      +
      +

      +
      +
      - {{item.seriesName}} - - - -
      - Read +
      +
      +
      + {{title}} +
      + + +
      + +
      +
      + + +   + + + {{item.seriesName}} +
      + +
      + Released: {{item.releaseDate | date:'short'}} +
      +
      +
      \ No newline at end of file diff --git a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.scss b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.scss index e69de29bb..297f9bb78 100644 --- a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.scss +++ b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.scss @@ -0,0 +1,25 @@ +.progress-banner { + height: 5px; + + .progress { + color: var(--card-progress-bar-color); + background-color: transparent; + } +} + +.list-item-container { + background: var(--card-list-item-bg-color); + border-radius: 5px; + position: relative; +} + +.not-read-badge { + position: absolute; + top: 8px; + left: 108px; + width: 0; + height: 0; + border-style: solid; + border-width: 0 var(--card-progress-triangle-size) var(--card-progress-triangle-size) 0; + border-color: transparent var(--primary-color) transparent transparent; +} \ No newline at end of file diff --git a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.ts b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.ts index 4ba4f1e0c..a1346a40c 100644 --- a/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.ts +++ b/UI/Web/src/app/reading-list/reading-list-item/reading-list-item.component.ts @@ -22,6 +22,7 @@ export class ReadingListItemComponent implements OnInit { @Input() promoted: boolean = false; @Output() read: EventEmitter = new EventEmitter(); + @Output() remove: EventEmitter = new EventEmitter(); title: string = ''; @@ -65,4 +66,5 @@ export class ReadingListItemComponent implements OnInit { this.read.emit(item); } + } diff --git a/UI/Web/src/app/reading-list/reading-list.module.ts b/UI/Web/src/app/reading-list/reading-list.module.ts index aa1482f64..09ca14da7 100644 --- a/UI/Web/src/app/reading-list/reading-list.module.ts +++ b/UI/Web/src/app/reading-list/reading-list.module.ts @@ -10,7 +10,7 @@ import { ReadingListsComponent } from './reading-lists/reading-lists.component'; import { EditReadingListModalComponent } from './_modals/edit-reading-list-modal/edit-reading-list-modal.component'; import { PipeModule } from '../pipe/pipe.module'; import { SharedModule } from '../shared/shared.module'; -import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap'; +import { NgbNavModule, NgbProgressbarModule, NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap'; import { SharedSideNavCardsModule } from '../shared-side-nav-cards/shared-side-nav-cards.module'; import { ReadingListItemComponent } from './reading-list-item/reading-list-item.component'; @@ -30,6 +30,8 @@ import { ReadingListItemComponent } from './reading-list-item/reading-list-item. ReactiveFormsModule, DragDropModule, NgbNavModule, + NgbProgressbarModule, + NgbTooltipModule, PipeModule, SharedModule, diff --git a/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.html b/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.html index 543658b4e..05fa6c4fe 100644 --- a/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.html +++ b/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.html @@ -13,7 +13,7 @@ [filteringDisabled]="true" > - diff --git a/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.ts b/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.ts index 7a7120528..4884d1e80 100644 --- a/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.ts +++ b/UI/Web/src/app/reading-list/reading-lists/reading-lists.component.ts @@ -25,6 +25,7 @@ export class ReadingListsComponent implements OnInit { pagination!: Pagination; isAdmin: boolean = false; jumpbarKeys: Array = []; + actions: {[key: number]: Array>} = {}; constructor(private readingListService: ReadingListService, public imageService: ImageService, private actionFactoryService: ActionFactoryService, private accountService: AccountService, private toastr: ToastrService, private router: Router, private actionService: ActionService, @@ -86,6 +87,8 @@ export class ReadingListsComponent implements OnInit { this.pagination = readingLists.pagination; this.jumpbarKeys = this.jumpbarService.getJumpKeys(readingLists.result, (rl: ReadingList) => rl.title); this.loadingLists = false; + this.actions = {}; + this.lists.forEach(l => this.actions[l.id] = this.getActions(l)); window.scrollTo(0, 0); this.cdRef.markForCheck(); }); diff --git a/UI/Web/src/app/series-detail/series-detail.component.html b/UI/Web/src/app/series-detail/series-detail.component.html index 5cd75e4ca..782445825 100644 --- a/UI/Web/src/app/series-detail/series-detail.component.html +++ b/UI/Web/src/app/series-detail/series-detail.component.html @@ -63,7 +63,7 @@ {{unreadCount}}
      -
      +
      Continue {{ContinuePointTitle}}
      diff --git a/UI/Web/src/app/series-detail/series-detail.component.ts b/UI/Web/src/app/series-detail/series-detail.component.ts index 314424bf4..4754644c0 100644 --- a/UI/Web/src/app/series-detail/series-detail.component.ts +++ b/UI/Web/src/app/series-detail/series-detail.component.ts @@ -173,7 +173,12 @@ export class SeriesDetailComponent implements OnInit, OnDestroy, AfterContentChe let chapterArray = this.storyChapters; if (this.activeTabId === TabID.Chapters) chapterArray = this.chapters; - const selectedChapterIds = chapterArray.filter((_chapter, index: number) => selectedChapterIndexes.includes(index + '')); + // We must augment chapter indecies as Bulk Selection assumes all on one page, but Storyline has mixed + const chapterIndexModifier = this.activeTabId === TabID.Storyline ? this.volumes.length + 1 : 0; + const selectedChapterIds = chapterArray.filter((_chapter, index: number) => { + const mappedIndex = index + chapterIndexModifier; + return selectedChapterIndexes.includes(mappedIndex + ''); + }); const selectedVolumeIds = this.volumes.filter((_volume, index: number) => selectedVolumeIndexes.includes(index + '')); const selectedSpecials = this.specials.filter((_chapter, index: number) => selectedSpecialIndexes.includes(index + '')); const chapters = [...selectedChapterIds, ...selectedSpecials]; diff --git a/UI/Web/src/app/sidenav/_components/library-settings-modal/library-settings-modal.component.ts b/UI/Web/src/app/sidenav/_components/library-settings-modal/library-settings-modal.component.ts index c382af6b6..a6f7cc218 100644 --- a/UI/Web/src/app/sidenav/_components/library-settings-modal/library-settings-modal.component.ts +++ b/UI/Web/src/app/sidenav/_components/library-settings-modal/library-settings-modal.component.ts @@ -1,13 +1,14 @@ -import { ChangeDetectionStrategy, ChangeDetectorRef, Component, Input, OnInit } from '@angular/core'; +import { ChangeDetectionStrategy, ChangeDetectorRef, Component, Input, OnDestroy, OnInit } from '@angular/core'; import { FormGroup, FormControl, Validators } from '@angular/forms'; import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { ToastrService } from 'ngx-toastr'; -import { debounceTime, distinctUntilChanged, filter, switchMap, tap } from 'rxjs'; +import { debounceTime, distinctUntilChanged, Subject, switchMap, takeUntil, tap } from 'rxjs'; import { SettingsService } from 'src/app/admin/settings.service'; import { DirectoryPickerComponent, DirectoryPickerResult } from 'src/app/admin/_modals/directory-picker/directory-picker.component'; import { ConfirmService } from 'src/app/shared/confirm.service'; import { Breakpoint, UtilityService } from 'src/app/shared/_services/utility.service'; import { Library, LibraryType } from 'src/app/_models/library'; +import { ImageService } from 'src/app/_services/image.service'; import { LibraryService } from 'src/app/_services/library.service'; import { UploadService } from 'src/app/_services/upload.service'; @@ -31,7 +32,7 @@ enum StepID { styleUrls: ['./library-settings-modal.component.scss'], changeDetection: ChangeDetectionStrategy.OnPush }) -export class LibrarySettingsModalComponent implements OnInit { +export class LibrarySettingsModalComponent implements OnInit, OnDestroy { @Input() library!: Library; @@ -53,6 +54,7 @@ export class LibrarySettingsModalComponent implements OnInit { isAddLibrary = false; setupStep = StepID.General; + private readonly onDestroy = new Subject(); get Breakpoint() { return Breakpoint; } get TabID() { return TabID; } @@ -60,7 +62,8 @@ export class LibrarySettingsModalComponent implements OnInit { constructor(public utilityService: UtilityService, private uploadService: UploadService, private modalService: NgbModal, private settingService: SettingsService, public modal: NgbActiveModal, private confirmService: ConfirmService, - private libraryService: LibraryService, private toastr: ToastrService, private readonly cdRef: ChangeDetectorRef) { } + private libraryService: LibraryService, private toastr: ToastrService, private readonly cdRef: ChangeDetectorRef, + private imageService: ImageService) { } ngOnInit(): void { @@ -76,7 +79,7 @@ export class LibrarySettingsModalComponent implements OnInit { } if (this.library?.coverImage != null && this.library?.coverImage !== '') { - this.imageUrls.push(this.library.coverImage); + this.imageUrls.push(this.imageService.getLibraryCoverImage(this.library.id)); this.cdRef.markForCheck(); } @@ -86,20 +89,26 @@ export class LibrarySettingsModalComponent implements OnInit { switchMap(name => this.libraryService.libraryNameExists(name)), tap(exists => { const isExistingName = this.libraryForm.get('name')?.value === this.library?.name; - console.log('isExistingName', isExistingName) if (!exists || isExistingName) { this.libraryForm.get('name')?.setErrors(null); } else { this.libraryForm.get('name')?.setErrors({duplicateName: true}) } this.cdRef.markForCheck(); - }) + }), + takeUntil(this.onDestroy) ).subscribe(); this.setValues(); } + ngOnDestroy() { + this.onDestroy.next(); + this.onDestroy.complete(); + } + + setValues() { if (this.library !== undefined) { this.libraryForm.get('name')?.setValue(this.library.name); diff --git a/UI/Web/src/theme/themes/dark.scss b/UI/Web/src/theme/themes/dark.scss index 2a71d8497..6bb68e947 100644 --- a/UI/Web/src/theme/themes/dark.scss +++ b/UI/Web/src/theme/themes/dark.scss @@ -194,6 +194,7 @@ --card-progress-bar-color: var(--primary-color); --card-overlay-bg-color: rgba(0, 0, 0, 0); --card-overlay-hover-bg-color: rgba(0, 0, 0, 0.2); + --card-progress-triangle-size: 30px; /* Slider */ --slider-text-color: white; diff --git a/openapi.json b/openapi.json new file mode 100644 index 000000000..aa798003f --- /dev/null +++ b/openapi.json @@ -0,0 +1,13362 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Kavita", + "description": "Kavita provides a set of APIs that are authenticated by JWT. JWT token can be copied from local storage.", + "license": { + "name": "GPL-3.0", + "url": "https://github.com/Kareadita/Kavita/blob/develop/LICENSE" + }, + "version": "0.6.1.5" + }, + "servers": [ + { + "url": "{protocol}://{hostpath}", + "variables": { + "protocol": { + "default": "http", + "enum": [ + "http", + "https" + ] + }, + "hostpath": { + "default": "localhost:5000" + } + } + } + ], + "paths": { + "/api/Account/reset-password": { + "post": { + "tags": [ + "Account" + ], + "summary": "Update a user's password", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResetPasswordDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResetPasswordDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ResetPasswordDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Account/register": { + "post": { + "tags": [ + "Account" + ], + "summary": "Register the first user (admin) on the server. Will not do anything if an admin is already confirmed", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RegisterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RegisterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + } + } + } + } + } + }, + "/api/Account/login": { + "post": { + "tags": [ + "Account" + ], + "summary": "Perform a login. Will send JWT Token of the logged in user back.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LoginDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/LoginDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + } + } + } + } + } + }, + "/api/Account/refresh-token": { + "post": { + "tags": [ + "Account" + ], + "summary": "Refreshes the user's JWT token", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TokenRequestDto" + } + } + } + } + } + } + }, + "/api/Account/roles": { + "get": { + "tags": [ + "Account" + ], + "summary": "Get All Roles back. See API.Constants.PolicyConstants", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/Account/reset-api-key": { + "post": { + "tags": [ + "Account" + ], + "summary": "Resets the API Key assigned with a user", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/update/email": { + "post": { + "tags": [ + "Account" + ], + "summary": "Initiates the flow to update a user's email address. The email address is not changed in this API. A confirmation link is sent/dumped which will\r\nvalidate the email. It must be confirmed for the email to update.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateEmailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateEmailDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateEmailDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Account/update/age-restriction": { + "post": { + "tags": [ + "Account" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAgeRestrictionDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAgeRestrictionDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateAgeRestrictionDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Account/update": { + "post": { + "tags": [ + "Account" + ], + "summary": "Update the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateUserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateUserDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateUserDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Account/invite-url": { + "get": { + "tags": [ + "Account" + ], + "summary": "Requests the Invite Url for the UserId. Will return error if user is already validated.", + "parameters": [ + { + "name": "userId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "withBaseUrl", + "in": "query", + "description": "Include the \"https://ip:port/\" in the generated link", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/invite": { + "post": { + "tags": [ + "Account" + ], + "summary": "Invites a user to the server. Will generate a setup link for continuing setup. If the server is not accessible, no\r\nemail will be sent.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InviteUserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InviteUserDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/InviteUserDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/confirm-email": { + "post": { + "tags": [ + "Account" + ], + "summary": "Last step in authentication flow, confirms the email token for email", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + } + } + } + } + } + }, + "/api/Account/confirm-email-update": { + "post": { + "tags": [ + "Account" + ], + "summary": "Final step in email update change. Given a confirmation token and the email, this will finish the email change.", + "description": "This will force connected clients to re-authenticate", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailUpdateDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailUpdateDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ConfirmEmailUpdateDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Account/confirm-password-reset": { + "post": { + "tags": [ + "Account" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmPasswordResetDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmPasswordResetDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ConfirmPasswordResetDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/forgot-password": { + "post": { + "tags": [ + "Account" + ], + "summary": "Will send user a link to update their password to their email or prompt them if not accessible", + "parameters": [ + { + "name": "email", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/email-confirmed": { + "get": { + "tags": [ + "Account" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Account/confirm-migration-email": { + "post": { + "tags": [ + "Account" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmMigrationEmailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ConfirmMigrationEmailDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ConfirmMigrationEmailDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + } + } + } + } + } + }, + "/api/Account/resend-confirmation-email": { + "post": { + "tags": [ + "Account" + ], + "parameters": [ + { + "name": "userId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Account/migrate-email": { + "post": { + "tags": [ + "Account" + ], + "summary": "This is similar to invite. Essentially we authenticate the user's password then go through invite email flow", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MigrateUserEmailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MigrateUserEmailDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MigrateUserEmailDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Admin/exists": { + "get": { + "tags": [ + "Admin" + ], + "summary": "Checks if an admin exists on the system. This is essentially a check to validate if the system has been setup.", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Book/{chapterId}/book-info": { + "get": { + "tags": [ + "Book" + ], + "summary": "Retrieves information for the PDF and Epub reader", + "description": "This only applies to Epub or PDF files", + "parameters": [ + { + "name": "chapterId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BookInfoDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookInfoDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BookInfoDto" + } + } + } + } + } + } + }, + "/api/Book/{chapterId}/book-resources": { + "get": { + "tags": [ + "Book" + ], + "summary": "This is an entry point to fetch resources from within an epub chapter/book.", + "parameters": [ + { + "name": "chapterId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "file", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Book/{chapterId}/chapters": { + "get": { + "tags": [ + "Book" + ], + "summary": "This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order\r\nthis is used to rewrite anchors in the book text so that we always load properly in our reader.", + "description": "This is essentially building the table of contents", + "parameters": [ + { + "name": "chapterId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookChapterItem" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookChapterItem" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookChapterItem" + } + } + } + } + } + } + } + }, + "/api/Book/{chapterId}/book-page": { + "get": { + "tags": [ + "Book" + ], + "summary": "This returns a single page within the epub book. All html will be rewritten to be scoped within our reader,\r\nall css is scoped, etc.", + "parameters": [ + { + "name": "chapterId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "page", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Collection": { + "get": { + "tags": [ + "Collection" + ], + "summary": "Return a list of all collection tags on the server", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + } + } + } + } + } + }, + "/api/Collection/search": { + "get": { + "tags": [ + "Collection" + ], + "summary": "Searches against the collection tags on the DB and returns matches that meet the search criteria.\r\nSearch strings will be cleaned of certain fields, like %", + "parameters": [ + { + "name": "queryString", + "in": "query", + "description": "Search term", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + } + } + } + } + } + }, + "/api/Collection/name-exists": { + "get": { + "tags": [ + "Collection" + ], + "summary": "Checks if a collection exists with the name", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "If empty or null, will return true as that is invalid", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Collection/update": { + "post": { + "tags": [ + "Collection" + ], + "summary": "Updates an existing tag with a new title, promotion status, and summary.\r\nUI does not contain controls to update title", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Collection/update-for-series": { + "post": { + "tags": [ + "Collection" + ], + "summary": "Adds a collection tag onto multiple Series. If tag id is 0, this will create a new tag.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagBulkAddDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagBulkAddDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CollectionTagBulkAddDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Collection/update-series": { + "post": { + "tags": [ + "Collection" + ], + "summary": "For a given tag, update the summary if summary has changed and remove a set of series from the tag.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesForTagDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesForTagDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesForTagDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Device/create": { + "post": { + "tags": [ + "Device" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDeviceDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CreateDeviceDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CreateDeviceDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Device/update": { + "post": { + "tags": [ + "Device" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDeviceDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDeviceDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateDeviceDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Device": { + "delete": { + "tags": [ + "Device" + ], + "summary": "Deletes the device from the user", + "parameters": [ + { + "name": "deviceId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "Device" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceDto" + } + } + } + } + } + } + } + }, + "/api/Device/send-to": { + "post": { + "tags": [ + "Device" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendToDeviceDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SendToDeviceDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SendToDeviceDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Download/volume-size": { + "get": { + "tags": [ + "Download" + ], + "summary": "For a given volume, return the size in bytes", + "parameters": [ + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "/api/Download/chapter-size": { + "get": { + "tags": [ + "Download" + ], + "summary": "For a given chapter, return the size in bytes", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "/api/Download/series-size": { + "get": { + "tags": [ + "Download" + ], + "summary": "For a series, return the size in bytes", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "/api/Download/volume": { + "get": { + "tags": [ + "Download" + ], + "summary": "Downloads all chapters within a volume. If the chapters are multiple zips, they will all be zipped up.", + "parameters": [ + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Download/chapter": { + "get": { + "tags": [ + "Download" + ], + "summary": "Returns the zip for a single chapter. If the chapter contains multiple files, they will be zipped.", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Download/series": { + "get": { + "tags": [ + "Download" + ], + "parameters": [ + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Download/bookmarks": { + "post": { + "tags": [ + "Download" + ], + "summary": "Downloads all bookmarks in a zip for", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DownloadBookmarkDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DownloadBookmarkDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DownloadBookmarkDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Health": { + "get": { + "tags": [ + "Health" + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/chapter-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for Chapter", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/library-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for Library", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/volume-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for Volume", + "parameters": [ + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/series-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for Series", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "Id of Series", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/collection-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for Collection Tag", + "parameters": [ + { + "name": "collectionTagId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/readinglist-cover": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns cover image for a Reading List", + "parameters": [ + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/bookmark": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns image for a given bookmark page", + "description": "This request is served unauthenticated, but user must be passed via api key to validate", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNum", + "in": "query", + "description": "Starts at 0", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "apiKey", + "in": "query", + "description": "API Key for user. Needed to authenticate request", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Image/cover-upload": { + "get": { + "tags": [ + "Image" + ], + "summary": "Returns a temp coverupload image", + "parameters": [ + { + "name": "filename", + "in": "query", + "description": "Filename of file. This is used with upload/upload-by-url", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/create": { + "post": { + "tags": [ + "Library" + ], + "summary": "Creates a new Library. Upon library creation, adds new library to all Admin accounts.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLibraryDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CreateLibraryDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CreateLibraryDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/list": { + "get": { + "tags": [ + "Library" + ], + "summary": "Returns a list of directories for a given path. If path is empty, returns root drives.", + "parameters": [ + { + "name": "path", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DirectoryDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DirectoryDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DirectoryDto" + } + } + } + } + } + } + } + }, + "/api/Library": { + "get": { + "tags": [ + "Library" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + } + } + } + } + } + } + } + }, + "/api/Library/jump-bar": { + "get": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JumpKeyDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JumpKeyDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JumpKeyDto" + } + } + } + } + } + } + } + }, + "/api/Library/grant-access": { + "post": { + "tags": [ + "Library" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryForUserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryForUserDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryForUserDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/MemberDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MemberDto" + } + } + } + } + } + } + }, + "/api/Library/scan": { + "post": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "force", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/refresh-metadata": { + "post": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "force", + "in": "query", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/analyze": { + "post": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/scan-folder": { + "post": { + "tags": [ + "Library" + ], + "summary": "Given a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScanFolderDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ScanFolderDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ScanFolderDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/delete": { + "delete": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Library/name-exists": { + "get": { + "tags": [ + "Library" + ], + "summary": "Checks if the library name exists or not", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "If empty or null, will return true as that is invalid", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Library/update": { + "post": { + "tags": [ + "Library" + ], + "summary": "Updates an existing Library with new name, folders, and/or type.", + "description": "Any folder or type change will invoke a scan.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateLibraryDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Library/type": { + "get": { + "tags": [ + "Library" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/LibraryType" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LibraryType" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LibraryType" + } + } + } + } + } + } + }, + "/api/Metadata/genres": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches genres from the instance", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all genres", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenreTagDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenreTagDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenreTagDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/people": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches people from the instance", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all people", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/tags": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches all tags from the instance", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all tags", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/age-ratings": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches all age ratings from the instance", + "description": "This API is cached for 1 hour, varying by libraryIds", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all ratings", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/publication-status": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches all publication status' from the instance", + "description": "This API is cached for 1 hour, varying by libraryIds", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all publication status", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRatingDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/languages": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Fetches all age languages from the libraries passed (or if none passed, all in the server)", + "description": "This does not perform RBS for the user if they have Library access due to the non-sensitive nature of languages", + "parameters": [ + { + "name": "libraryIds", + "in": "query", + "description": "String separated libraryIds or null for all ratings", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/all-languages": { + "get": { + "tags": [ + "Metadata" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageDto" + } + } + } + } + } + } + } + }, + "/api/Metadata/chapter-summary": { + "get": { + "tags": [ + "Metadata" + ], + "summary": "Returns summary for the chapter", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Opds/{apiKey}": { + "post": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/libraries": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/collections": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/collections/{collectionId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "collectionId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/reading-list": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/reading-list/{readingListId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "readingListId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/libraries/{libraryId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "libraryId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/recently-added": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/on-deck": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/series": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/search": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/series/{seriesId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "seriesId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "seriesId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId}": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "seriesId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chapterId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/series/{seriesId}/volume/{volumeId}/chapter/{chapterId}/download/{filename}": { + "get": { + "tags": [ + "Opds" + ], + "summary": "Downloads a file", + "parameters": [ + { + "name": "apiKey", + "in": "path", + "description": "User's API Key", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "seriesId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chapterId", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "filename", + "in": "path", + "description": "Not used. Only for Chunky to allow download links", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/image": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chapterId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Opds/{apiKey}/favicon": { + "get": { + "tags": [ + "Opds" + ], + "parameters": [ + { + "name": "apiKey", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Plugin/authenticate": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Authenticate with the Server given an apiKey. This will log you in by returning the user object and the JWT token.", + "description": "This API is not fully built out and may require more information in later releases", + "parameters": [ + { + "name": "apiKey", + "in": "query", + "description": "API key which will be used to authenticate and return a valid user token back", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pluginName", + "in": "query", + "description": "Name of the Plugin", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDto" + } + } + } + } + } + } + }, + "/api/Reader/pdf": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns the PDF for the chapterId.", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/image": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns an image for a given chapter. Will perform bounding checks", + "description": "This will cache the chapter images for reading", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "page", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/bookmark-image": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.", + "description": "We must use api key as bookmarks could be leaked to other users via the API", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "apiKey", + "in": "query", + "description": "Api key for the user the bookmarks are on", + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/chapter-info": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterInfoDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterInfoDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterInfoDto" + } + } + } + } + } + } + }, + "/api/Reader/bookmark-info": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "Series Id for all bookmarks", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BookmarkInfoDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkInfoDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkInfoDto" + } + } + } + } + } + } + }, + "/api/Reader/mark-read": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks a Series as read. All volumes and chapters will be marked as read during this process.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-unread": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks a Series as Unread. All volumes and chapters will be marked as unread during this process.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-volume-unread": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a volume as unread", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-volume-read": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a volume as Read", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumeReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-multiple-read": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a list of volumes as Read. All volumes must belong to the same Series.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-multiple-unread": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a list of volumes as Unread. All volumes must belong to the same Series.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkVolumesReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-multiple-series-read": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a list of series as Read.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/mark-multiple-series-unread": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks all chapters within a list of series as Unread.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/MarkMultipleSeriesAsReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/get-progress": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns Progress (page number) for a chapter for the logged in user", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + } + } + } + } + } + }, + "/api/Reader/progress": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Save page against Chapter for logged in user", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ProgressDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/continue-point": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Continue point is the chapter which you should start reading again from. If there is no progress on a series, then the first chapter will be returned (non-special unless only specials).\r\nOtherwise, loop through the chapters and volumes in order to find the next chapter which has progress.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + } + } + } + } + } + }, + "/api/Reader/has-progress": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns if the user has reading progress on the Series", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + } + } + } + } + } + }, + "/api/Reader/mark-chapter-until-as-read": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Marks every chapter that is sorted below the passed number as Read. This will not mark any specials as read.", + "description": "This is built for Tachiyomi and is not expected to be called by any other place", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chapterNumber", + "in": "query", + "schema": { + "type": "number", + "format": "float" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "deprecated": true + } + }, + "/api/Reader/chapter-bookmarks": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns a list of bookmarked pages for a given Chapter", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + } + } + } + } + }, + "/api/Reader/all-bookmarks": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Returns a list of all bookmarked pages for a User", + "requestBody": { + "description": "Only supports SeriesNameQuery", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + } + } + } + } + }, + "/api/Reader/remove-bookmarks": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Removes all bookmarks for all chapters linked to a Series", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveBookmarkForSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RemoveBookmarkForSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RemoveBookmarkForSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/bulk-remove-bookmarks": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Removes all bookmarks for all chapters linked to a Series", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkRemoveBookmarkForSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BulkRemoveBookmarkForSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/BulkRemoveBookmarkForSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/volume-bookmarks": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns all bookmarked pages for a given volume", + "parameters": [ + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + } + } + } + } + }, + "/api/Reader/series-bookmarks": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns all bookmarked pages for a given series", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + } + } + } + } + }, + "/api/Reader/bookmark": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Bookmarks a page against a Chapter", + "description": "This has a side effect of caching the chapter files to disk", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/unbookmark": { + "post": { + "tags": [ + "Reader" + ], + "summary": "Removes a bookmarked page for a Chapter", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Reader/next-chapter": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns the next logical chapter from the series.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "currentChapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "/api/Reader/prev-chapter": { + "get": { + "tags": [ + "Reader" + ], + "summary": "Returns the previous logical chapter from the series.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "volumeId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "currentChapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "/api/Reader/time-left": { + "get": { + "tags": [ + "Reader" + ], + "summary": "For the current user, returns an estimate on how long it would take to finish reading the series.", + "description": "For Epubs, this does not check words inside a chapter due to overhead so may not work in all cases.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/HourEstimateRangeDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/HourEstimateRangeDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/HourEstimateRangeDto" + } + } + } + } + } + } + }, + "/api/ReadingList": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Fetches a single Reading List", + "parameters": [ + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + } + } + } + } + }, + "delete": { + "tags": [ + "ReadingList" + ], + "summary": "Deletes a reading list", + "parameters": [ + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/lists": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Returns reading lists (paginated) for a given user.", + "parameters": [ + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "includePromoted", + "in": "query", + "description": "Include Promoted Reading Lists along with user's Reading Lists. Defaults to true", + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + } + } + } + } + } + }, + "/api/ReadingList/lists-for-series": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Returns all Reading Lists the user has access to that have a series within it.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + } + } + } + } + } + }, + "/api/ReadingList/items": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Fetches all reading list items for a given list including rich metadata around series, volume, chapters, and progress", + "description": "This call is expensive", + "parameters": [ + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListItemDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListItemDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListItemDto" + } + } + } + } + } + } + } + }, + "/api/ReadingList/update-position": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Updates an items position", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/delete-item": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Deletes a list item from the list. Will reorder all item positions afterwards", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/remove-read": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Removes all entries that are fully read from the reading list", + "parameters": [ + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/create": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Creates a new List with a unique title. Returns the new ReadingList back", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateReadingListDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CreateReadingListDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/CreateReadingListDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ReadingListDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadingListDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ReadingListDto" + } + } + } + } + } + } + }, + "/api/ReadingList/update": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Update the properties (title, summary) of a reading list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/update-by-series": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Adds all chapters from a Series to a reading list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListBySeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListBySeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListBySeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/update-by-multiple": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Adds all chapters from a list of volumes and chapters to a reading list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/update-by-multiple-series": { + "post": { + "tags": [ + "ReadingList" + ], + "summary": "Adds all chapters from a list of series to a reading list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByMultipleSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/update-by-volume": { + "post": { + "tags": [ + "ReadingList" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByVolumeDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByVolumeDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByVolumeDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/update-by-chapter": { + "post": { + "tags": [ + "ReadingList" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByChapterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateReadingListByChapterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/ReadingList/next-chapter": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Returns the next chapter within the reading list", + "parameters": [ + { + "name": "currentChapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "/api/ReadingList/prev-chapter": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Returns the prev chapter within the reading list", + "parameters": [ + { + "name": "currentChapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "readingListId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + }, + "text/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "/api/ReadingList/name-exists": { + "get": { + "tags": [ + "ReadingList" + ], + "summary": "Checks if a reading list exists with the name", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "If empty or null, will return true as that is invalid", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Recommended/quick-reads": { + "get": { + "tags": [ + "Recommended" + ], + "summary": "Quick Reads are series that should be readable in less than 10 in total and are not Ongoing in release.", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "Library to restrict series to", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Recommended/quick-catchup-reads": { + "get": { + "tags": [ + "Recommended" + ], + "summary": "Quick Catchup Reads are series that should be readable in less than 10 in total and are Ongoing in release.", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "Library to restrict series to", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Recommended/highly-rated": { + "get": { + "tags": [ + "Recommended" + ], + "summary": "Highly Rated based on other users ratings. Will pull series with ratings > 4.0, weighted by count of other users.", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "Library to restrict series to", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Recommended/more-in": { + "get": { + "tags": [ + "Recommended" + ], + "summary": "Chooses a random genre and shows series that are in that without reading progress", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "Library to restrict series to", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "genreId", + "in": "query", + "description": "Genre Id", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Recommended/rediscover": { + "get": { + "tags": [ + "Recommended" + ], + "summary": "Series that are fully read by the user in no particular order", + "parameters": [ + { + "name": "libraryId", + "in": "query", + "description": "Library to restrict series to", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Search/series-for-mangafile": { + "get": { + "tags": [ + "Search" + ], + "summary": "Returns the series for the MangaFile id. If the user does not have access (shouldn't happen by the UI),\r\nthen null is returned", + "parameters": [ + { + "name": "mangaFileId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + }, + "/api/Search/series-for-chapter": { + "get": { + "tags": [ + "Search" + ], + "summary": "Returns the series for the Chapter id. If the user does not have access (shouldn't happen by the UI),\r\nthen null is returned", + "parameters": [ + { + "name": "chapterId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + }, + "/api/Search/search": { + "get": { + "tags": [ + "Search" + ], + "parameters": [ + { + "name": "queryString", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SearchResultGroupDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchResultGroupDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SearchResultGroupDto" + } + } + } + } + } + } + }, + "/api/Series": { + "post": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Series" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Series" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Series" + } + } + } + } + } + } + } + }, + "/api/Series/{seriesId}": { + "get": { + "tags": [ + "Series" + ], + "summary": "Fetches a Series for a given Id", + "parameters": [ + { + "name": "seriesId", + "in": "path", + "description": "Series Id to fetch details for", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "seriesId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Series/delete-multiple": { + "post": { + "tags": [ + "Series" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DeleteSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DeleteSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/volumes": { + "get": { + "tags": [ + "Series" + ], + "summary": "Returns All volumes for a series with progress information and Chapters", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VolumeDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VolumeDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VolumeDto" + } + } + } + } + } + } + } + }, + "/api/Series/volume": { + "get": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "volumeId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/VolumeDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/VolumeDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/VolumeDto" + } + } + } + } + } + } + }, + "/api/Series/chapter": { + "get": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "chapterId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + } + } + } + } + } + }, + "/api/Series/chapter-metadata": { + "get": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "chapterId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + } + } + } + } + } + }, + "/api/Series/update-rating": { + "post": { + "tags": [ + "Series" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesRatingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesRatingDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesRatingDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/update": { + "post": { + "tags": [ + "Series" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/recently-added": { + "post": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/recently-updated-series": { + "post": { + "tags": [ + "Series" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecentlyAddedItemDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecentlyAddedItemDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecentlyAddedItemDto" + } + } + } + } + } + } + } + }, + "/api/Series/all": { + "post": { + "tags": [ + "Series" + ], + "parameters": [ + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/on-deck": { + "post": { + "tags": [ + "Series" + ], + "summary": "Fetches series that are on deck aka have progress on them.", + "parameters": [ + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "libraryId", + "in": "query", + "description": "Default of 0 meaning all libraries", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/refresh-metadata": { + "post": { + "tags": [ + "Series" + ], + "summary": "Runs a Cover Image Generation task", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/scan": { + "post": { + "tags": [ + "Series" + ], + "summary": "Scan a series and force each file to be updated. This should be invoked via the User, hence why we force.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/analyze": { + "post": { + "tags": [ + "Series" + ], + "summary": "Run a file analysis on the series.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/RefreshSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/metadata": { + "get": { + "tags": [ + "Series" + ], + "summary": "Returns metadata for a given series", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SeriesMetadataDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesMetadataDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesMetadataDto" + } + } + } + } + } + }, + "post": { + "tags": [ + "Series" + ], + "summary": "Update series metadata", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesMetadataDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesMetadataDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateSeriesMetadataDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Series/series-by-collection": { + "get": { + "tags": [ + "Series" + ], + "summary": "Returns all Series grouped by the passed Collection Id with Pagination.", + "parameters": [ + { + "name": "collectionId", + "in": "query", + "description": "Collection Id to pull series from", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/series-by-ids": { + "post": { + "tags": [ + "Series" + ], + "summary": "Fetches Series for a set of Ids. This will check User for permission access and filter out any Ids that don't exist or\r\nthe user does not have access to.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesByIdsDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesByIdsDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SeriesByIdsDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/age-rating": { + "get": { + "tags": [ + "Series" + ], + "summary": "Get the age rating for the API.Entities.Enums.AgeRating enum value", + "description": "This is cached for an hour", + "parameters": [ + { + "name": "ageRating", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Series/series-detail": { + "get": { + "tags": [ + "Series" + ], + "summary": "Get a special DTO for Series Detail page.", + "description": "Do not rely on this API externally. May change without hesitation.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SeriesDetailDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDetailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SeriesDetailDto" + } + } + } + } + } + } + }, + "/api/Series/related": { + "get": { + "tags": [ + "Series" + ], + "summary": "Fetches the related series for a given series", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "relation", + "in": "query", + "description": "Type of Relationship to pull back", + "schema": { + "$ref": "#/components/schemas/RelationKind" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + } + }, + "/api/Series/all-related": { + "get": { + "tags": [ + "Series" + ], + "summary": "Returns all related series against the passed series Id", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/RelatedSeriesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RelatedSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/RelatedSeriesDto" + } + } + } + } + } + } + }, + "/api/Series/update-related": { + "post": { + "tags": [ + "Series" + ], + "summary": "Update the relations attached to the Series. Does not generate associated Sequel/Prequel pairs on target series.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateRelatedSeriesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateRelatedSeriesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateRelatedSeriesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/restart": { + "post": { + "tags": [ + "Server" + ], + "summary": "Attempts to Restart the server. Does not work, will shutdown the instance.", + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/clear-cache": { + "post": { + "tags": [ + "Server" + ], + "summary": "Performs an ad-hoc cleanup of Cache", + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/cleanup-want-to-read": { + "post": { + "tags": [ + "Server" + ], + "summary": "Performs an ad-hoc cleanup of Want To Read, by removing want to read series for users, where the series are fully read and in Completed publication status.", + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/backup-db": { + "post": { + "tags": [ + "Server" + ], + "summary": "Performs an ad-hoc backup of the Database", + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/server-info": { + "get": { + "tags": [ + "Server" + ], + "summary": "Returns non-sensitive information about the current system", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerInfoDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerInfoDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerInfoDto" + } + } + } + } + } + } + }, + "/api/Server/convert-bookmarks": { + "post": { + "tags": [ + "Server" + ], + "summary": "Triggers the scheduling of the convert bookmarks job. Only one job will run at a time.", + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/logs": { + "get": { + "tags": [ + "Server" + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Server/check-update": { + "get": { + "tags": [ + "Server" + ], + "summary": "Checks for updates, if no updates that are > current version installed, returns null", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + } + } + } + } + } + }, + "/api/Server/changelog": { + "get": { + "tags": [ + "Server" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UpdateNotificationDto" + } + } + } + } + } + } + } + }, + "/api/Server/accessible": { + "get": { + "tags": [ + "Server" + ], + "summary": "Is this server accessible to the outside net", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Server/jobs": { + "get": { + "tags": [ + "Server" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobDto" + } + } + } + } + } + } + } + }, + "/api/Settings/base-url": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Settings": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + } + } + } + } + }, + "post": { + "tags": [ + "Settings" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + } + } + } + } + } + }, + "/api/Settings/reset": { + "post": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + } + } + } + } + } + }, + "/api/Settings/reset-email-url": { + "post": { + "tags": [ + "Settings" + ], + "summary": "Resets the email service url", + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServerSettingDto" + } + } + } + } + } + } + }, + "/api/Settings/test-email-url": { + "post": { + "tags": [ + "Settings" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestEmailDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TestEmailDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/TestEmailDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/EmailTestResultDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmailTestResultDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/EmailTestResultDto" + } + } + } + } + } + } + }, + "/api/Settings/task-frequencies": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/Settings/library-types": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/Settings/log-levels": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/Settings/opds-enabled": { + "get": { + "tags": [ + "Settings" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Tachiyomi/latest-chapter": { + "get": { + "tags": [ + "Tachiyomi" + ], + "summary": "Given the series Id, this should return the latest chapter that has been fully read.", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "description": "", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ChapterDto" + } + } + } + } + } + } + }, + "/api/Tachiyomi/mark-chapter-until-as-read": { + "post": { + "tags": [ + "Tachiyomi" + ], + "summary": "Marks every chapter that is sorted below the passed number as Read. This will not mark any specials as read.", + "description": "This is built for Tachiyomi and is not expected to be called by any other place", + "parameters": [ + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chapterNumber", + "in": "query", + "schema": { + "type": "number", + "format": "float" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Theme": { + "get": { + "tags": [ + "Theme" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SiteThemeDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SiteThemeDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SiteThemeDto" + } + } + } + } + } + } + } + }, + "/api/Theme/scan": { + "post": { + "tags": [ + "Theme" + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Theme/update-default": { + "post": { + "tags": [ + "Theme" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDefaultThemeDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDefaultThemeDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateDefaultThemeDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Theme/download-content": { + "get": { + "tags": [ + "Theme" + ], + "summary": "Returns css content to the UI. UI is expected to escape the content", + "parameters": [ + { + "name": "themeId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Upload/upload-by-url": { + "post": { + "tags": [ + "Upload" + ], + "summary": "This stores a file (image) in temp directory for use in a cover image replacement flow.\r\nThis is automatically cleaned up.", + "requestBody": { + "description": "Escaped url to download from", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadUrlDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadUrlDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadUrlDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/api/Upload/series": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces series cover image and locks it with a base64 encoded image", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Upload/collection": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces collection tag cover image and locks it with a base64 encoded image", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Upload/reading-list": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces reading list cover image and locks it with a base64 encoded image", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Upload/chapter": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces chapter cover image and locks it with a base64 encoded image. This will update the parent volume's cover image.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Upload/library": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces library cover image with a base64 encoded image. If empty string passed, will reset to null.", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Upload/reset-chapter-lock": { + "post": { + "tags": [ + "Upload" + ], + "summary": "Replaces chapter cover image and locks it with a base64 encoded image. This will update the parent volume's cover image.", + "requestBody": { + "description": "Does not use Url property", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UploadFileDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Users/delete-user": { + "delete": { + "tags": [ + "Users" + ], + "parameters": [ + { + "name": "username", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/Users": { + "get": { + "tags": [ + "Users" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + } + } + } + } + } + }, + "/api/Users/pending": { + "get": { + "tags": [ + "Users" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MemberDto" + } + } + } + } + } + } + } + }, + "/api/Users/has-reading-progress": { + "get": { + "tags": [ + "Users" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Users/has-library-access": { + "get": { + "tags": [ + "Users" + ], + "parameters": [ + { + "name": "libraryId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/Users/update-preferences": { + "post": { + "tags": [ + "Users" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + } + } + } + } + } + }, + "/api/Users/get-preferences": { + "get": { + "tags": [ + "Users" + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserPreferencesDto" + } + } + } + } + } + } + }, + "/api/want-to-read": { + "post": { + "tags": [ + "WantToRead" + ], + "summary": "Return all Series that are in the current logged in user's Want to Read list, filtered", + "parameters": [ + { + "name": "PageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "If set to 0, will set as MaxInt", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/FilterDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + } + } + } + } + } + } + }, + "get": { + "tags": [ + "WantToRead" + ], + "parameters": [ + { + "name": "seriesId", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, + "application/json": { + "schema": { + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/want-to-read/add-series": { + "post": { + "tags": [ + "WantToRead" + ], + "summary": "Given a list of Series Ids, add them to the current logged in user's Want To Read list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/api/want-to-read/remove-series": { + "post": { + "tags": [ + "WantToRead" + ], + "summary": "Given a list of Series Ids, remove them from the current logged in user's Want To Read list", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UpdateWantToReadDto" + } + } + } + }, + "responses": { + "200": { + "description": "Success" + } + } + } + } + }, + "components": { + "schemas": { + "AgeRating": { + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + -1 + ], + "type": "integer", + "description": "Represents Age Rating for content.", + "format": "int32" + }, + "AgeRatingDto": { + "type": "object", + "properties": { + "value": { + "$ref": "#/components/schemas/AgeRating" + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "AgeRestrictionDto": { + "type": "object", + "properties": { + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "includeUnknowns": { + "type": "boolean", + "description": "Are Unknowns explicitly allowed against age rating" + } + }, + "additionalProperties": false + }, + "AppRole": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "normalizedName": { + "type": "string", + "nullable": true + }, + "concurrencyStamp": { + "type": "string", + "nullable": true + }, + "userRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserRole" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "AppUser": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "userName": { + "type": "string", + "nullable": true + }, + "normalizedUserName": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "normalizedEmail": { + "type": "string", + "nullable": true + }, + "emailConfirmed": { + "type": "boolean" + }, + "passwordHash": { + "type": "string", + "nullable": true + }, + "securityStamp": { + "type": "string", + "nullable": true + }, + "concurrencyStamp": { + "type": "string", + "nullable": true + }, + "phoneNumber": { + "type": "string", + "nullable": true + }, + "phoneNumberConfirmed": { + "type": "boolean" + }, + "twoFactorEnabled": { + "type": "boolean" + }, + "lockoutEnd": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "lockoutEnabled": { + "type": "boolean" + }, + "accessFailedCount": { + "type": "integer", + "format": "int32" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastActive": { + "type": "string", + "format": "date-time" + }, + "libraries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Library" + }, + "nullable": true + }, + "userRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserRole" + }, + "nullable": true + }, + "progresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserProgress" + }, + "nullable": true + }, + "ratings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserRating" + }, + "nullable": true + }, + "userPreferences": { + "$ref": "#/components/schemas/AppUserPreferences" + }, + "bookmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserBookmark" + }, + "description": "Bookmarks associated with this User", + "nullable": true + }, + "readingLists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingList" + }, + "description": "Reading lists associated with this user", + "nullable": true + }, + "wantToRead": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Series" + }, + "description": "A list of Series the user want's to read", + "nullable": true + }, + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Device" + }, + "description": "A list of Devices which allows the user to send files to", + "nullable": true + }, + "apiKey": { + "type": "string", + "description": "An API Key to interact with external services, like OPDS", + "nullable": true + }, + "confirmationToken": { + "type": "string", + "description": "The confirmation token for the user (invite). This will be set to null after the user confirms.", + "nullable": true + }, + "ageRestriction": { + "$ref": "#/components/schemas/AgeRating" + }, + "ageRestrictionIncludeUnknowns": { + "type": "boolean", + "description": "If an age rating restriction is applied to the account, if Unknowns should be allowed for the user. Defaults to false." + }, + "rowVersion": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "AppUserBookmark": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "format": "int32" + }, + "fileName": { + "type": "string", + "description": "Filename in the Bookmark Directory", + "nullable": true + }, + "appUserId": { + "type": "integer", + "format": "int32" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "description": "Represents a saved page in a Chapter entity for a given user." + }, + "AppUserPreferences": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "readingDirection": { + "$ref": "#/components/schemas/ReadingDirection" + }, + "scalingOption": { + "$ref": "#/components/schemas/ScalingOption" + }, + "pageSplitOption": { + "$ref": "#/components/schemas/PageSplitOption" + }, + "readerMode": { + "$ref": "#/components/schemas/ReaderMode" + }, + "autoCloseMenu": { + "type": "boolean", + "description": "Manga Reader Option: Allow the menu to close after 6 seconds without interaction" + }, + "showScreenHints": { + "type": "boolean", + "description": "Manga Reader Option: Show screen hints to the user on some actions, ie) pagination direction change" + }, + "layoutMode": { + "$ref": "#/components/schemas/LayoutMode" + }, + "backgroundColor": { + "type": "string", + "description": "Manga Reader Option: Background color of the reader", + "nullable": true + }, + "bookReaderMargin": { + "type": "integer", + "description": "Book Reader Option: Override extra Margin", + "format": "int32" + }, + "bookReaderLineSpacing": { + "type": "integer", + "description": "Book Reader Option: Override line-height", + "format": "int32" + }, + "bookReaderFontSize": { + "type": "integer", + "description": "Book Reader Option: Override font size", + "format": "int32" + }, + "bookReaderFontFamily": { + "type": "string", + "description": "Book Reader Option: Maps to the default Kavita font-family (inherit) or an override", + "nullable": true + }, + "bookReaderTapToPaginate": { + "type": "boolean", + "description": "Book Reader Option: Allows tapping on side of screens to paginate" + }, + "bookReaderReadingDirection": { + "$ref": "#/components/schemas/ReadingDirection" + }, + "theme": { + "$ref": "#/components/schemas/SiteTheme" + }, + "bookThemeName": { + "type": "string", + "description": "Book Reader Option: The color theme to decorate the book contents", + "nullable": true + }, + "bookReaderLayoutMode": { + "$ref": "#/components/schemas/BookPageLayoutMode" + }, + "bookReaderImmersiveMode": { + "type": "boolean", + "description": "Book Reader Option: A flag that hides the menu-ing system behind a click on the screen. This should be used with tap to paginate, but the app doesn't enforce this." + }, + "globalPageLayoutMode": { + "$ref": "#/components/schemas/PageLayoutMode" + }, + "blurUnreadSummaries": { + "type": "boolean", + "description": "UI Site Global Setting: If unread summaries should be blurred until expanded or unless user has read it already" + }, + "promptForDownloadSize": { + "type": "boolean", + "description": "UI Site Global Setting: Should Kavita prompt user to confirm downloads that are greater than 100 MB." + }, + "noTransitions": { + "type": "boolean", + "description": "UI Site Global Setting: Should Kavita disable CSS transitions" + }, + "appUser": { + "$ref": "#/components/schemas/AppUser" + }, + "appUserId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "AppUserProgress": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Id of Entity", + "format": "int32" + }, + "pagesRead": { + "type": "integer", + "description": "Pages Read for given Chapter", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "description": "Volume belonging to Chapter", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "description": "Series belonging to Chapter", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "description": "Chapter", + "format": "int32" + }, + "bookScrollId": { + "type": "string", + "description": "For Book Reader, represents the nearest passed anchor on the screen that can be used to resume scroll point\r\non next load", + "nullable": true + }, + "created": { + "type": "string", + "description": "When this was first created", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "description": "Last date this was updated", + "format": "date-time" + }, + "appUser": { + "$ref": "#/components/schemas/AppUser" + }, + "appUserId": { + "type": "integer", + "description": "User this progress belongs to", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "Represents the progress a single user has on a given Chapter." + }, + "AppUserRating": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "rating": { + "type": "integer", + "description": "A number between 0-5 that represents how good a series is.", + "format": "int32" + }, + "review": { + "type": "string", + "description": "A short summary the user can write when giving their review.", + "nullable": true + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "appUserId": { + "type": "integer", + "format": "int32" + }, + "appUser": { + "$ref": "#/components/schemas/AppUser" + } + }, + "additionalProperties": false + }, + "AppUserRole": { + "type": "object", + "properties": { + "userId": { + "type": "integer", + "format": "int32" + }, + "roleId": { + "type": "integer", + "format": "int32" + }, + "user": { + "$ref": "#/components/schemas/AppUser" + }, + "role": { + "$ref": "#/components/schemas/AppRole" + } + }, + "additionalProperties": false + }, + "BookChapterItem": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Name of the Chapter", + "nullable": true + }, + "part": { + "type": "string", + "description": "A part represents the id of the anchor so we can scroll to it. 01_values.xhtml#h_sVZPaxUSy/", + "nullable": true + }, + "page": { + "type": "integer", + "description": "Page Number to load for the chapter", + "format": "int32" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookChapterItem" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "BookInfoDto": { + "type": "object", + "properties": { + "bookTitle": { + "type": "string", + "nullable": true + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "format": "int32" + }, + "seriesFormat": { + "$ref": "#/components/schemas/MangaFormat" + }, + "seriesName": { + "type": "string", + "nullable": true + }, + "chapterNumber": { + "type": "string", + "nullable": true + }, + "volumeNumber": { + "type": "string", + "nullable": true + }, + "libraryId": { + "type": "integer", + "format": "int32" + }, + "pages": { + "type": "integer", + "format": "int32" + }, + "isSpecial": { + "type": "boolean" + }, + "chapterTitle": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "BookPageLayoutMode": { + "enum": [ + 0, + 1, + 2 + ], + "type": "integer", + "format": "int32" + }, + "BookmarkDto": { + "required": [ + "chapterId", + "page", + "seriesId", + "volumeId" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "BookmarkInfoDto": { + "type": "object", + "properties": { + "seriesName": { + "type": "string", + "nullable": true + }, + "seriesFormat": { + "$ref": "#/components/schemas/MangaFormat" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "libraryId": { + "type": "integer", + "format": "int32" + }, + "libraryType": { + "$ref": "#/components/schemas/LibraryType" + }, + "pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "BulkRemoveBookmarkForSeriesDto": { + "type": "object", + "properties": { + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "Chapter": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "range": { + "type": "string", + "description": "Range of numbers. Chapter 2-4 -> \"2-4\". Chapter 2 -> \"2\".", + "nullable": true + }, + "number": { + "type": "string", + "description": "Smallest number of the Range. Can be a partial like Chapter 4.5", + "nullable": true + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MangaFile" + }, + "description": "The files that represent this Chapter", + "nullable": true + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "coverImage": { + "type": "string", + "description": "Relative path to the (managed) image file representing the cover image", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean" + }, + "pages": { + "type": "integer", + "description": "Total number of pages in all MangaFiles", + "format": "int32" + }, + "isSpecial": { + "type": "boolean", + "description": "If this Chapter contains files that could only be identified as Series or has Special Identifier from filename" + }, + "title": { + "type": "string", + "description": "Used for books/specials to display custom title. For non-specials/books, will be set to API.Entities.Chapter.Range", + "nullable": true + }, + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "titleName": { + "type": "string", + "description": "Chapter title", + "nullable": true + }, + "releaseDate": { + "type": "string", + "description": "Date which chapter was released", + "format": "date-time" + }, + "summary": { + "type": "string", + "description": "Summary for the Chapter/Issue", + "nullable": true + }, + "language": { + "type": "string", + "description": "Language for the Chapter/Issue", + "nullable": true + }, + "totalCount": { + "type": "integer", + "description": "Total number of issues or volumes in the series", + "format": "int32" + }, + "count": { + "type": "integer", + "description": "Number of the Total Count (progress the Series is complete)", + "format": "int32" + }, + "wordCount": { + "type": "integer", + "description": "Total Word count of all chapters in this chapter.", + "format": "int64" + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + }, + "people": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Person" + }, + "description": "All people attached at a Chapter level. Usually Comics will have different people per issue.", + "nullable": true + }, + "genres": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Genre" + }, + "description": "Genres for the Chapter", + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + }, + "nullable": true + }, + "volume": { + "$ref": "#/components/schemas/Volume" + }, + "volumeId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "ChapterDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "range": { + "type": "string", + "description": "Range of chapters. Chapter 2-4 -> \"2-4\". Chapter 2 -> \"2\".", + "nullable": true + }, + "number": { + "type": "string", + "description": "Smallest number of the Range.", + "nullable": true + }, + "pages": { + "type": "integer", + "description": "Total number of pages in all MangaFiles", + "format": "int32" + }, + "isSpecial": { + "type": "boolean", + "description": "If this Chapter contains files that could only be identified as Series or has Special Identifier from filename" + }, + "title": { + "type": "string", + "description": "Used for books/specials to display custom title. For non-specials/books, will be set to API.DTOs.ChapterDto.Range", + "nullable": true + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MangaFileDto" + }, + "description": "The files that represent this Chapter", + "nullable": true + }, + "pagesRead": { + "type": "integer", + "description": "Calculated at API time. Number of pages read for this Chapter for logged in user.", + "format": "int32" + }, + "coverImageLocked": { + "type": "boolean", + "description": "If the Cover Image is locked for this entity" + }, + "volumeId": { + "type": "integer", + "description": "Volume Id this Chapter belongs to", + "format": "int32" + }, + "created": { + "type": "string", + "description": "When chapter was created", + "format": "date-time" + }, + "releaseDate": { + "type": "string", + "description": "When the chapter was released.", + "format": "date-time" + }, + "titleName": { + "type": "string", + "description": "Title of the Chapter/Issue", + "nullable": true + }, + "summary": { + "type": "string", + "description": "Summary of the Chapter", + "nullable": true + }, + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "wordCount": { + "type": "integer", + "description": "Total words in a Chapter (books only)", + "format": "int64" + }, + "volumeTitle": { + "type": "string", + "description": "Formatted Volume title ie) Volume 2.", + "nullable": true + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "A Chapter is the lowest grouping of a reading medium. A Chapter contains a set of MangaFiles which represents the underlying\r\nfile (abstracted from type)." + }, + "ChapterInfoDto": { + "type": "object", + "properties": { + "chapterNumber": { + "type": "string", + "description": "The Chapter Number", + "nullable": true + }, + "volumeNumber": { + "type": "string", + "description": "The Volume Number", + "nullable": true + }, + "volumeId": { + "type": "integer", + "description": "Volume entity Id", + "format": "int32" + }, + "seriesName": { + "type": "string", + "description": "Series Name", + "nullable": true + }, + "seriesFormat": { + "$ref": "#/components/schemas/MangaFormat" + }, + "seriesId": { + "type": "integer", + "description": "Series entity Id", + "format": "int32" + }, + "libraryId": { + "type": "integer", + "description": "Library entity Id", + "format": "int32" + }, + "libraryType": { + "$ref": "#/components/schemas/LibraryType" + }, + "chapterTitle": { + "type": "string", + "description": "Chapter's title if set via ComicInfo.xml (Title field)", + "nullable": true + }, + "pages": { + "type": "integer", + "description": "Total Number of pages in this Chapter", + "format": "int32" + }, + "fileName": { + "type": "string", + "description": "File name of the chapter", + "nullable": true + }, + "isSpecial": { + "type": "boolean", + "description": "If this is marked as a special in Kavita" + }, + "subtitle": { + "type": "string", + "description": "The subtitle to render on the reader", + "nullable": true + }, + "title": { + "type": "string", + "description": "Series Title", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Information about the Chapter for the Reader to render" + }, + "CollectionTag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Visible title of the Tag", + "nullable": true + }, + "coverImage": { + "type": "string", + "description": "Absolute path to the (managed) image file", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean", + "description": "Denotes if the CoverImage has been overridden by the user. If so, it will not be updated during normal scan operations." + }, + "summary": { + "type": "string", + "description": "A description of the tag", + "nullable": true + }, + "normalizedTitle": { + "type": "string", + "description": "A normalized string used to check if the tag already exists in the DB", + "nullable": true + }, + "promoted": { + "type": "boolean", + "description": "A promoted collection tag will allow all linked seriesMetadata's Series to show for all users." + }, + "seriesMetadatas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesMetadata" + }, + "nullable": true + }, + "rowVersion": { + "type": "integer", + "description": "Not Used due to not using concurrency update", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents a user entered field that is used as a tagging and grouping mechanism" + }, + "CollectionTagBulkAddDto": { + "type": "object", + "properties": { + "collectionTagId": { + "type": "integer", + "description": "Collection Tag Id", + "format": "int32" + }, + "collectionTagTitle": { + "type": "string", + "nullable": true + }, + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Series Ids to add onto Collection Tag", + "nullable": true + } + }, + "additionalProperties": false + }, + "CollectionTagDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "promoted": { + "type": "boolean" + }, + "coverImage": { + "type": "string", + "description": "The cover image string. This is used on Frontend to show or hide the Cover Image", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "ConfirmEmailDto": { + "required": [ + "email", + "password", + "token", + "username" + ], + "type": "object", + "properties": { + "email": { + "minLength": 1, + "type": "string" + }, + "token": { + "minLength": 1, + "type": "string" + }, + "password": { + "maxLength": 32, + "minLength": 6, + "type": "string" + }, + "username": { + "minLength": 1, + "type": "string" + } + }, + "additionalProperties": false + }, + "ConfirmEmailUpdateDto": { + "required": [ + "email", + "token" + ], + "type": "object", + "properties": { + "email": { + "minLength": 1, + "type": "string" + }, + "token": { + "minLength": 1, + "type": "string" + } + }, + "additionalProperties": false + }, + "ConfirmMigrationEmailDto": { + "type": "object", + "properties": { + "email": { + "type": "string", + "nullable": true + }, + "token": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "ConfirmPasswordResetDto": { + "required": [ + "email", + "password", + "token" + ], + "type": "object", + "properties": { + "email": { + "minLength": 1, + "type": "string" + }, + "token": { + "minLength": 1, + "type": "string" + }, + "password": { + "maxLength": 32, + "minLength": 6, + "type": "string" + } + }, + "additionalProperties": false + }, + "CreateDeviceDto": { + "required": [ + "emailAddress", + "name", + "platform" + ], + "type": "object", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/DevicePlatform" + }, + "emailAddress": { + "minLength": 1, + "type": "string" + } + }, + "additionalProperties": false + }, + "CreateLibraryDto": { + "required": [ + "folders", + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/LibraryType" + }, + "folders": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "CreateReadingListDto": { + "type": "object", + "properties": { + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "DeleteSeriesDto": { + "type": "object", + "properties": { + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "Device": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "ipAddress": { + "type": "string", + "description": "Last Seen IP Address of the device", + "nullable": true + }, + "name": { + "type": "string", + "description": "A name given to this device", + "nullable": true, + "example": "Pixel 3a, John's Kindle" + }, + "emailAddress": { + "type": "string", + "description": "An email address associated with the device (ie Kindle). Will be used with Send to functionality", + "nullable": true + }, + "platform": { + "$ref": "#/components/schemas/DevicePlatform" + }, + "appUserId": { + "type": "integer", + "format": "int32" + }, + "appUser": { + "$ref": "#/components/schemas/AppUser" + }, + "lastUsed": { + "type": "string", + "description": "Last time this device was used to send a file", + "format": "date-time" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "description": "A Device is an entity that can receive data from Kavita (kindle)" + }, + "DeviceDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The device Id", + "format": "int32" + }, + "name": { + "type": "string", + "description": "A name given to this device", + "nullable": true, + "example": "Pixel 3a, John's Kindle" + }, + "emailAddress": { + "type": "string", + "description": "An email address associated with the device (ie Kindle). Will be used with Send to functionality", + "nullable": true + }, + "platform": { + "$ref": "#/components/schemas/DevicePlatform" + }, + "lastUsed": { + "type": "string", + "description": "Last time this device was used to send a file", + "format": "date-time" + } + }, + "additionalProperties": false, + "description": "A Device is an entity that can receive data from Kavita (kindle)" + }, + "DevicePlatform": { + "enum": [ + 0, + 1, + 2, + 3 + ], + "type": "integer", + "format": "int32" + }, + "DirectoryDto": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the directory", + "nullable": true + }, + "fullPath": { + "type": "string", + "description": "Full Directory Path", + "nullable": true + } + }, + "additionalProperties": false + }, + "DownloadBookmarkDto": { + "required": [ + "bookmarks" + ], + "type": "object", + "properties": { + "bookmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BookmarkDto" + } + } + }, + "additionalProperties": false + }, + "EmailTestResultDto": { + "type": "object", + "properties": { + "successful": { + "type": "boolean" + }, + "errorMessage": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents if Test Email Service URL was successful or not and if any error occured" + }, + "FileFormatDto": { + "type": "object", + "properties": { + "extension": { + "type": "string", + "description": "The extension with the ., in lowercase", + "nullable": true + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + } + }, + "additionalProperties": false + }, + "FilterDto": { + "type": "object", + "properties": { + "formats": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MangaFormat" + }, + "description": "The type of Formats you want to be returned. An empty list will return all formats back", + "nullable": true + }, + "readStatus": { + "$ref": "#/components/schemas/ReadStatus" + }, + "libraries": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of library ids to restrict search to. Defaults to all libraries by passing empty list", + "nullable": true + }, + "genres": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Genre ids to restrict search to. Defaults to all genres by passing an empty list", + "nullable": true + }, + "writers": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Writers to restrict search to. Defaults to all Writers by passing an empty list", + "nullable": true + }, + "penciller": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Penciller ids to restrict search to. Defaults to all Pencillers by passing an empty list", + "nullable": true + }, + "inker": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Inker ids to restrict search to. Defaults to all Inkers by passing an empty list", + "nullable": true + }, + "colorist": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Colorist ids to restrict search to. Defaults to all Colorists by passing an empty list", + "nullable": true + }, + "letterer": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Letterer ids to restrict search to. Defaults to all Letterers by passing an empty list", + "nullable": true + }, + "coverArtist": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of CoverArtist ids to restrict search to. Defaults to all CoverArtists by passing an empty list", + "nullable": true + }, + "editor": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Editor ids to restrict search to. Defaults to all Editors by passing an empty list", + "nullable": true + }, + "publisher": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Publisher ids to restrict search to. Defaults to all Publishers by passing an empty list", + "nullable": true + }, + "character": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Character ids to restrict search to. Defaults to all Characters by passing an empty list", + "nullable": true + }, + "translators": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Translator ids to restrict search to. Defaults to all Translatorss by passing an empty list", + "nullable": true + }, + "collectionTags": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Collection Tag ids to restrict search to. Defaults to all Collection Tags by passing an empty list", + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Tag ids to restrict search to. Defaults to all Tags by passing an empty list", + "nullable": true + }, + "rating": { + "type": "integer", + "description": "Will return back everything with the rating and above\r\nAPI.Entities.AppUserRating.Rating", + "format": "int32" + }, + "sortOptions": { + "$ref": "#/components/schemas/SortOptions" + }, + "ageRating": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeRating" + }, + "description": "Age Ratings. Empty list will return everything back", + "nullable": true + }, + "languages": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Languages (ISO 639-1 code) to filter by. Empty list will return everything back", + "nullable": true + }, + "publicationStatus": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublicationStatus" + }, + "description": "Publication statuses to filter by. Empty list will return everything back", + "nullable": true + }, + "seriesNameQuery": { + "type": "string", + "description": "An optional name string to filter by. Empty string will ignore.", + "nullable": true + }, + "releaseYearRange": { + "$ref": "#/components/schemas/Int32Range" + } + }, + "additionalProperties": false + }, + "FolderPath": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "path": { + "type": "string", + "nullable": true + }, + "lastScanned": { + "type": "string", + "description": "Used when scanning to see if we can skip if nothing has changed", + "format": "date-time" + }, + "library": { + "$ref": "#/components/schemas/Library" + }, + "libraryId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "Genre": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "normalizedTitle": { + "type": "string", + "nullable": true + }, + "externalTag": { + "type": "boolean" + }, + "seriesMetadatas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesMetadata" + }, + "nullable": true + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Chapter" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "GenreTagDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "HourEstimateRangeDto": { + "type": "object", + "properties": { + "minHours": { + "type": "integer", + "description": "Min hours to read the selection", + "format": "int32" + }, + "maxHours": { + "type": "integer", + "description": "Max hours to read the selection", + "format": "int32" + }, + "avgHours": { + "type": "integer", + "description": "Estimated average hours to read the selection", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "A range of time to read a selection (series, chapter, etc)" + }, + "Int32Range": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "format": "int32" + }, + "max": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "Represents a range between two int/float/double" + }, + "InviteUserDto": { + "required": [ + "email" + ], + "type": "object", + "properties": { + "email": { + "minLength": 1, + "type": "string" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Roles to assign to user. If admin not present, Pleb will be applied.\r\nIf admin present, all libraries will be granted access and will ignore those from DTO.", + "nullable": true + }, + "libraries": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of libraries to grant access to", + "nullable": true + }, + "ageRestriction": { + "$ref": "#/components/schemas/AgeRestrictionDto" + } + }, + "additionalProperties": false + }, + "JobDto": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Job Id", + "nullable": true + }, + "title": { + "type": "string", + "description": "Human Readable title for the Job", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the job was created", + "format": "date-time", + "nullable": true + }, + "lastExecution": { + "type": "string", + "description": "Last time the job was run", + "format": "date-time", + "nullable": true + }, + "cron": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "JumpKeyDto": { + "type": "object", + "properties": { + "size": { + "type": "integer", + "description": "Number of items in this Key", + "format": "int32" + }, + "key": { + "type": "string", + "description": "Code to use in URL (url encoded)", + "nullable": true + }, + "title": { + "type": "string", + "description": "What is visible to user", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an individual button in a Jump Bar" + }, + "LanguageDto": { + "type": "object", + "properties": { + "isoCode": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "LayoutMode": { + "enum": [ + 1, + 2, + 3 + ], + "type": "integer", + "format": "int32" + }, + "Library": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "coverImage": { + "type": "string", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/LibraryType" + }, + "folderWatching": { + "type": "boolean", + "description": "If Folder Watching is enabled for this library" + }, + "includeInDashboard": { + "type": "boolean", + "description": "Include Library series on Dashboard Streams" + }, + "includeInRecommended": { + "type": "boolean", + "description": "Include Library series on Recommended Streams" + }, + "includeInSearch": { + "type": "boolean", + "description": "Include library series in Search" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "lastScanned": { + "type": "string", + "description": "Last time Library was scanned", + "format": "date-time" + }, + "folders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FolderPath" + }, + "nullable": true + }, + "appUsers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUser" + }, + "nullable": true + }, + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Series" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "LibraryDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "lastScanned": { + "type": "string", + "description": "Last time Library was scanned", + "format": "date-time" + }, + "type": { + "$ref": "#/components/schemas/LibraryType" + }, + "coverImage": { + "type": "string", + "description": "An optional Cover Image or null", + "nullable": true + }, + "folderWatching": { + "type": "boolean", + "description": "If Folder Watching is enabled for this library" + }, + "includeInDashboard": { + "type": "boolean", + "description": "Include Library series on Dashboard Streams" + }, + "includeInRecommended": { + "type": "boolean", + "description": "Include Library series on Recommended Streams" + }, + "includeInSearch": { + "type": "boolean", + "description": "Include library series in Search" + }, + "folders": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "LibraryType": { + "enum": [ + 0, + 1, + 2 + ], + "type": "integer", + "format": "int32" + }, + "LoginDto": { + "type": "object", + "properties": { + "username": { + "type": "string", + "nullable": true + }, + "password": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "MangaFile": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "filePath": { + "type": "string", + "description": "Absolute path to the archive file", + "nullable": true + }, + "pages": { + "type": "integer", + "description": "Number of pages for the given file", + "format": "int32" + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "description": "Last time underlying file was modified", + "format": "date-time" + }, + "lastFileAnalysis": { + "type": "string", + "description": "Last time file analysis ran on this file", + "format": "date-time" + }, + "chapter": { + "$ref": "#/components/schemas/Chapter" + }, + "chapterId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "Represents a wrapper to the underlying file. This provides information around file, like number of pages, format, etc." + }, + "MangaFileDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "filePath": { + "type": "string", + "nullable": true + }, + "pages": { + "type": "integer", + "format": "int32" + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + }, + "created": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false + }, + "MangaFormat": { + "enum": [ + 0, + 1, + 2, + 3, + 4 + ], + "type": "integer", + "description": "Represents the format of the file", + "format": "int32" + }, + "MarkMultipleSeriesAsReadDto": { + "type": "object", + "properties": { + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "MarkReadDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "MarkVolumeReadDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "MarkVolumesReadDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "volumeIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of Volumes to mark read", + "nullable": true + }, + "chapterIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of additional Chapters to mark as read", + "nullable": true + } + }, + "additionalProperties": false, + "description": "This is used for bulk updating a set of volume and or chapters in one go" + }, + "MemberDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "username": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "ageRestriction": { + "$ref": "#/components/schemas/AgeRestrictionDto" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastActive": { + "type": "string", + "format": "date-time" + }, + "libraries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + }, + "nullable": true + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a member of a Kavita server." + }, + "MigrateUserEmailDto": { + "type": "object", + "properties": { + "email": { + "type": "string", + "nullable": true + }, + "username": { + "type": "string", + "nullable": true + }, + "password": { + "type": "string", + "nullable": true + }, + "sendEmail": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "PageLayoutMode": { + "enum": [ + 0, + 1 + ], + "type": "integer", + "format": "int32" + }, + "PageSplitOption": { + "enum": [ + 0, + 1, + 2, + 3 + ], + "type": "integer", + "format": "int32" + }, + "Person": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "normalizedName": { + "type": "string", + "nullable": true + }, + "role": { + "$ref": "#/components/schemas/PersonRole" + }, + "seriesMetadatas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesMetadata" + }, + "nullable": true + }, + "chapterMetadatas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Chapter" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "PersonDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "role": { + "$ref": "#/components/schemas/PersonRole" + } + }, + "additionalProperties": false + }, + "PersonRole": { + "enum": [ + 1, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12 + ], + "type": "integer", + "format": "int32" + }, + "ProgressDto": { + "required": [ + "chapterId", + "pageNum", + "seriesId", + "volumeId" + ], + "type": "object", + "properties": { + "volumeId": { + "type": "integer", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "format": "int32" + }, + "pageNum": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "bookScrollId": { + "type": "string", + "description": "For Book reader, this can be an optional string of the id of a part marker, to help resume reading position\r\non pages that combine multiple \"chapters\".", + "nullable": true + } + }, + "additionalProperties": false + }, + "PublicationStatus": { + "enum": [ + 0, + 1, + 2, + 3, + 4 + ], + "type": "integer", + "format": "int32" + }, + "ReadStatus": { + "type": "object", + "properties": { + "notRead": { + "type": "boolean" + }, + "inProgress": { + "type": "boolean" + }, + "read": { + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Represents the Reading Status. This is a flag and allows multiple statues" + }, + "ReaderMode": { + "enum": [ + 0, + 1, + 2 + ], + "type": "integer", + "format": "int32" + }, + "ReadingDirection": { + "enum": [ + 0, + 1 + ], + "type": "integer", + "format": "int32" + }, + "ReadingList": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "normalizedTitle": { + "type": "string", + "description": "A normalized string used to check if the reading list already exists in the DB", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "promoted": { + "type": "boolean", + "description": "Reading lists that are promoted are only done by admins" + }, + "coverImage": { + "type": "string", + "description": "Absolute path to the (managed) image file", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean" + }, + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListItem" + }, + "nullable": true + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "appUserId": { + "type": "integer", + "format": "int32" + }, + "appUser": { + "$ref": "#/components/schemas/AppUser" + } + }, + "additionalProperties": false, + "description": "This is a collection of API.Entities.ReadingListItem which represent individual chapters and an order." + }, + "ReadingListDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "promoted": { + "type": "boolean", + "description": "Reading lists that are promoted are only done by admins" + }, + "coverImageLocked": { + "type": "boolean" + }, + "coverImage": { + "type": "string", + "description": "This is used to tell the UI if it should request a Cover Image or not. If null or empty, it has not been set.", + "nullable": true + } + }, + "additionalProperties": false + }, + "ReadingListItem": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "format": "int32" + }, + "order": { + "type": "integer", + "description": "Order of the chapter within a Reading List", + "format": "int32" + }, + "readingList": { + "$ref": "#/components/schemas/ReadingList" + }, + "readingListId": { + "type": "integer", + "format": "int32" + }, + "series": { + "$ref": "#/components/schemas/Series" + }, + "volume": { + "$ref": "#/components/schemas/Volume" + }, + "chapter": { + "$ref": "#/components/schemas/Chapter" + } + }, + "additionalProperties": false + }, + "ReadingListItemDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "order": { + "type": "integer", + "format": "int32" + }, + "chapterId": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "seriesName": { + "type": "string", + "nullable": true + }, + "seriesFormat": { + "$ref": "#/components/schemas/MangaFormat" + }, + "pagesRead": { + "type": "integer", + "format": "int32" + }, + "pagesTotal": { + "type": "integer", + "format": "int32" + }, + "chapterNumber": { + "type": "string", + "nullable": true + }, + "volumeNumber": { + "type": "string", + "nullable": true + }, + "volumeId": { + "type": "integer", + "format": "int32" + }, + "libraryId": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "releaseDate": { + "type": "string", + "description": "Release Date from Chapter", + "format": "date-time" + }, + "readingListId": { + "type": "integer", + "description": "Used internally only", + "format": "int32" + } + }, + "additionalProperties": false + }, + "RecentlyAddedItemDto": { + "type": "object", + "properties": { + "seriesName": { + "type": "string", + "nullable": true + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "libraryId": { + "type": "integer", + "format": "int32" + }, + "libraryType": { + "$ref": "#/components/schemas/LibraryType" + }, + "title": { + "type": "string", + "description": "This will automatically map to Volume X, Chapter Y, etc.", + "nullable": true + }, + "created": { + "type": "string", + "format": "date-time" + }, + "chapterId": { + "type": "integer", + "description": "Chapter Id if this is a chapter. Not guaranteed to be set.", + "format": "int32" + }, + "volumeId": { + "type": "integer", + "description": "Volume Id if this is a chapter. Not guaranteed to be set.", + "format": "int32" + }, + "id": { + "type": "integer", + "description": "This is used only on the UI. It is just index of being added.", + "format": "int32" + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + } + }, + "additionalProperties": false, + "description": "A mesh of data for Recently added volume/chapters" + }, + "RefreshSeriesDto": { + "type": "object", + "properties": { + "libraryId": { + "type": "integer", + "description": "Library Id series belongs to", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "description": "Series Id", + "format": "int32" + }, + "forceUpdate": { + "type": "boolean", + "description": "Should the task force opening/re-calculation." + } + }, + "additionalProperties": false, + "description": "Used for running some task against a Series." + }, + "RegisterDto": { + "required": [ + "password", + "username" + ], + "type": "object", + "properties": { + "username": { + "minLength": 1, + "type": "string" + }, + "email": { + "type": "string", + "description": "An email to register with. Optional. Provides Forgot Password functionality", + "nullable": true + }, + "password": { + "maxLength": 32, + "minLength": 6, + "type": "string" + } + }, + "additionalProperties": false + }, + "RelatedSeriesDto": { + "type": "object", + "properties": { + "sourceSeriesId": { + "type": "integer", + "description": "The parent relationship Series", + "format": "int32" + }, + "sequels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "prequels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "spinOffs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "adaptations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "sideStories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "characters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "contains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "others": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "alternativeSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "alternativeVersions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "doujinshis": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "parent": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + }, + "editions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesDto" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "RelationKind": { + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13 + ], + "type": "integer", + "description": "Represents a relationship between Series", + "format": "int32" + }, + "RemoveBookmarkForSeriesDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "ResetPasswordDto": { + "required": [ + "password", + "userName" + ], + "type": "object", + "properties": { + "userName": { + "minLength": 1, + "type": "string", + "description": "The Username of the User" + }, + "password": { + "maxLength": 32, + "minLength": 6, + "type": "string", + "description": "The new password" + }, + "oldPassword": { + "type": "string", + "description": "The old, existing password. If an admin is performing the change, this is not required. Otherwise, it is.", + "nullable": true + } + }, + "additionalProperties": false + }, + "ScalingOption": { + "enum": [ + 0, + 1, + 2, + 3 + ], + "type": "integer", + "format": "int32" + }, + "ScanFolderDto": { + "type": "object", + "properties": { + "apiKey": { + "type": "string", + "description": "Api key for a user with Admin permissions", + "nullable": true + }, + "folderPath": { + "type": "string", + "description": "Folder Path to Scan", + "nullable": true + } + }, + "additionalProperties": false, + "description": "DTO for requesting a folder to be scanned" + }, + "SearchResultDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "originalName": { + "type": "string", + "nullable": true + }, + "sortName": { + "type": "string", + "nullable": true + }, + "localizedName": { + "type": "string", + "nullable": true + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + }, + "libraryName": { + "type": "string", + "nullable": true + }, + "libraryId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "SearchResultGroupDto": { + "type": "object", + "properties": { + "libraries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + }, + "nullable": true + }, + "series": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchResultDto" + }, + "nullable": true + }, + "collections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + }, + "nullable": true + }, + "readingLists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadingListDto" + }, + "nullable": true + }, + "persons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "genres": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenreTagDto" + }, + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + }, + "nullable": true + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MangaFileDto" + }, + "nullable": true + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChapterDto" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents all Search results for a query" + }, + "SendToDeviceDto": { + "type": "object", + "properties": { + "deviceId": { + "type": "integer", + "format": "int32" + }, + "chapterIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "Series": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "description": "The UI visible Name of the Series. This may or may not be the same as the OriginalName", + "nullable": true + }, + "normalizedName": { + "type": "string", + "description": "Used internally for name matching. M:API.Services.Tasks.Scanner.Parser.Parser.Normalize(System.String)", + "nullable": true + }, + "normalizedLocalizedName": { + "type": "string", + "description": "Used internally for localized name matching. M:API.Services.Tasks.Scanner.Parser.Parser.Normalize(System.String)", + "nullable": true + }, + "sortName": { + "type": "string", + "description": "The name used to sort the Series. By default, will be the same as Name.", + "nullable": true + }, + "localizedName": { + "type": "string", + "description": "Name in original language (Japanese for Manga). By default, will be same as Name.", + "nullable": true + }, + "originalName": { + "type": "string", + "description": "Original Name on disk. Not exposed to UI.", + "nullable": true + }, + "created": { + "type": "string", + "description": "Time of creation", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "description": "Whenever a modification occurs. Ie) New volumes, removed volumes, title update, etc", + "format": "date-time" + }, + "coverImage": { + "type": "string", + "description": "Absolute path to the (managed) image file", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean", + "description": "Denotes if the CoverImage has been overridden by the user. If so, it will not be updated during normal scan operations." + }, + "pages": { + "type": "integer", + "description": "Sum of all Volume page counts", + "format": "int32" + }, + "folderPath": { + "type": "string", + "description": "Highest path (that is under library root) that contains the series.", + "nullable": true + }, + "lastFolderScanned": { + "type": "string", + "description": "Last time the folder was scanned", + "format": "date-time" + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + }, + "nameLocked": { + "type": "boolean" + }, + "sortNameLocked": { + "type": "boolean" + }, + "localizedNameLocked": { + "type": "boolean" + }, + "lastChapterAdded": { + "type": "string", + "description": "When a Chapter was last added onto the Series", + "format": "date-time" + }, + "wordCount": { + "type": "integer", + "description": "Total Word count of all chapters in this chapter.", + "format": "int64" + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + }, + "metadata": { + "$ref": "#/components/schemas/SeriesMetadata" + }, + "ratings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserRating" + }, + "nullable": true + }, + "progress": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppUserProgress" + }, + "nullable": true + }, + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesRelation" + }, + "description": "Relations to other Series, like Sequels, Prequels, etc", + "nullable": true + }, + "relationOf": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesRelation" + }, + "nullable": true + }, + "volumes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Volume" + }, + "nullable": true + }, + "library": { + "$ref": "#/components/schemas/Library" + }, + "libraryId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "SeriesByIdsDto": { + "type": "object", + "properties": { + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "SeriesDetailDto": { + "type": "object", + "properties": { + "specials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChapterDto" + }, + "description": "Specials for the Series. These will have their title and range cleaned to remove the special marker and prepare", + "nullable": true + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChapterDto" + }, + "description": "All Chapters, excluding Specials and single chapters (0 chapter) for a volume", + "nullable": true + }, + "volumes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VolumeDto" + }, + "description": "Just the Volumes for the Series (Excludes Volume 0)", + "nullable": true + }, + "storylineChapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChapterDto" + }, + "description": "These are chapters that are in Volume 0 and should be read AFTER the volumes", + "nullable": true + }, + "unreadCount": { + "type": "integer", + "description": "How many chapters are unread", + "format": "int32" + }, + "totalCount": { + "type": "integer", + "description": "How many chapters are there", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "This is a special DTO for a UI page in Kavita. This performs sorting and grouping and returns exactly what UI requires for layout.\r\nThis is subject to change, do not rely on this Data model." + }, + "SeriesDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "originalName": { + "type": "string", + "nullable": true + }, + "localizedName": { + "type": "string", + "nullable": true + }, + "sortName": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "pages": { + "type": "integer", + "format": "int32" + }, + "coverImageLocked": { + "type": "boolean" + }, + "pagesRead": { + "type": "integer", + "description": "Sum of pages read from linked Volumes. Calculated at API-time.", + "format": "int32" + }, + "latestReadDate": { + "type": "string", + "description": "DateTime representing last time the series was Read. Calculated at API-time.", + "format": "date-time" + }, + "lastChapterAdded": { + "type": "string", + "description": "DateTime representing last time a chapter was added to the Series", + "format": "date-time" + }, + "userRating": { + "type": "integer", + "description": "Rating from logged in user. Calculated at API-time.", + "format": "int32" + }, + "userReview": { + "type": "string", + "description": "Review from logged in user. Calculated at API-time.", + "nullable": true + }, + "format": { + "$ref": "#/components/schemas/MangaFormat" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "nameLocked": { + "type": "boolean" + }, + "sortNameLocked": { + "type": "boolean" + }, + "localizedNameLocked": { + "type": "boolean" + }, + "wordCount": { + "type": "integer", + "description": "Total number of words for the series. Only applies to epubs.", + "format": "int64" + }, + "libraryId": { + "type": "integer", + "format": "int32" + }, + "libraryName": { + "type": "string", + "nullable": true + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + }, + "folderPath": { + "type": "string", + "description": "The highest level folder for this Series", + "nullable": true + }, + "lastFolderScanned": { + "type": "string", + "description": "The last time the folder for this series was scanned", + "format": "date-time" + } + }, + "additionalProperties": false + }, + "SeriesMetadata": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "summary": { + "type": "string", + "nullable": true + }, + "collectionTags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTag" + }, + "nullable": true + }, + "genres": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Genre" + }, + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + }, + "nullable": true + }, + "people": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Person" + }, + "description": "All people attached at a Series level.", + "nullable": true + }, + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "releaseYear": { + "type": "integer", + "description": "Earliest Year from all chapters", + "format": "int32" + }, + "language": { + "type": "string", + "description": "Language of the content (BCP-47 code)", + "nullable": true + }, + "totalCount": { + "type": "integer", + "description": "Total number of issues/volumes in the series", + "format": "int32" + }, + "maxCount": { + "type": "integer", + "description": "Max number of issues/volumes in the series (Max of Volume/Issue field in ComicInfo)", + "format": "int32" + }, + "publicationStatus": { + "$ref": "#/components/schemas/PublicationStatus" + }, + "languageLocked": { + "type": "boolean" + }, + "summaryLocked": { + "type": "boolean" + }, + "ageRatingLocked": { + "type": "boolean", + "description": "Locked by user so metadata updates from scan loop will not override AgeRating" + }, + "publicationStatusLocked": { + "type": "boolean", + "description": "Locked by user so metadata updates from scan loop will not override PublicationStatus" + }, + "genresLocked": { + "type": "boolean" + }, + "tagsLocked": { + "type": "boolean" + }, + "writerLocked": { + "type": "boolean" + }, + "characterLocked": { + "type": "boolean" + }, + "coloristLocked": { + "type": "boolean" + }, + "editorLocked": { + "type": "boolean" + }, + "inkerLocked": { + "type": "boolean" + }, + "lettererLocked": { + "type": "boolean" + }, + "pencillerLocked": { + "type": "boolean" + }, + "publisherLocked": { + "type": "boolean" + }, + "translatorLocked": { + "type": "boolean" + }, + "coverArtistLocked": { + "type": "boolean" + }, + "releaseYearLocked": { + "type": "boolean" + }, + "series": { + "$ref": "#/components/schemas/Series" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "rowVersion": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "SeriesMetadataDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "summary": { + "type": "string", + "nullable": true + }, + "collectionTags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + }, + "description": "Collections the Series belongs to", + "nullable": true + }, + "genres": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenreTagDto" + }, + "description": "Genres for the Series", + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + }, + "description": "Collection of all Tags from underlying chapters for a Series", + "nullable": true + }, + "writers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "coverArtists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "publishers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "characters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "pencillers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "inkers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "colorists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "letterers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "editors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "translators": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonDto" + }, + "nullable": true + }, + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "releaseYear": { + "type": "integer", + "description": "Earliest Year from all chapters", + "format": "int32" + }, + "language": { + "type": "string", + "description": "Language of the content (BCP-47 code)", + "nullable": true + }, + "maxCount": { + "type": "integer", + "description": "Max number of issues/volumes in the series (Max of Volume/Issue field in ComicInfo)", + "format": "int32" + }, + "totalCount": { + "type": "integer", + "description": "Total number of issues/volumes for the series", + "format": "int32" + }, + "publicationStatus": { + "$ref": "#/components/schemas/PublicationStatus" + }, + "languageLocked": { + "type": "boolean" + }, + "summaryLocked": { + "type": "boolean" + }, + "ageRatingLocked": { + "type": "boolean", + "description": "Locked by user so metadata updates from scan loop will not override AgeRating" + }, + "publicationStatusLocked": { + "type": "boolean", + "description": "Locked by user so metadata updates from scan loop will not override PublicationStatus" + }, + "genresLocked": { + "type": "boolean" + }, + "tagsLocked": { + "type": "boolean" + }, + "writersLocked": { + "type": "boolean" + }, + "charactersLocked": { + "type": "boolean" + }, + "coloristsLocked": { + "type": "boolean" + }, + "editorsLocked": { + "type": "boolean" + }, + "inkersLocked": { + "type": "boolean" + }, + "letterersLocked": { + "type": "boolean" + }, + "pencillersLocked": { + "type": "boolean" + }, + "publishersLocked": { + "type": "boolean" + }, + "translatorsLocked": { + "type": "boolean" + }, + "coverArtistsLocked": { + "type": "boolean" + }, + "releaseYearLocked": { + "type": "boolean" + }, + "seriesId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "SeriesRelation": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "relationKind": { + "$ref": "#/components/schemas/RelationKind" + }, + "targetSeries": { + "$ref": "#/components/schemas/Series" + }, + "targetSeriesId": { + "type": "integer", + "description": "A is Sequel to B. In this example, TargetSeries is A. B will hold the foreign key.", + "format": "int32" + }, + "series": { + "$ref": "#/components/schemas/Series" + }, + "seriesId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "A relation flows between one series and another.\r\nSeries ---kind---> target" + }, + "ServerInfoDto": { + "type": "object", + "properties": { + "installId": { + "type": "string", + "description": "Unique Id that represents a unique install", + "nullable": true + }, + "os": { + "type": "string", + "nullable": true + }, + "isDocker": { + "type": "boolean", + "description": "If the Kavita install is using Docker" + }, + "dotnetVersion": { + "type": "string", + "description": "Version of .NET instance is running", + "nullable": true + }, + "kavitaVersion": { + "type": "string", + "description": "Version of Kavita", + "nullable": true + }, + "numOfCores": { + "type": "integer", + "description": "Number of Cores on the instance", + "format": "int32" + }, + "numberOfLibraries": { + "type": "integer", + "description": "The number of libraries on the instance", + "format": "int32" + }, + "hasBookmarks": { + "type": "boolean", + "description": "Does any user have bookmarks" + }, + "activeSiteTheme": { + "type": "string", + "description": "The site theme the install is using", + "nullable": true + }, + "mangaReaderMode": { + "$ref": "#/components/schemas/ReaderMode" + }, + "numberOfUsers": { + "type": "integer", + "description": "Number of users on the install", + "format": "int32" + }, + "numberOfCollections": { + "type": "integer", + "description": "Number of collections on the install", + "format": "int32" + }, + "numberOfReadingLists": { + "type": "integer", + "description": "Number of reading lists on the install (Sum of all users)", + "format": "int32" + }, + "opdsEnabled": { + "type": "boolean", + "description": "Is OPDS enabled" + }, + "totalFiles": { + "type": "integer", + "description": "Total number of files in the instance", + "format": "int32" + }, + "totalGenres": { + "type": "integer", + "description": "Total number of Genres in the instance", + "format": "int32" + }, + "totalPeople": { + "type": "integer", + "description": "Total number of People in the instance", + "format": "int32" + }, + "storeBookmarksAsWebP": { + "type": "boolean", + "description": "Is this instance storing bookmarks as WebP" + }, + "usersOnCardLayout": { + "type": "integer", + "description": "Number of users on this instance using Card Layout", + "format": "int32" + }, + "usersOnListLayout": { + "type": "integer", + "description": "Number of users on this instance using List Layout", + "format": "int32" + }, + "maxSeriesInALibrary": { + "type": "integer", + "description": "Max number of Series for any library on the instance", + "format": "int32" + }, + "maxVolumesInASeries": { + "type": "integer", + "description": "Max number of Volumes for any library on the instance", + "format": "int32" + }, + "maxChaptersInASeries": { + "type": "integer", + "description": "Max number of Chapters for any library on the instance", + "format": "int32" + }, + "usingSeriesRelationships": { + "type": "boolean", + "description": "Does this instance have relationships setup between series" + }, + "mangaReaderBackgroundColors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of background colors set on the instance", + "nullable": true + }, + "mangaReaderPageSplittingModes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PageSplitOption" + }, + "description": "A list of Page Split defaults being used on the instance", + "nullable": true + }, + "mangaReaderLayoutModes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LayoutMode" + }, + "description": "A list of Layout Mode defaults being used on the instance", + "nullable": true + }, + "fileFormats": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FileFormatDto" + }, + "description": "A list of file formats existing in the instance", + "nullable": true + }, + "usingRestrictedProfiles": { + "type": "boolean", + "description": "If there is at least one user that is using an age restricted profile on the instance" + } + }, + "additionalProperties": false, + "description": "Represents information about a Kavita Installation" + }, + "ServerSettingDto": { + "type": "object", + "properties": { + "cacheDirectory": { + "type": "string", + "nullable": true + }, + "taskScan": { + "type": "string", + "nullable": true + }, + "loggingLevel": { + "type": "string", + "description": "Logging level for server. Managed in appsettings.json.", + "nullable": true + }, + "taskBackup": { + "type": "string", + "nullable": true + }, + "port": { + "type": "integer", + "description": "Port the server listens on. Managed in appsettings.json.", + "format": "int32" + }, + "allowStatCollection": { + "type": "boolean", + "description": "Allows anonymous information to be collected and sent to KavitaStats" + }, + "enableOpds": { + "type": "boolean", + "description": "Enables OPDS connections to be made to the server." + }, + "baseUrl": { + "type": "string", + "description": "Base Url for the kavita. Requires restart to take effect.", + "nullable": true + }, + "bookmarksDirectory": { + "type": "string", + "description": "Where Bookmarks are stored.", + "nullable": true + }, + "emailServiceUrl": { + "type": "string", + "description": "Email service to use for the invite user flow, forgot password, etc.", + "nullable": true + }, + "installVersion": { + "type": "string", + "nullable": true + }, + "installId": { + "type": "string", + "description": "Represents a unique Id to this Kavita installation. Only used in Stats to identify unique installs.", + "nullable": true + }, + "convertBookmarkToWebP": { + "type": "boolean", + "description": "If the server should save bookmarks as WebP encoding" + }, + "enableSwaggerUi": { + "type": "boolean", + "description": "If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT.", + "deprecated": true + }, + "totalBackups": { + "type": "integer", + "description": "The amount of Backups before cleanup", + "format": "int32" + }, + "enableFolderWatching": { + "type": "boolean", + "description": "If Kavita should watch the library folders and process changes" + }, + "totalLogs": { + "type": "integer", + "description": "Total number of days worth of logs to keep at a given time.", + "format": "int32" + }, + "convertCoverToWebP": { + "type": "boolean", + "description": "If the server should save covers as WebP encoding" + } + }, + "additionalProperties": false + }, + "SiteTheme": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "description": "Name of the Theme", + "nullable": true + }, + "normalizedName": { + "type": "string", + "description": "Normalized name for lookups", + "nullable": true + }, + "fileName": { + "type": "string", + "description": "File path to the content. Stored under API.Services.DirectoryService.SiteThemeDirectory.\r\nMust be a .css file", + "nullable": true + }, + "isDefault": { + "type": "boolean", + "description": "Only one theme can have this. Will auto-set this as default for new user accounts" + }, + "provider": { + "$ref": "#/components/schemas/ThemeProvider" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "description": "Represents a set of css overrides the user can upload to Kavita and will load into webui" + }, + "SiteThemeDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "description": "Name of the Theme", + "nullable": true + }, + "fileName": { + "type": "string", + "description": "File path to the content. Stored under API.Services.DirectoryService.SiteThemeDirectory.\r\nMust be a .css file", + "nullable": true + }, + "isDefault": { + "type": "boolean", + "description": "Only one theme can have this. Will auto-set this as default for new user accounts" + }, + "provider": { + "$ref": "#/components/schemas/ThemeProvider" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "selector": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents a set of css overrides the user can upload to Kavita and will load into webui" + }, + "SortField": { + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6 + ], + "type": "integer", + "format": "int32" + }, + "SortOptions": { + "type": "object", + "properties": { + "sortField": { + "$ref": "#/components/schemas/SortField" + }, + "isAscending": { + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Sorting Options for a query" + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "normalizedTitle": { + "type": "string", + "nullable": true + }, + "externalTag": { + "type": "boolean" + }, + "seriesMetadatas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeriesMetadata" + }, + "nullable": true + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Chapter" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "TagDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "TestEmailDto": { + "type": "object", + "properties": { + "url": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "ThemeProvider": { + "enum": [ + 1, + 2 + ], + "type": "integer", + "format": "int32" + }, + "TokenRequestDto": { + "type": "object", + "properties": { + "token": { + "type": "string", + "nullable": true + }, + "refreshToken": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateAgeRestrictionDto": { + "required": [ + "ageRating", + "includeUnknowns" + ], + "type": "object", + "properties": { + "ageRating": { + "$ref": "#/components/schemas/AgeRating" + }, + "includeUnknowns": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "UpdateDefaultThemeDto": { + "type": "object", + "properties": { + "themeId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "UpdateDeviceDto": { + "required": [ + "emailAddress", + "id", + "name", + "platform" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "platform": { + "$ref": "#/components/schemas/DevicePlatform" + }, + "emailAddress": { + "minLength": 1, + "type": "string" + } + }, + "additionalProperties": false + }, + "UpdateEmailDto": { + "type": "object", + "properties": { + "email": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateLibraryDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/LibraryType" + }, + "folders": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "folderWatching": { + "type": "boolean" + }, + "includeInDashboard": { + "type": "boolean" + }, + "includeInRecommended": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "UpdateLibraryForUserDto": { + "type": "object", + "properties": { + "username": { + "type": "string", + "nullable": true + }, + "selectedLibraries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LibraryDto" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateNotificationDto": { + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current installed Version", + "nullable": true + }, + "updateVersion": { + "type": "string", + "description": "Semver of the release version\r\n0.4.3", + "nullable": true + }, + "updateBody": { + "type": "string", + "description": "Release body in HTML", + "nullable": true + }, + "updateTitle": { + "type": "string", + "description": "Title of the release", + "nullable": true + }, + "updateUrl": { + "type": "string", + "description": "Github Url", + "nullable": true + }, + "isDocker": { + "type": "boolean", + "description": "If this install is within Docker" + }, + "isPrerelease": { + "type": "boolean", + "description": "Is this a pre-release" + }, + "publishDate": { + "type": "string", + "description": "Date of the publish", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Update Notification denoting a new release available for user to update to" + }, + "UpdateReadingListByChapterDto": { + "type": "object", + "properties": { + "chapterId": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "readingListId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "UpdateReadingListByMultipleDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "readingListId": { + "type": "integer", + "format": "int32" + }, + "volumeIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "chapterIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateReadingListByMultipleSeriesDto": { + "type": "object", + "properties": { + "readingListId": { + "type": "integer", + "format": "int32" + }, + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateReadingListBySeriesDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "readingListId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "UpdateReadingListByVolumeDto": { + "type": "object", + "properties": { + "volumeId": { + "type": "integer", + "format": "int32" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "readingListId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "UpdateReadingListDto": { + "required": [ + "readingListId" + ], + "type": "object", + "properties": { + "readingListId": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "promoted": { + "type": "boolean" + }, + "coverImageLocked": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "UpdateReadingListPosition": { + "required": [ + "readingListId", + "readingListItemId", + "toPosition" + ], + "type": "object", + "properties": { + "readingListId": { + "type": "integer", + "format": "int32" + }, + "readingListItemId": { + "type": "integer", + "format": "int32" + }, + "fromPosition": { + "type": "integer", + "format": "int32" + }, + "toPosition": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "DTO for moving a reading list item to another position within the same list" + }, + "UpdateRelatedSeriesDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "adaptations": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "characters": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "contains": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "others": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "prequels": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "sequels": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "sideStories": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "spinOffs": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "alternativeSettings": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "alternativeVersions": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "doujinshis": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + }, + "editions": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateSeriesDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "localizedName": { + "type": "string", + "nullable": true + }, + "sortName": { + "type": "string", + "nullable": true + }, + "coverImageLocked": { + "type": "boolean" + }, + "nameLocked": { + "type": "boolean" + }, + "sortNameLocked": { + "type": "boolean" + }, + "localizedNameLocked": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "UpdateSeriesForTagDto": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/CollectionTagDto" + }, + "seriesIdsToRemove": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateSeriesMetadataDto": { + "type": "object", + "properties": { + "seriesMetadata": { + "$ref": "#/components/schemas/SeriesMetadataDto" + }, + "collectionTags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionTagDto" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateSeriesRatingDto": { + "type": "object", + "properties": { + "seriesId": { + "type": "integer", + "format": "int32" + }, + "userRating": { + "type": "integer", + "format": "int32" + }, + "userReview": { + "maxLength": 1000, + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "UpdateUserDto": { + "type": "object", + "properties": { + "userId": { + "type": "integer", + "format": "int32" + }, + "username": { + "type": "string", + "nullable": true + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "libraries": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A list of libraries to grant access to", + "nullable": true + }, + "ageRestriction": { + "$ref": "#/components/schemas/AgeRestrictionDto" + } + }, + "additionalProperties": false + }, + "UpdateWantToReadDto": { + "type": "object", + "properties": { + "seriesIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "List of Series Ids that will be Added/Removed", + "nullable": true + } + }, + "additionalProperties": false, + "description": "A list of Series to pass when working with Want To Read APIs" + }, + "UploadFileDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Id of the Entity", + "format": "int32" + }, + "url": { + "type": "string", + "description": "Base Url encoding of the file to upload from (can be null)", + "nullable": true + } + }, + "additionalProperties": false + }, + "UploadUrlDto": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "External url", + "nullable": true + } + }, + "additionalProperties": false + }, + "UserDto": { + "type": "object", + "properties": { + "username": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "token": { + "type": "string", + "nullable": true + }, + "refreshToken": { + "type": "string", + "nullable": true + }, + "apiKey": { + "type": "string", + "nullable": true + }, + "preferences": { + "$ref": "#/components/schemas/UserPreferencesDto" + }, + "ageRestriction": { + "$ref": "#/components/schemas/AgeRestrictionDto" + } + }, + "additionalProperties": false + }, + "UserPreferencesDto": { + "required": [ + "autoCloseMenu", + "backgroundColor", + "blurUnreadSummaries", + "bookReaderFontFamily", + "bookReaderFontSize", + "bookReaderImmersiveMode", + "bookReaderLayoutMode", + "bookReaderLineSpacing", + "bookReaderMargin", + "bookReaderReadingDirection", + "bookReaderTapToPaginate", + "bookReaderThemeName", + "globalPageLayoutMode", + "layoutMode", + "noTransitions", + "pageSplitOption", + "promptForDownloadSize", + "readerMode", + "readingDirection", + "scalingOption", + "showScreenHints" + ], + "type": "object", + "properties": { + "readingDirection": { + "$ref": "#/components/schemas/ReadingDirection" + }, + "scalingOption": { + "$ref": "#/components/schemas/ScalingOption" + }, + "pageSplitOption": { + "$ref": "#/components/schemas/PageSplitOption" + }, + "readerMode": { + "$ref": "#/components/schemas/ReaderMode" + }, + "layoutMode": { + "$ref": "#/components/schemas/LayoutMode" + }, + "backgroundColor": { + "minLength": 1, + "type": "string", + "description": "Manga Reader Option: Background color of the reader" + }, + "autoCloseMenu": { + "type": "boolean", + "description": "Manga Reader Option: Allow the menu to close after 6 seconds without interaction" + }, + "showScreenHints": { + "type": "boolean", + "description": "Manga Reader Option: Show screen hints to the user on some actions, ie) pagination direction change" + }, + "bookReaderMargin": { + "type": "integer", + "description": "Book Reader Option: Override extra Margin", + "format": "int32" + }, + "bookReaderLineSpacing": { + "type": "integer", + "description": "Book Reader Option: Override line-height", + "format": "int32" + }, + "bookReaderFontSize": { + "type": "integer", + "description": "Book Reader Option: Override font size", + "format": "int32" + }, + "bookReaderFontFamily": { + "minLength": 1, + "type": "string", + "description": "Book Reader Option: Maps to the default Kavita font-family (inherit) or an override" + }, + "bookReaderTapToPaginate": { + "type": "boolean", + "description": "Book Reader Option: Allows tapping on side of screens to paginate" + }, + "bookReaderReadingDirection": { + "$ref": "#/components/schemas/ReadingDirection" + }, + "theme": { + "$ref": "#/components/schemas/SiteTheme" + }, + "bookReaderThemeName": { + "minLength": 1, + "type": "string" + }, + "bookReaderLayoutMode": { + "$ref": "#/components/schemas/BookPageLayoutMode" + }, + "bookReaderImmersiveMode": { + "type": "boolean", + "description": "Book Reader Option: A flag that hides the menu-ing system behind a click on the screen. This should be used with tap to paginate, but the app doesn't enforce this." + }, + "globalPageLayoutMode": { + "$ref": "#/components/schemas/PageLayoutMode" + }, + "blurUnreadSummaries": { + "type": "boolean", + "description": "UI Site Global Setting: If unread summaries should be blurred until expanded or unless user has read it already" + }, + "promptForDownloadSize": { + "type": "boolean", + "description": "UI Site Global Setting: Should Kavita prompt user to confirm downloads that are greater than 100 MB." + }, + "noTransitions": { + "type": "boolean", + "description": "UI Site Global Setting: Should Kavita disable CSS transitions" + } + }, + "additionalProperties": false + }, + "Volume": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "description": "A String representation of the volume number. Allows for floats.", + "nullable": true + }, + "number": { + "type": "integer", + "description": "The minimum number in the Name field in Int form", + "format": "int32" + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Chapter" + }, + "nullable": true + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "coverImage": { + "type": "string", + "description": "Absolute path to the (managed) image file", + "nullable": true + }, + "pages": { + "type": "integer", + "description": "Total pages of all chapters in this volume", + "format": "int32" + }, + "wordCount": { + "type": "integer", + "description": "Total Word count of all chapters in this volume.", + "format": "int64" + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + }, + "series": { + "$ref": "#/components/schemas/Series" + }, + "seriesId": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "VolumeDto": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "number": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "pages": { + "type": "integer", + "format": "int32" + }, + "pagesRead": { + "type": "integer", + "format": "int32" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "seriesId": { + "type": "integer", + "format": "int32" + }, + "chapters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChapterDto" + }, + "nullable": true + }, + "minHoursToRead": { + "type": "integer", + "format": "int32" + }, + "maxHoursToRead": { + "type": "integer", + "format": "int32" + }, + "avgHoursToRead": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "securitySchemes": { + "Bearer": { + "type": "apiKey", + "description": "Please insert JWT with Bearer into field", + "name": "Authorization", + "in": "header" + } + } + }, + "security": [ + { + "Bearer": [ ] + } + ], + "tags": [ + { + "name": "Account", + "description": "All Account matters" + }, + { + "name": "Collection", + "description": "APIs for Collections" + }, + { + "name": "Device", + "description": "Responsible interacting and creating Devices" + }, + { + "name": "Download", + "description": "All APIs related to downloading entities from the system. Requires Download Role or Admin Role." + }, + { + "name": "Image", + "description": "Responsible for servicing up images stored in Kavita for entities" + }, + { + "name": "Reader", + "description": "For all things regarding reading, mainly focusing on non-Book related entities" + }, + { + "name": "Search", + "description": "Responsible for the Search interface from the UI" + }, + { + "name": "Tachiyomi", + "description": "All APIs are for Tachiyomi extension and app. They have hacks for our implementation and should not be used for any\r\nother purposes." + }, + { + "name": "Upload", + "description": "" + }, + { + "name": "WantToRead", + "description": "Responsible for all things Want To Read" + } + ] +} \ No newline at end of file