diff options
Diffstat (limited to 'MediaBrowser.Api/PluginService.cs')
| -rw-r--r-- | MediaBrowser.Api/PluginService.cs | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/MediaBrowser.Api/PluginService.cs b/MediaBrowser.Api/PluginService.cs index 847478beb..3f4146020 100644 --- a/MediaBrowser.Api/PluginService.cs +++ b/MediaBrowser.Api/PluginService.cs @@ -19,6 +19,7 @@ namespace MediaBrowser.Api /// Class Plugins /// </summary> [Route("/Plugins", "GET")] + [ServiceStack.ServiceHost.Api(("Gets a list of currently installed plugins"))] public class GetPlugins : IReturn<List<PluginInfo>> { } @@ -27,12 +28,14 @@ namespace MediaBrowser.Api /// Class GetPluginAssembly /// </summary> [Route("/Plugins/{Id}/Assembly", "GET")] + [ServiceStack.ServiceHost.Api(("Gets a plugin assembly file"))] public class GetPluginAssembly { /// <summary> /// Gets or sets the id. /// </summary> /// <value>The id.</value> + [ApiMember(Name = "Id", Description = "Plugin Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -40,12 +43,14 @@ namespace MediaBrowser.Api /// Class UninstallPlugin /// </summary> [Route("/Plugins/{Id}", "DELETE")] + [ServiceStack.ServiceHost.Api(("Uninstalls a plugin"))] public class UninstallPlugin : IReturnVoid { /// <summary> /// Gets or sets the id. /// </summary> /// <value>The id.</value> + [ApiMember(Name = "Id", Description = "Plugin Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")] public Guid Id { get; set; } } @@ -53,12 +58,14 @@ namespace MediaBrowser.Api /// Class GetPluginConfiguration /// </summary> [Route("/Plugins/{Id}/Configuration", "GET")] + [ServiceStack.ServiceHost.Api(("Gets a plugin's configuration"))] public class GetPluginConfiguration { /// <summary> /// Gets or sets the id. /// </summary> /// <value>The id.</value> + [ApiMember(Name = "Id", Description = "Plugin Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -66,12 +73,14 @@ namespace MediaBrowser.Api /// Class UpdatePluginConfiguration /// </summary> [Route("/Plugins/{Id}/Configuration", "POST")] + [ServiceStack.ServiceHost.Api(("Updates a plugin's configuration"))] public class UpdatePluginConfiguration : IRequiresRequestStream, IReturnVoid { /// <summary> /// Gets or sets the id. /// </summary> /// <value>The id.</value> + [ApiMember(Name = "Id", Description = "Plugin Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] public Guid Id { get; set; } /// <summary> @@ -85,12 +94,14 @@ namespace MediaBrowser.Api /// Class GetPluginConfigurationFile /// </summary> [Route("/Plugins/{Id}/ConfigurationFile", "GET")] + [ServiceStack.ServiceHost.Api(("Gets a plugin's configuration file, in plain text"))] public class GetPluginConfigurationFile { /// <summary> /// Gets or sets the id. /// </summary> /// <value>The id.</value> + [ApiMember(Name = "Id", Description = "Plugin Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -98,6 +109,7 @@ namespace MediaBrowser.Api /// Class GetPluginSecurityInfo /// </summary> [Route("/Plugins/SecurityInfo", "GET")] + [ServiceStack.ServiceHost.Api(("Gets plugin registration information"))] public class GetPluginSecurityInfo : IReturn<PluginSecurityInfo> { } @@ -106,6 +118,7 @@ namespace MediaBrowser.Api /// Class UpdatePluginSecurityInfo /// </summary> [Route("/Plugins/SecurityInfo", "POST")] + [ServiceStack.ServiceHost.Api(("Updates plugin registration information"))] public class UpdatePluginSecurityInfo : PluginSecurityInfo, IReturnVoid { } |