aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Pulverenti <luke.pulverenti@gmail.com>2017-09-11 15:25:13 -0400
committerLuke Pulverenti <luke.pulverenti@gmail.com>2017-09-11 15:25:13 -0400
commit2f99a78230b397535d7ea0b9e335a00b438379b4 (patch)
treec4f381ddde5fd428f11c1b8b602f31c6d3eb2166
parent95084d6f7d03594b1d4939067609d0065e08d606 (diff)
3.2.30.17
-rw-r--r--Emby.Server.Implementations/Services/ServiceController.cs2
-rw-r--r--Emby.Server.Implementations/Services/ServicePath.cs6
-rw-r--r--Emby.Server.Implementations/Services/SwaggerService.cs14
-rw-r--r--MediaBrowser.Api/PluginService.cs10
-rw-r--r--MediaBrowser.Model/Services/RouteAttribute.cs4
-rw-r--r--MediaBrowser.WebDashboard/Api/DashboardService.cs8
-rw-r--r--SharedVersion.cs2
7 files changed, 30 insertions, 16 deletions
diff --git a/Emby.Server.Implementations/Services/ServiceController.cs b/Emby.Server.Implementations/Services/ServiceController.cs
index 4dc14a193..3fd6d88f8 100644
--- a/Emby.Server.Implementations/Services/ServiceController.cs
+++ b/Emby.Server.Implementations/Services/ServiceController.cs
@@ -75,7 +75,7 @@ namespace Emby.Server.Implementations.Services
var attrs = appHost.GetRouteAttributes(requestType);
foreach (RouteAttribute attr in attrs)
{
- var restPath = new RestPath(appHost.CreateInstance, appHost.GetParseFn, requestType, attr.Path, attr.Verbs, attr.Summary);
+ var restPath = new RestPath(appHost.CreateInstance, appHost.GetParseFn, requestType, attr.Path, attr.Verbs, attr.IsHidden, attr.Summary, attr.Description);
RegisterRestPath(restPath);
}
diff --git a/Emby.Server.Implementations/Services/ServicePath.cs b/Emby.Server.Implementations/Services/ServicePath.cs
index df5d71374..0ca36df19 100644
--- a/Emby.Server.Implementations/Services/ServicePath.cs
+++ b/Emby.Server.Implementations/Services/ServicePath.cs
@@ -51,6 +51,8 @@ namespace Emby.Server.Implementations.Services
public string Path { get { return this.restPath; } }
public string Summary { get; private set; }
+ public string Description { get; private set; }
+ public bool IsHidden { get; private set; }
public int Priority { get; set; } //passed back to RouteAttribute
@@ -91,10 +93,12 @@ namespace Emby.Server.Implementations.Services
return list;
}
- public RestPath(Func<Type, object> createInstanceFn, Func<Type, Func<string, object>> getParseFn, Type requestType, string path, string verbs, string summary = null)
+ public RestPath(Func<Type, object> createInstanceFn, Func<Type, Func<string, object>> getParseFn, Type requestType, string path, string verbs, bool isHidden = false, string summary = null, string description = null)
{
this.RequestType = requestType;
this.Summary = summary;
+ this.IsHidden = isHidden;
+ this.Description = description;
this.restPath = path;
this.Verbs = string.IsNullOrWhiteSpace(verbs) ? ServiceExecExtensions.AllVerbs : verbs.ToUpper().Split(new[] { ' ', ',' }, StringSplitOptions.RemoveEmptyEntries);
diff --git a/Emby.Server.Implementations/Services/SwaggerService.cs b/Emby.Server.Implementations/Services/SwaggerService.cs
index 63cbb78dd..be3b4cbba 100644
--- a/Emby.Server.Implementations/Services/SwaggerService.cs
+++ b/Emby.Server.Implementations/Services/SwaggerService.cs
@@ -21,7 +21,7 @@ namespace Emby.Server.Implementations.Services
public string host { get; set; }
public string basePath { get; set; }
public SwaggerTag[] tags { get; set; }
- public Dictionary<string, Dictionary<string, SwaggerMethod>> paths { get; set; }
+ public IDictionary<string, Dictionary<string, SwaggerMethod>> paths { get; set; }
public Dictionary<string, SwaggerDefinition> definitions { get; set; }
}
@@ -147,16 +147,21 @@ namespace Emby.Server.Implementations.Services
return new Dictionary<string, SwaggerDefinition>();
}
- private Dictionary<string, Dictionary<string, SwaggerMethod>> GetPaths()
+ private IDictionary<string, Dictionary<string, SwaggerMethod>> GetPaths()
{
- var paths = new Dictionary<string, Dictionary<string, SwaggerMethod>>();
+ var paths = new SortedDictionary<string, Dictionary<string, SwaggerMethod>>();
- var all = ServiceController.Instance.RestPathMap.ToList();
+ var all = ServiceController.Instance.RestPathMap.OrderBy(i => i.Key, StringComparer.OrdinalIgnoreCase).ToList();
foreach (var current in all)
{
foreach (var info in current.Value)
{
+ if (info.IsHidden)
+ {
+ continue;
+ }
+
if (info.Path.StartsWith("/mediabrowser", StringComparison.OrdinalIgnoreCase))
{
continue;
@@ -191,6 +196,7 @@ namespace Emby.Server.Implementations.Services
result[verb.ToLower()] = new SwaggerMethod
{
summary = info.Summary,
+ description = info.Description,
produces = new[]
{
"application/json"
diff --git a/MediaBrowser.Api/PluginService.cs b/MediaBrowser.Api/PluginService.cs
index f6efe15e6..1eea89431 100644
--- a/MediaBrowser.Api/PluginService.cs
+++ b/MediaBrowser.Api/PluginService.cs
@@ -82,7 +82,7 @@ namespace MediaBrowser.Api
/// <summary>
/// Class GetPluginSecurityInfo
/// </summary>
- [Route("/Plugins/SecurityInfo", "GET", Summary = "Gets plugin registration information")]
+ [Route("/Plugins/SecurityInfo", "GET", Summary = "Gets plugin registration information", IsHidden = true)]
[Authenticated]
public class GetPluginSecurityInfo : IReturn<PluginSecurityInfo>
{
@@ -91,13 +91,13 @@ namespace MediaBrowser.Api
/// <summary>
/// Class UpdatePluginSecurityInfo
/// </summary>
- [Route("/Plugins/SecurityInfo", "POST", Summary = "Updates plugin registration information")]
+ [Route("/Plugins/SecurityInfo", "POST", Summary = "Updates plugin registration information", IsHidden = true)]
[Authenticated(Roles = "Admin")]
public class UpdatePluginSecurityInfo : PluginSecurityInfo, IReturnVoid
{
}
- [Route("/Plugins/RegistrationRecords/{Name}", "GET", Summary = "Gets registration status for a feature")]
+ [Route("/Plugins/RegistrationRecords/{Name}", "GET", Summary = "Gets registration status for a feature", IsHidden = true)]
[Authenticated]
public class GetRegistrationStatus
{
@@ -108,7 +108,7 @@ namespace MediaBrowser.Api
public string Mb2Equivalent { get; set; }
}
- [Route("/Registrations/{Name}", "GET", Summary = "Gets registration status for a feature")]
+ [Route("/Registrations/{Name}", "GET", Summary = "Gets registration status for a feature", IsHidden = true)]
[Authenticated]
public class GetRegistration : IReturn<RegistrationInfo>
{
@@ -116,7 +116,7 @@ namespace MediaBrowser.Api
public string Name { get; set; }
}
- [Route("/Appstore/Register", "POST", Summary = "Registers an appstore sale")]
+ [Route("/Appstore/Register", "POST", Summary = "Registers an appstore sale", IsHidden = true)]
[Authenticated]
public class RegisterAppstoreSale
{
diff --git a/MediaBrowser.Model/Services/RouteAttribute.cs b/MediaBrowser.Model/Services/RouteAttribute.cs
index 5a39688da..264500e60 100644
--- a/MediaBrowser.Model/Services/RouteAttribute.cs
+++ b/MediaBrowser.Model/Services/RouteAttribute.cs
@@ -88,6 +88,10 @@ namespace MediaBrowser.Model.Services
/// </summary>
public string Summary { get; set; }
+ public string Description { get; set; }
+
+ public bool IsHidden { get; set; }
+
/// <summary>
/// Gets or sets longer text to explain the behaviour of the route.
/// </summary>
diff --git a/MediaBrowser.WebDashboard/Api/DashboardService.cs b/MediaBrowser.WebDashboard/Api/DashboardService.cs
index c6bbca672..d4d0e281e 100644
--- a/MediaBrowser.WebDashboard/Api/DashboardService.cs
+++ b/MediaBrowser.WebDashboard/Api/DashboardService.cs
@@ -47,13 +47,13 @@ namespace MediaBrowser.WebDashboard.Api
public string Name { get; set; }
}
- [Route("/web/Package", "GET")]
+ [Route("/web/Package", "GET", IsHidden = true)]
public class GetDashboardPackage
{
public string Mode { get; set; }
}
- [Route("/robots.txt", "GET")]
+ [Route("/robots.txt", "GET", IsHidden = true)]
public class GetRobotsTxt
{
}
@@ -61,7 +61,7 @@ namespace MediaBrowser.WebDashboard.Api
/// <summary>
/// Class GetDashboardResource
/// </summary>
- [Route("/web/{ResourceName*}", "GET")]
+ [Route("/web/{ResourceName*}", "GET", IsHidden = true)]
public class GetDashboardResource
{
/// <summary>
@@ -76,7 +76,7 @@ namespace MediaBrowser.WebDashboard.Api
public string V { get; set; }
}
- [Route("/favicon.ico", "GET")]
+ [Route("/favicon.ico", "GET", IsHidden = true)]
public class GetFavIcon
{
}
diff --git a/SharedVersion.cs b/SharedVersion.cs
index 279897349..e851e6488 100644
--- a/SharedVersion.cs
+++ b/SharedVersion.cs
@@ -1,3 +1,3 @@
using System.Reflection;
-[assembly: AssemblyVersion("3.2.30.16")]
+[assembly: AssemblyVersion("3.2.30.17")]