mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-07-09 15:20:34 +02:00
Revert "Make /MusicGenres obsolete"
This commit is contained in:
parent
6e6ecbc988
commit
de52c8a497
|
@ -66,7 +66,6 @@ namespace Jellyfin.Api.Controllers
|
||||||
/// <response code="200">Genres returned.</response>
|
/// <response code="200">Genres returned.</response>
|
||||||
/// <returns>An <see cref="OkResult"/> containing the queryresult of genres.</returns>
|
/// <returns>An <see cref="OkResult"/> containing the queryresult of genres.</returns>
|
||||||
[HttpGet]
|
[HttpGet]
|
||||||
[HttpGet("/MusicGenres", Name = "GetMusicGenres-Deprecated")]
|
|
||||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||||
public ActionResult<QueryResult<BaseItemDto>> GetGenres(
|
public ActionResult<QueryResult<BaseItemDto>> GetGenres(
|
||||||
[FromQuery] int? startIndex,
|
[FromQuery] int? startIndex,
|
||||||
|
|
|
@ -44,6 +44,88 @@ namespace Jellyfin.Api.Controllers
|
||||||
_dtoService = dtoService;
|
_dtoService = dtoService;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets all music genres from a given item, folder, or the entire library.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
||||||
|
/// <param name="limit">Optional. The maximum number of records to return.</param>
|
||||||
|
/// <param name="searchTerm">The search term.</param>
|
||||||
|
/// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
||||||
|
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
|
||||||
|
/// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.</param>
|
||||||
|
/// <param name="includeItemTypes">Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.</param>
|
||||||
|
/// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
||||||
|
/// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
||||||
|
/// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
||||||
|
/// <param name="userId">User id.</param>
|
||||||
|
/// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
||||||
|
/// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
||||||
|
/// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
||||||
|
/// <param name="enableImages">Optional, include image information in output.</param>
|
||||||
|
/// <param name="enableTotalRecordCount">Optional. Include total record count.</param>
|
||||||
|
/// <response code="200">Music genres returned.</response>
|
||||||
|
/// <returns>An <see cref="OkResult"/> containing the queryresult of music genres.</returns>
|
||||||
|
[HttpGet]
|
||||||
|
public ActionResult<QueryResult<BaseItemDto>> GetMusicGenres(
|
||||||
|
[FromQuery] int? startIndex,
|
||||||
|
[FromQuery] int? limit,
|
||||||
|
[FromQuery] string? searchTerm,
|
||||||
|
[FromQuery] string? parentId,
|
||||||
|
[FromQuery] string? fields,
|
||||||
|
[FromQuery] string? excludeItemTypes,
|
||||||
|
[FromQuery] string? includeItemTypes,
|
||||||
|
[FromQuery] bool? isFavorite,
|
||||||
|
[FromQuery] int? imageTypeLimit,
|
||||||
|
[FromQuery] ImageType[] enableImageTypes,
|
||||||
|
[FromQuery] Guid? userId,
|
||||||
|
[FromQuery] string? nameStartsWithOrGreater,
|
||||||
|
[FromQuery] string? nameStartsWith,
|
||||||
|
[FromQuery] string? nameLessThan,
|
||||||
|
[FromQuery] bool? enableImages = true,
|
||||||
|
[FromQuery] bool enableTotalRecordCount = true)
|
||||||
|
{
|
||||||
|
var dtoOptions = new DtoOptions()
|
||||||
|
.AddItemFields(fields)
|
||||||
|
.AddClientFields(Request)
|
||||||
|
.AddAdditionalDtoOptions(enableImages, false, imageTypeLimit, enableImageTypes);
|
||||||
|
|
||||||
|
User? user = userId.HasValue && userId != Guid.Empty ? _userManager.GetUserById(userId.Value) : null;
|
||||||
|
|
||||||
|
var parentItem = _libraryManager.GetParentItem(parentId, userId);
|
||||||
|
|
||||||
|
var query = new InternalItemsQuery(user)
|
||||||
|
{
|
||||||
|
ExcludeItemTypes = RequestHelpers.Split(excludeItemTypes, ',', true),
|
||||||
|
IncludeItemTypes = RequestHelpers.Split(includeItemTypes, ',', true),
|
||||||
|
StartIndex = startIndex,
|
||||||
|
Limit = limit,
|
||||||
|
IsFavorite = isFavorite,
|
||||||
|
NameLessThan = nameLessThan,
|
||||||
|
NameStartsWith = nameStartsWith,
|
||||||
|
NameStartsWithOrGreater = nameStartsWithOrGreater,
|
||||||
|
DtoOptions = dtoOptions,
|
||||||
|
SearchTerm = searchTerm,
|
||||||
|
EnableTotalRecordCount = enableTotalRecordCount
|
||||||
|
};
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(parentId))
|
||||||
|
{
|
||||||
|
if (parentItem is Folder)
|
||||||
|
{
|
||||||
|
query.AncestorIds = new[] { new Guid(parentId) };
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
query.ItemIds = new[] { new Guid(parentId) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var result = _libraryManager.GetMusicGenres(query);
|
||||||
|
|
||||||
|
var shouldIncludeItemTypes = !string.IsNullOrWhiteSpace(includeItemTypes);
|
||||||
|
return RequestHelpers.CreateQueryResult(result, dtoOptions, _dtoService, shouldIncludeItemTypes, user);
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Gets a music genre, by name.
|
/// Gets a music genre, by name.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -260,7 +260,6 @@ namespace Jellyfin.Server.Extensions
|
||||||
c.AddSwaggerTypeMappings();
|
c.AddSwaggerTypeMappings();
|
||||||
|
|
||||||
c.OperationFilter<FileResponseFilter>();
|
c.OperationFilter<FileResponseFilter>();
|
||||||
c.OperationFilter<ObsoleteRoutesFilter>();
|
|
||||||
c.DocumentFilter<WebsocketModelFilter>();
|
c.DocumentFilter<WebsocketModelFilter>();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,22 +0,0 @@
|
||||||
using System;
|
|
||||||
using Microsoft.AspNetCore.Mvc.Controllers;
|
|
||||||
using Microsoft.OpenApi.Models;
|
|
||||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
|
||||||
|
|
||||||
namespace Jellyfin.Server.Filters
|
|
||||||
{
|
|
||||||
/// <inheritdoc />
|
|
||||||
public class ObsoleteRoutesFilter : IOperationFilter
|
|
||||||
{
|
|
||||||
/// <inheritdoc />
|
|
||||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
|
||||||
{
|
|
||||||
if (context.ApiDescription.ActionDescriptor is ControllerActionDescriptor actionDescriptor
|
|
||||||
&& !string.IsNullOrEmpty(actionDescriptor.AttributeRouteInfo.Name)
|
|
||||||
&& actionDescriptor.AttributeRouteInfo.Name.EndsWith("deprecated", StringComparison.OrdinalIgnoreCase))
|
|
||||||
{
|
|
||||||
operation.Deprecated = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
Loading…
Reference in a new issue