alteropen/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2026-05-27 10:58:44 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

revise endpoint attributes

Browse Source
This commit is contained in:
Luke Pulverenti
2014-11-14 21:31:03 -05:00
parent 15a56fa069
commit a4b75934e5
59 changed files with 714 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
MediaBrowser.Api/UserLibrary/GameGenresService.cs
View File

@@ -13,8 +13,7 @@ using System.Linq;
namespace MediaBrowser.Api.UserLibrary
{
[Route("/GameGenres", "GET")]
[Api(Description = "Gets all Game genres from a given item, folder, or the entire library")]
[Route("/GameGenres", "GET", Summary = "Gets all Game genres from a given item, folder, or the entire library")]
public class GetGameGenres : GetItemsByName
{
public GetGameGenres()
@@ -23,8 +22,7 @@ namespace MediaBrowser.Api.UserLibrary
}
}
[Route("/GameGenres/{Name}", "GET")]
[Api(Description = "Gets a Game genre, by name")]
[Route("/GameGenres/{Name}", "GET", Summary = "Gets a Game genre, by name")]
public class GetGameGenre : IReturn<BaseItemDto>
{
/// <summary>

6
MediaBrowser.Api/UserLibrary/GenresService.cs
View File

@@ -16,8 +16,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetGenres
/// </summary>
[Route("/Genres", "GET")]
[Api(Description = "Gets all genres from a given item, folder, or the entire library")]
[Route("/Genres", "GET", Summary = "Gets all genres from a given item, folder, or the entire library")]
public class GetGenres : GetItemsByName
{
}
@@ -25,8 +24,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetGenre
/// </summary>
[Route("/Genres/{Name}", "GET")]
[Api(Description = "Gets a genre, by name")]
[Route("/Genres/{Name}", "GET", Summary = "Gets a genre, by name")]
public class GetGenre : IReturn<BaseItemDto>
{
/// <summary>

6
MediaBrowser.Api/UserLibrary/MusicGenresService.cs
View File

@@ -13,8 +13,7 @@ using System.Linq;
namespace MediaBrowser.Api.UserLibrary
{
[Route("/MusicGenres", "GET")]
[Api(Description = "Gets all music genres from a given item, folder, or the entire library")]
[Route("/MusicGenres", "GET", Summary = "Gets all music genres from a given item, folder, or the entire library")]
public class GetMusicGenres : GetItemsByName
{
public GetMusicGenres()
@@ -23,8 +22,7 @@ namespace MediaBrowser.Api.UserLibrary
}
}
[Route("/MusicGenres/{Name}", "GET")]
[Api(Description = "Gets a music genre, by name")]
[Route("/MusicGenres/{Name}", "GET", Summary = "Gets a music genre, by name")]
public class GetMusicGenre : IReturn<BaseItemDto>
{
/// <summary>

6
MediaBrowser.Api/UserLibrary/PersonsService.cs
View File

@@ -15,8 +15,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetPersons
/// </summary>
[Route("/Persons", "GET")]
[Api(Description = "Gets all persons from a given item, folder, or the entire library")]
[Route("/Persons", "GET", Summary = "Gets all persons from a given item, folder, or the entire library")]
public class GetPersons : GetItemsByName
{
/// <summary>
@@ -30,8 +29,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetPerson
/// </summary>
[Route("/Persons/{Name}", "GET")]
[Api(Description = "Gets a person, by name")]
[Route("/Persons/{Name}", "GET", Summary = "Gets a person, by name")]
public class GetPerson : IReturn<BaseItemDto>
{
/// <summary>

24
MediaBrowser.Api/UserLibrary/PlaystateService.cs
View File

@@ -15,8 +15,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class MarkPlayedItem
/// </summary>
[Route("/Users/{UserId}/PlayedItems/{Id}", "POST")]
[Api(Description = "Marks an item as played")]
[Route("/Users/{UserId}/PlayedItems/{Id}", "POST", Summary = "Marks an item as played")]
public class MarkPlayedItem : IReturn<UserItemDataDto>
{
/// <summary>
@@ -40,8 +39,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class MarkUnplayedItem
/// </summary>
[Route("/Users/{UserId}/PlayedItems/{Id}", "DELETE")]
[Api(Description = "Marks an item as unplayed")]
[Route("/Users/{UserId}/PlayedItems/{Id}", "DELETE", Summary = "Marks an item as unplayed")]
public class MarkUnplayedItem : IReturn<UserItemDataDto>
{
/// <summary>
@@ -59,20 +57,17 @@ namespace MediaBrowser.Api.UserLibrary
public string Id { get; set; }
}
[Route("/Sessions/Playing", "POST")]
[Api(Description = "Reports playback has started within a session")]
[Route("/Sessions/Playing", "POST", Summary = "Reports playback has started within a session")]
public class ReportPlaybackStart : PlaybackStartInfo, IReturnVoid
{
}
[Route("/Sessions/Playing/Progress", "POST")]
[Api(Description = "Reports playback progress within a session")]
[Route("/Sessions/Playing/Progress", "POST", Summary = "Reports playback progress within a session")]
public class ReportPlaybackProgress : PlaybackProgressInfo, IReturnVoid
{
}
[Route("/Sessions/Playing/Stopped", "POST")]
[Api(Description = "Reports playback has stopped within a session")]
[Route("/Sessions/Playing/Stopped", "POST", Summary = "Reports playback has stopped within a session")]
public class ReportPlaybackStopped : PlaybackStopInfo, IReturnVoid
{
}
@@ -80,8 +75,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class OnPlaybackStart
/// </summary>
[Route("/Users/{UserId}/PlayingItems/{Id}", "POST")]
[Api(Description = "Reports that a user has begun playing an item")]
[Route("/Users/{UserId}/PlayingItems/{Id}", "POST", Summary = "Reports that a user has begun playing an item")]
public class OnPlaybackStart : IReturnVoid
{
/// <summary>
@@ -125,8 +119,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class OnPlaybackProgress
/// </summary>
[Route("/Users/{UserId}/PlayingItems/{Id}/Progress", "POST")]
[Api(Description = "Reports a user's playback progress")]
[Route("/Users/{UserId}/PlayingItems/{Id}/Progress", "POST", Summary = "Reports a user's playback progress")]
public class OnPlaybackProgress : IReturnVoid
{
/// <summary>
@@ -172,8 +165,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class OnPlaybackStopped
/// </summary>
[Route("/Users/{UserId}/PlayingItems/{Id}", "DELETE")]
[Api(Description = "Reports that a user has stopped playing an item")]
[Route("/Users/{UserId}/PlayingItems/{Id}", "DELETE", Summary = "Reports that a user has stopped playing an item")]
public class OnPlaybackStopped : IReturnVoid
{
/// <summary>

37
MediaBrowser.Api/UserLibrary/UserLibraryService.cs
View File

@@ -1,6 +1,5 @@
using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Movies;
using MediaBrowser.Controller.Entities.TV;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Net;
@@ -21,8 +20,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetItem
/// </summary>
[Route("/Users/{UserId}/Items/{Id}", "GET")]
[Api(Description = "Gets an item from a user's library")]
[Route("/Users/{UserId}/Items/{Id}", "GET", Summary = "Gets an item from a user's library")]
public class GetItem : IReturn<BaseItemDto>
{
/// <summary>
@@ -57,8 +55,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetItem
/// </summary>
[Route("/Users/{UserId}/Items/Root", "GET")]
[Api(Description = "Gets the root folder from a user's library")]
[Route("/Users/{UserId}/Items/Root", "GET", Summary = "Gets the root folder from a user's library")]
public class GetRootFolder : IReturn<BaseItemDto>
{
/// <summary>
@@ -72,8 +69,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetIntros
/// </summary>
[Route("/Users/{UserId}/Items/{Id}/Intros", "GET")]
[Api(("Gets intros to play before the main media item plays"))]
[Route("/Users/{UserId}/Items/{Id}/Intros", "GET", Summary = "Gets intros to play before the main media item plays")]
public class GetIntros : IReturn<ItemsResult>
{
/// <summary>
@@ -94,8 +90,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class MarkFavoriteItem
/// </summary>
[Route("/Users/{UserId}/FavoriteItems/{Id}", "POST")]
[Api(Description = "Marks an item as a favorite")]
[Route("/Users/{UserId}/FavoriteItems/{Id}", "POST", Summary = "Marks an item as a favorite")]
public class MarkFavoriteItem : IReturn<UserItemDataDto>
{
/// <summary>
@@ -116,8 +111,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class UnmarkFavoriteItem
/// </summary>
[Route("/Users/{UserId}/FavoriteItems/{Id}", "DELETE")]
[Api(Description = "Unmarks an item as a favorite")]
[Route("/Users/{UserId}/FavoriteItems/{Id}", "DELETE", Summary = "Unmarks an item as a favorite")]
public class UnmarkFavoriteItem : IReturn<UserItemDataDto>
{
/// <summary>
@@ -138,8 +132,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class ClearUserItemRating
/// </summary>
[Route("/Users/{UserId}/Items/{Id}/Rating", "DELETE")]
[Api(Description = "Deletes a user's saved personal rating for an item")]
[Route("/Users/{UserId}/Items/{Id}/Rating", "DELETE", Summary = "Deletes a user's saved personal rating for an item")]
public class DeleteUserItemRating : IReturn<UserItemDataDto>
{
/// <summary>
@@ -160,8 +153,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class UpdateUserItemRating
/// </summary>
[Route("/Users/{UserId}/Items/{Id}/Rating", "POST")]
[Api(Description = "Updates a user's rating for an item")]
[Route("/Users/{UserId}/Items/{Id}/Rating", "POST", Summary = "Updates a user's rating for an item")]
public class UpdateUserItemRating : IReturn<UserItemDataDto>
{
/// <summary>
@@ -189,8 +181,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetLocalTrailers
/// </summary>
[Route("/Users/{UserId}/Items/{Id}/LocalTrailers", "GET")]
[Api(Description = "Gets local trailers for an item")]
[Route("/Users/{UserId}/Items/{Id}/LocalTrailers", "GET", Summary = "Gets local trailers for an item")]
public class GetLocalTrailers : IReturn<List<BaseItemDto>>
{
/// <summary>
@@ -211,8 +202,7 @@ namespace MediaBrowser.Api.UserLibrary
/// <summary>
/// Class GetSpecialFeatures
/// </summary>
[Route("/Users/{UserId}/Items/{Id}/SpecialFeatures", "GET")]
[Api(Description = "Gets special features for an item")]
[Route("/Users/{UserId}/Items/{Id}/SpecialFeatures", "GET", Summary = "Gets special features for an item")]
public class GetSpecialFeatures : IReturn<List<BaseItemDto>>
{
/// <summary>
@@ -280,15 +270,6 @@ namespace MediaBrowser.Api.UserLibrary
private readonly IDtoService _dtoService;
private readonly IUserViewManager _userViewManager;
/// <summary>
/// Initializes a new instance of the <see cref="UserLibraryService" /> class.
/// </summary>
/// <param name="userManager">The user manager.</param>
/// <param name="libraryManager">The library manager.</param>
/// <param name="userDataRepository">The user data repository.</param>
/// <param name="dtoService">The dto service.</param>
/// <param name="userViewManager">The user view manager.</param>
/// <exception cref="System.ArgumentNullException">jsonSerializer</exception>
public UserLibraryService(IUserManager userManager, ILibraryManager libraryManager, IUserDataManager userDataRepository, IDtoService dtoService, IUserViewManager userViewManager)
{
_userManager = userManager;