浏览代码

added some attributes for api docs

LukePulverenti 12 年之前
父节点
当前提交
8141c777c3
共有 3 个文件被更改,包括 6 次插入3 次删除
  1. 0 1
      MediaBrowser.Api/PluginService.cs
  2. 4 2
      MediaBrowser.Api/UserService.cs
  3. 2 0
      MediaBrowser.Api/WeatherService.cs

+ 0 - 1
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;

+ 4 - 2
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.
         /// </summary>
         /// <value>The id.</value>
+        [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.
         /// </summary>
         /// <value>The id.</value>
+        [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.
         /// </summary>
         /// <value>The id.</value>
+        [ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
         public Guid Id { get; set; }
 
         /// <summary>
         /// Gets or sets the password.
         /// </summary>
         /// <value>The password.</value>
+        [ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "GET")]
         public string Password { get; set; }
     }
 

+ 2 - 0
MediaBrowser.Api/WeatherService.cs

@@ -11,12 +11,14 @@ namespace MediaBrowser.Api
     /// Class Weather
     /// </summary>
     [Route("/Weather", "GET")]
+    [ServiceStack.ServiceHost.Api(Description = "Gets weather information for a given location")]
     public class GetWeather : IReturn<WeatherInfo>
     {
         /// <summary>
         /// Gets or sets the location.
         /// </summary>
         /// <value>The location.</value>
+        [ApiMember(Name = "Location", Description = "Us zip / City, State, Country / City, Country", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
         public string Location { get; set; }
     }