From 8141c777c3db8ba09e8f628e60d69644c25a3156 Mon Sep 17 00:00:00 2001 From: LukePulverenti Date: Tue, 5 Mar 2013 00:08:27 -0500 Subject: [PATCH] added some attributes for api docs --- MediaBrowser.Api/PluginService.cs | 1 - MediaBrowser.Api/UserService.cs | 6 ++++-- MediaBrowser.Api/WeatherService.cs | 2 ++ 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/MediaBrowser.Api/PluginService.cs b/MediaBrowser.Api/PluginService.cs index 9409b9d0e9..bec6835e0b 100644 --- a/MediaBrowser.Api/PluginService.cs +++ b/MediaBrowser.Api/PluginService.cs @@ -2,7 +2,6 @@ using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Implementations.HttpServer; using MediaBrowser.Common.Security; -using MediaBrowser.Controller; using MediaBrowser.Controller.Updates; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Plugins; diff --git a/MediaBrowser.Api/UserService.cs b/MediaBrowser.Api/UserService.cs index a2618c43c1..abf07f9244 100644 --- a/MediaBrowser.Api/UserService.cs +++ b/MediaBrowser.Api/UserService.cs @@ -1,6 +1,5 @@ using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Implementations.HttpServer; -using MediaBrowser.Controller; using MediaBrowser.Controller.Library; using MediaBrowser.Model.Dto; using MediaBrowser.Model.Serialization; @@ -8,7 +7,6 @@ using ServiceStack.ServiceHost; using ServiceStack.Text.Controller; using System; using System.Collections.Generic; -using System.IO; using System.Linq; using System.Threading.Tasks; @@ -32,6 +30,7 @@ namespace MediaBrowser.Api /// Gets or sets the id. /// /// The id. + [ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -45,6 +44,7 @@ namespace MediaBrowser.Api /// Gets or sets the id. /// /// The id. + [ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -58,12 +58,14 @@ namespace MediaBrowser.Api /// Gets or sets the id. /// /// The id. + [ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } /// /// Gets or sets the password. /// /// The password. + [ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "GET")] public string Password { get; set; } } diff --git a/MediaBrowser.Api/WeatherService.cs b/MediaBrowser.Api/WeatherService.cs index 7c85d849d7..d719511826 100644 --- a/MediaBrowser.Api/WeatherService.cs +++ b/MediaBrowser.Api/WeatherService.cs @@ -11,12 +11,14 @@ namespace MediaBrowser.Api /// Class Weather /// [Route("/Weather", "GET")] + [ServiceStack.ServiceHost.Api(Description = "Gets weather information for a given location")] public class GetWeather : IReturn { /// /// Gets or sets the location. /// /// The location. + [ApiMember(Name = "Location", Description = "Us zip / City, State, Country / City, Country", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] public string Location { get; set; } }