michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

added some attributes for api docs

Browse Source
This commit is contained in:
LukePulverenti 2013-03-05 00:08:27 -05:00
parent 176d090164
commit 8141c777c3
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
MediaBrowser.Api/PluginService.cs
View File

@ -2,7 +2,6 @@
using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Implementations.HttpServer; using MediaBrowser.Common.Implementations.HttpServer;
using MediaBrowser.Common.Security; using MediaBrowser.Common.Security;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Updates; using MediaBrowser.Controller.Updates;
using MediaBrowser.Model.Entities; using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Plugins; using MediaBrowser.Model.Plugins;

6
MediaBrowser.Api/UserService.cs
View File

@ -1,6 +1,5 @@
using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Implementations.HttpServer; using MediaBrowser.Common.Implementations.HttpServer;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Library;
using MediaBrowser.Model.Dto; using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Serialization; using MediaBrowser.Model.Serialization;
@ -8,7 +7,6 @@ using ServiceStack.ServiceHost;
using ServiceStack.Text.Controller; using ServiceStack.Text.Controller;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO;
using System.Linq; using System.Linq;
using System.Threading.Tasks; using System.Threading.Tasks;
@ -32,6 +30,7 @@ namespace MediaBrowser.Api
/// Gets or sets the id. /// Gets or sets the id.
/// </summary> /// </summary>
/// <value>The id.</value> /// <value>The id.</value>
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public Guid Id { get; set; } public Guid Id { get; set; }
} }
@ -45,6 +44,7 @@ namespace MediaBrowser.Api
/// Gets or sets the id. /// Gets or sets the id.
/// </summary> /// </summary>
/// <value>The id.</value> /// <value>The id.</value>
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public Guid Id { get; set; } public Guid Id { get; set; }
} }
@ -58,12 +58,14 @@ namespace MediaBrowser.Api
/// Gets or sets the id. /// Gets or sets the id.
/// </summary> /// </summary>
/// <value>The id.</value> /// <value>The id.</value>
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public Guid Id { get; set; } public Guid Id { get; set; }
/// <summary> /// <summary>
/// Gets or sets the password. /// Gets or sets the password.
/// </summary> /// </summary>
/// <value>The password.</value> /// <value>The password.</value>
[ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "GET")]
public string Password { get; set; } public string Password { get; set; }
} }

2
MediaBrowser.Api/WeatherService.cs
View File

@ -11,12 +11,14 @@ namespace MediaBrowser.Api
/// Class Weather /// Class Weather
/// </summary> /// </summary>
[Route("/Weather", "GET")] [Route("/Weather", "GET")]
[ServiceStack.ServiceHost.Api(Description = "Gets weather information for a given location")]
public class GetWeather : IReturn<WeatherInfo> public class GetWeather : IReturn<WeatherInfo>
{ {
/// <summary> /// <summary>
/// Gets or sets the location. /// Gets or sets the location.
/// </summary> /// </summary>
/// <value>The location.</value> /// <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; } public string Location { get; set; }
} }