michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add default values for parameters and fix spelling

Browse Source
This commit is contained in:
David 2020-06-07 18:10:08 +02:00
parent 7fa374f8a2
commit cefa9d3c08
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Jellyfin.Api/Controllers/SearchController.cs
View File

@ -57,11 +57,6 @@ namespace Jellyfin.Api.Controllers
/// <param name="limit">Optional. The maximum number of records to return.</param> /// <param name="limit">Optional. The maximum number of records to return.</param>
/// <param name="userId">Optional. Supply a user id to search within a user's library or omit to search all.</param> /// <param name="userId">Optional. Supply a user id to search within a user's library or omit to search all.</param>
/// <param name="searchTerm">The search term to filter on.</param> /// <param name="searchTerm">The search term to filter on.</param>
/// <param name="includePeople">Optional filter whether to include people.</param>
/// <param name="includeMedia">Optional filter whether to include media.</param>
/// <param name="includeGenres">Optional filter whether to include genres.</param>
/// <param name="includeStudios">Optional filter whether to include studios.</param>
/// <param name="includeArtists">Optional filter whether to include artists.</param>
/// <param name="includeItemTypes">If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.</param> /// <param name="includeItemTypes">If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.</param>
/// <param name="excludeItemTypes">If specified, results with these item types are filtered out. This allows multiple, comma delimeted.</param> /// <param name="excludeItemTypes">If specified, results with these item types are filtered out. This allows multiple, comma delimeted.</param>
/// <param name="mediaTypes">If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.</param> /// <param name="mediaTypes">If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.</param>
@ -71,6 +66,11 @@ namespace Jellyfin.Api.Controllers
/// <param name="isNews">Optional filter for news.</param> /// <param name="isNews">Optional filter for news.</param>
/// <param name="isKids">Optional filter for kids.</param> /// <param name="isKids">Optional filter for kids.</param>
/// <param name="isSports">Optional filter for sports.</param> /// <param name="isSports">Optional filter for sports.</param>
/// <param name="includePeople">Optional filter whether to include people.</param>
/// <param name="includeMedia">Optional filter whether to include media.</param>
/// <param name="includeGenres">Optional filter whether to include genres.</param>
/// <param name="includeStudios">Optional filter whether to include studios.</param>
/// <param name="includeArtists">Optional filter whether to include artists.</param>
/// <returns>An <see cref="SearchHintResult"/> with the results of the search.</returns> /// <returns>An <see cref="SearchHintResult"/> with the results of the search.</returns>
[HttpGet] [HttpGet]
[Description("Gets search hints based on a search term")] [Description("Gets search hints based on a search term")]
@ -80,11 +80,6 @@ namespace Jellyfin.Api.Controllers
[FromQuery] int? limit, [FromQuery] int? limit,
[FromQuery] Guid userId, [FromQuery] Guid userId,
[FromQuery, Required] string searchTerm, [FromQuery, Required] string searchTerm,
[FromQuery] bool includePeople,
[FromQuery] bool includeMedia,
[FromQuery] bool includeGenres,
[FromQuery] bool includeStudios,
[FromQuery] bool includeArtists,
[FromQuery] string includeItemTypes, [FromQuery] string includeItemTypes,
[FromQuery] string excludeItemTypes, [FromQuery] string excludeItemTypes,
[FromQuery] string mediaTypes, [FromQuery] string mediaTypes,
@ -93,7 +88,12 @@ namespace Jellyfin.Api.Controllers
[FromQuery] bool? isSeries, [FromQuery] bool? isSeries,
[FromQuery] bool? isNews, [FromQuery] bool? isNews,
[FromQuery] bool? isKids, [FromQuery] bool? isKids,
[FromQuery] bool? isSports) [FromQuery] bool? isSports,
[FromQuery] bool includePeople = true,
[FromQuery] bool includeMedia = true,
[FromQuery] bool includeGenres = true,
[FromQuery] bool includeStudios = true,
[FromQuery] bool includeArtists = true)
{ {
var result = _searchEngine.GetSearchHints(new SearchQuery var result = _searchEngine.GetSearchHints(new SearchQuery
{ {

4
Jellyfin.Api/Helpers/RequestHelpers.cs
View File

@ -8,10 +8,10 @@ namespace Jellyfin.Api.Helpers
public static class RequestHelpers public static class RequestHelpers
{ {
/// <summary> /// <summary>
/// Splits a string at a seperating character into an array of substrings. /// Splits a string at a separating character into an array of substrings.
/// </summary> /// </summary>
/// <param name="value">The string to split.</param> /// <param name="value">The string to split.</param>
/// <param name="separator">The char that seperates the substrings.</param> /// <param name="separator">The char that separates the substrings.</param>
/// <param name="removeEmpty">Option to remove empty substrings from the array.</param> /// <param name="removeEmpty">Option to remove empty substrings from the array.</param>
/// <returns>An array of the substrings.</returns> /// <returns>An array of the substrings.</returns>
internal static string[] Split(string value, char separator, bool removeEmpty) internal static string[] Split(string value, char separator, bool removeEmpty)