Paging params in API docs

(cherry picked from commit bfaa7291e14a8d3847ef2154a52c363944560803)

Closes #2975
Closes #2991
This commit is contained in:
Mark McDowall
2023-10-09 20:37:31 -07:00
committed by Bogdan
parent 9d27c172ac
commit 9e3dfc510d
13 changed files with 56 additions and 125 deletions
@@ -22,9 +22,10 @@ namespace Readarr.Api.V1.Blocklist
}
[HttpGet]
public PagingResource<BlocklistResource> GetBlocklist()
[Produces("application/json")]
public PagingResource<BlocklistResource> GetBlocklist([FromQuery] PagingRequestResource paging)
{
var pagingResource = Request.ReadPagingResourceFromRequest<BlocklistResource>();
var pagingResource = new PagingResource<BlocklistResource>(paging);
var pagingSpec = pagingResource.MapToPagingSpec<BlocklistResource, NzbDrone.Core.Blocklisting.Blocklist>("date", SortDirection.Descending);
return pagingSpec.ApplyToPage(_blocklistService.Paged, model => BlocklistResourceMapper.MapToResource(model, _formatCalculator));
@@ -2,6 +2,7 @@ using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using NzbDrone.Common.Extensions;
using NzbDrone.Core.Books;
using NzbDrone.Core.CustomFormats;
using NzbDrone.Core.Datastore;
@@ -60,30 +61,25 @@ namespace Readarr.Api.V1.History
}
[HttpGet]
public PagingResource<HistoryResource> GetHistory(bool includeAuthor = false, bool includeBook = false)
[Produces("application/json")]
public PagingResource<HistoryResource> GetHistory([FromQuery] PagingRequestResource paging, bool includeAuthor, bool includeBook, [FromQuery(Name = "eventType")] int[] eventTypes, int? bookId, string downloadId)
{
var pagingResource = Request.ReadPagingResourceFromRequest<HistoryResource>();
var pagingResource = new PagingResource<HistoryResource>(paging);
var pagingSpec = pagingResource.MapToPagingSpec<HistoryResource, EntityHistory>("date", SortDirection.Descending);
var eventTypeFilter = pagingResource.Filters.FirstOrDefault(f => f.Key == "eventType");
var bookIdFilter = pagingResource.Filters.FirstOrDefault(f => f.Key == "bookId");
var downloadIdFilter = pagingResource.Filters.FirstOrDefault(f => f.Key == "downloadId");
if (eventTypeFilter != null)
if (eventTypes != null && eventTypes.Any())
{
var filterValue = (EntityHistoryEventType)Convert.ToInt32(eventTypeFilter.Value);
pagingSpec.FilterExpressions.Add(v => v.EventType == filterValue);
var filterValues = eventTypes.Cast<EntityHistoryEventType>().ToArray();
pagingSpec.FilterExpressions.Add(v => filterValues.Contains(v.EventType));
}
if (bookIdFilter != null)
if (bookId.HasValue)
{
var bookId = Convert.ToInt32(bookIdFilter.Value);
pagingSpec.FilterExpressions.Add(h => h.BookId == bookId);
}
if (downloadIdFilter != null)
if (downloadId.IsNotNullOrWhiteSpace())
{
var downloadId = downloadIdFilter.Value;
pagingSpec.FilterExpressions.Add(h => h.DownloadId == downloadId);
}
+6 -7
View File
@@ -1,5 +1,5 @@
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using NzbDrone.Common.Extensions;
using NzbDrone.Core.Instrumentation;
using Readarr.Http;
using Readarr.Http.Extensions;
@@ -17,9 +17,10 @@ namespace Readarr.Api.V1.Logs
}
[HttpGet]
public PagingResource<LogResource> GetLogs()
[Produces("application/json")]
public PagingResource<LogResource> GetLogs([FromQuery] PagingRequestResource paging, string level)
{
var pagingResource = Request.ReadPagingResourceFromRequest<LogResource>();
var pagingResource = new PagingResource<LogResource>(paging);
var pageSpec = pagingResource.MapToPagingSpec<LogResource, Log>();
if (pageSpec.SortKey == "time")
@@ -27,11 +28,9 @@ namespace Readarr.Api.V1.Logs
pageSpec.SortKey = "id";
}
var levelFilter = pagingResource.Filters.FirstOrDefault(f => f.Key == "level");
if (levelFilter != null)
if (level.IsNotNullOrWhiteSpace())
{
switch (levelFilter.Value)
switch (level)
{
case "fatal":
pageSpec.FilterExpressions.Add(h => h.Level == "Fatal");
+3 -2
View File
@@ -100,9 +100,10 @@ namespace Readarr.Api.V1.Queue
}
[HttpGet]
public PagingResource<QueueResource> GetQueue(bool includeUnknownAuthorItems = false, bool includeAuthor = false, bool includeBook = false)
[Produces("application/json")]
public PagingResource<QueueResource> GetQueue([FromQuery] PagingRequestResource paging, bool includeUnknownAuthorItems = false, bool includeAuthor = false, bool includeBook = false)
{
var pagingResource = Request.ReadPagingResourceFromRequest<QueueResource>();
var pagingResource = new PagingResource<QueueResource>(paging);
var pagingSpec = pagingResource.MapToPagingSpec<QueueResource, NzbDrone.Core.Queue.Queue>("timeleft", SortDirection.Ascending);
return pagingSpec.ApplyToPage((spec) => GetQueue(spec, includeUnknownAuthorItems), (q) => MapToResource(q, includeAuthor, includeBook));
@@ -1,4 +1,3 @@
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using NzbDrone.Core.AuthorStats;
using NzbDrone.Core.Books;
@@ -30,9 +29,9 @@ namespace Readarr.Api.V1.Wanted
}
[HttpGet]
public PagingResource<BookResource> GetCutoffUnmetBooks(bool includeAuthor = false)
public PagingResource<BookResource> GetCutoffUnmetBooks([FromQuery] PagingRequestResource paging, bool includeAuthor = false, bool monitored = true)
{
var pagingResource = Request.ReadPagingResourceFromRequest<BookResource>();
var pagingResource = new PagingResource<BookResource>(paging);
var pagingSpec = new PagingSpec<Book>
{
Page = pagingResource.Page,
@@ -41,9 +40,7 @@ namespace Readarr.Api.V1.Wanted
SortDirection = pagingResource.SortDirection
};
var filter = pagingResource.Filters.FirstOrDefault(f => f.Key == "monitored");
if (filter != null && filter.Value == "false")
if (monitored)
{
pagingSpec.FilterExpressions.Add(v => v.Monitored == false || v.Author.Value.Monitored == false);
}
@@ -1,4 +1,3 @@
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using NzbDrone.Core.AuthorStats;
using NzbDrone.Core.Books;
@@ -26,9 +25,9 @@ namespace Readarr.Api.V1.Wanted
}
[HttpGet]
public PagingResource<BookResource> GetMissingBooks(bool includeAuthor = false)
public PagingResource<BookResource> GetMissingBooks([FromQuery] PagingRequestResource paging, bool includeAuthor = false, bool monitored = true)
{
var pagingResource = Request.ReadPagingResourceFromRequest<BookResource>();
var pagingResource = new PagingResource<BookResource>(paging);
var pagingSpec = new PagingSpec<Book>
{
Page = pagingResource.Page,
@@ -37,9 +36,7 @@ namespace Readarr.Api.V1.Wanted
SortDirection = pagingResource.SortDirection
};
var monitoredFilter = pagingResource.Filters.FirstOrDefault(f => f.Key == "monitored");
if (monitoredFilter != null && monitoredFilter.Value == "false")
if (monitored)
{
pagingSpec.FilterExpressions.Add(v => v.Monitored == false || v.Author.Value.Monitored == false);
}