removed library/ prefix from genre, studio, year and person url's

This commit is contained in:
LukePulverenti 2013-03-08 15:36:19 -05:00
parent c4c9126f79
commit fb62e300d7
11 changed files with 47 additions and 19 deletions

View file

@ -30,21 +30,21 @@ namespace MediaBrowser.Api
/// Gets or sets a value indicating whether [include files].
/// </summary>
/// <value><c>true</c> if [include files]; otherwise, <c>false</c>.</value>
[ApiMember(Name = "IncludeFiles", Description = "An optional filter to include or exclude files from the results.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
[ApiMember(Name = "IncludeFiles", Description = "An optional filter to include or exclude files from the results.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool IncludeFiles { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [include directories].
/// </summary>
/// <value><c>true</c> if [include directories]; otherwise, <c>false</c>.</value>
[ApiMember(Name = "IncludeDirectories", Description = "An optional filter to include or exclude folders from the results.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
[ApiMember(Name = "IncludeDirectories", Description = "An optional filter to include or exclude folders from the results.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool IncludeDirectories { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [include hidden].
/// </summary>
/// <value><c>true</c> if [include hidden]; otherwise, <c>false</c>.</value>
[ApiMember(Name = "IncludeHidden", Description = "An optional filter to include or exclude hidden files and folders.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
[ApiMember(Name = "IncludeHidden", Description = "An optional filter to include or exclude hidden files and folders.", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool IncludeHidden { get; set; }
public GetDirectoryContents()

View file

@ -21,6 +21,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Items/{Id}/Images/{Type}", "GET")]
[Route("/Items/{Id}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets an item image")]
public class GetItemImage : ImageRequest
{
/// <summary>
@ -35,6 +36,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Persons/{Name}/Images/{Type}", "GET")]
[Route("/Persons/{Name}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a person image")]
public class GetPersonImage : ImageRequest
{
/// <summary>
@ -49,6 +51,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Studios/{Name}/Images/{Type}", "GET")]
[Route("/Studios/{Name}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a studio image")]
public class GetStudioImage : ImageRequest
{
/// <summary>
@ -63,6 +66,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Genres/{Name}/Images/{Type}", "GET")]
[Route("/Genres/{Name}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a genre image")]
public class GetGenreImage : ImageRequest
{
/// <summary>
@ -77,6 +81,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Years/{Year}/Images/{Type}", "GET")]
[Route("/Years/{Year}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a year image")]
public class GetYearImage : ImageRequest
{
/// <summary>
@ -91,6 +96,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Users/{Id}/Images/{Type}", "GET")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a user image")]
public class GetUserImage : ImageRequest
{
/// <summary>
@ -105,6 +111,7 @@ namespace MediaBrowser.Api.Images
/// </summary>
[Route("/Users/{Id}/Images/{Type}", "DELETE")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "DELETE")]
[ServiceStack.ServiceHost.Api(Description = "Deletes a user image")]
public class DeleteUserImage : DeleteImageRequest, IReturnVoid
{
/// <summary>
@ -116,6 +123,7 @@ namespace MediaBrowser.Api.Images
[Route("/Users/{Id}/Images/{Type}", "POST")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "POST")]
[ServiceStack.ServiceHost.Api(Description = "Posts a user image")]
public class PostUserImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid
{
/// <summary>

View file

@ -670,7 +670,7 @@ var ApiClient = {
throw new Error("null name");
}
var url = ApiClient.getUrl("Library/Studios/" + name);
var url = ApiClient.getUrl("Studios/" + name);
return $.getJSON(url);
},
@ -684,7 +684,7 @@ var ApiClient = {
throw new Error("null name");
}
var url = ApiClient.getUrl("Library/Genres/" + name);
var url = ApiClient.getUrl("Genres/" + name);
return $.getJSON(url);
},
@ -698,7 +698,7 @@ var ApiClient = {
throw new Error("null year");
}
var url = ApiClient.getUrl("Library/Years/" + year);
var url = ApiClient.getUrl("Years/" + year);
return $.getJSON(url);
},
@ -712,7 +712,7 @@ var ApiClient = {
throw new Error("null name");
}
var url = ApiClient.getUrl("Library/Persons/" + name);
var url = ApiClient.getUrl("Persons/" + name);
return $.getJSON(url);
},

View file

@ -12,7 +12,7 @@ namespace MediaBrowser.Api.Javascript
/// Class GetJavascriptApiClient
/// </summary>
[Route("/JsApiClient.js", "GET")]
[ServiceStack.ServiceHost.Api(("Gets an api wrapper in Javascript"))]
[ServiceStack.ServiceHost.Api(("Gets an api wrapper written in Javascript"))]
public class GetJavascriptApiClient
{
/// <summary>

View file

@ -14,6 +14,7 @@ namespace MediaBrowser.Api.Library
/// Class GetPhyscialPaths
/// </summary>
[Route("/Library/PhysicalPaths", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a list of physical paths from virtual folders")]
public class GetPhyscialPaths : IReturn<List<string>>
{
}
@ -22,64 +23,74 @@ namespace MediaBrowser.Api.Library
/// Class GetItemTypes
/// </summary>
[Route("/Library/ItemTypes", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a list of BaseItem types")]
public class GetItemTypes : IReturn<List<string>>
{
/// <summary>
/// Gets or sets a value indicating whether this instance has internet provider.
/// </summary>
/// <value><c>true</c> if this instance has internet provider; otherwise, <c>false</c>.</value>
[ApiMember(Name = "HasInternetProvider", Description = "Optional filter by item types that have internet providers", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
public bool HasInternetProvider { get; set; }
}
/// <summary>
/// Class GetPerson
/// </summary>
[Route("/Library/Persons/{Name}", "GET")]
[Route("/Persons/{Name}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a person, by name")]
public class GetPerson : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The person name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
}
/// <summary>
/// Class GetStudio
/// </summary>
[Route("/Library/Studios/{Name}", "GET")]
[Route("/Studios/{Name}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a studio, by name")]
public class GetStudio : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The studio name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
}
/// <summary>
/// Class GetGenre
/// </summary>
[Route("/Library/Genres/{Name}", "GET")]
[Route("/Genres/{Name}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a genre, by name")]
public class GetGenre : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The genre name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
}
/// <summary>
/// Class GetYear
/// </summary>
[Route("/Library/Years/{Year}", "GET")]
[Route("/Years/{Year}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a year")]
public class GetYear : IReturn<BaseItemDto>
{
/// <summary>
/// Gets or sets the year.
/// </summary>
/// <value>The year.</value>
[ApiMember(Name = "Year", Description = "The year", IsRequired = true, DataType = "int", ParameterType = "path", Verb = "GET")]
public int Year { get; set; }
}

View file

@ -1,13 +1,11 @@
using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.ScheduledTasks;
using MediaBrowser.Model.Serialization;
using MediaBrowser.Model.Tasks;
using MediaBrowser.Server.Implementations.HttpServer;
using ServiceStack.ServiceHost;
using ServiceStack.Text.Controller;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
namespace MediaBrowser.Api.ScheduledTasks
@ -16,12 +14,14 @@ namespace MediaBrowser.Api.ScheduledTasks
/// Class GetScheduledTask
/// </summary>
[Route("/ScheduledTasks/{Id}", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a scheduled task, by Id")]
public class GetScheduledTask : IReturn<TaskInfo>
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public Guid Id { get; set; }
}
@ -29,6 +29,7 @@ namespace MediaBrowser.Api.ScheduledTasks
/// Class GetScheduledTasks
/// </summary>
[Route("/ScheduledTasks", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets scheduled tasks")]
public class GetScheduledTasks : IReturn<List<TaskInfo>>
{
@ -38,12 +39,14 @@ namespace MediaBrowser.Api.ScheduledTasks
/// Class StartScheduledTask
/// </summary>
[Route("/ScheduledTasks/Running/{Id}", "POST")]
[ServiceStack.ServiceHost.Api(Description = "Starts a scheduled task")]
public class StartScheduledTask : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
}
@ -51,12 +54,14 @@ namespace MediaBrowser.Api.ScheduledTasks
/// Class StopScheduledTask
/// </summary>
[Route("/ScheduledTasks/Running/{Id}", "DELETE")]
[ServiceStack.ServiceHost.Api(Description = "Stops a scheduled task")]
public class StopScheduledTask : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
public Guid Id { get; set; }
}
@ -64,12 +69,14 @@ namespace MediaBrowser.Api.ScheduledTasks
/// Class UpdateScheduledTaskTriggers
/// </summary>
[Route("/ScheduledTasks/{Id}/Triggers", "POST")]
[ServiceStack.ServiceHost.Api(Description = "Updates the triggers for a scheduled task")]
public class UpdateScheduledTaskTriggers : List<TaskTriggerInfo>, IReturnVoid
{
/// <summary>
/// Gets or sets the task id.
/// </summary>
/// <value>The task id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
public Guid Id { get; set; }
}

View file

@ -16,6 +16,7 @@ namespace MediaBrowser.Api
/// Class GetUsers
/// </summary>
[Route("/Users", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets a list of users")]
public class GetUsers : IReturn<List<UserDto>>
{
}

View file

@ -558,6 +558,7 @@ namespace MediaBrowser.Model.Dto
/// Gets a value indicating whether this instance has menu image.
/// </summary>
/// <value><c>true</c> if this instance has menu image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasMenuImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Menu); }

View file

@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>MediaBrowser.Common.Internal</id>
<version>3.0.38</version>
<version>3.0.39</version>
<title>MediaBrowser.Common.Internal</title>
<authors>Luke</authors>
<owners>ebr,Luke,scottisafool</owners>
@ -12,7 +12,7 @@
<description>Contains common components shared by Media Browser Theatre and Media Browser Server. Not intended for plugin developer consumption.</description>
<copyright>Copyright © Media Browser 2013</copyright>
<dependencies>
<dependency id="MediaBrowser.Common" version="3.0.38" />
<dependency id="MediaBrowser.Common" version="3.0.39" />
<dependency id="NLog" version="2.0.0.2000" />
<dependency id="ServiceStack.Text" version="3.9.38" />
<dependency id="protobuf-net" version="2.0.0.621" />

View file

@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<id>MediaBrowser.Common</id>
<version>3.0.38</version>
<version>3.0.39</version>
<title>MediaBrowser.Common</title>
<authors>Media Browser Team</authors>
<owners>ebr,Luke,scottisafool</owners>

View file

@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<id>MediaBrowser.Server.Core</id>
<version>3.0.38</version>
<version>3.0.39</version>
<title>Media Browser.Server.Core</title>
<authors>Media Browser Team</authors>
<owners>ebr,Luke,scottisafool</owners>
@ -12,7 +12,7 @@
<description>Contains core components required to build plugins for Media Browser Server.</description>
<copyright>Copyright © Media Browser 2013</copyright>
<dependencies>
<dependency id="MediaBrowser.Common" version="3.0.38" />
<dependency id="MediaBrowser.Common" version="3.0.39" />
</dependencies>
</metadata>
<files>