diff options
Diffstat (limited to 'MediaBrowser.Api/Images/ImageRequest.cs')
| -rw-r--r-- | MediaBrowser.Api/Images/ImageRequest.cs | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/MediaBrowser.Api/Images/ImageRequest.cs b/MediaBrowser.Api/Images/ImageRequest.cs index ab10a6263..1c11f527d 100644 --- a/MediaBrowser.Api/Images/ImageRequest.cs +++ b/MediaBrowser.Api/Images/ImageRequest.cs @@ -1,4 +1,5 @@ using MediaBrowser.Model.Entities; +using ServiceStack.ServiceHost; namespace MediaBrowser.Api.Images { @@ -10,28 +11,39 @@ namespace MediaBrowser.Api.Images /// <summary> /// The max width /// </summary> + [ApiMember(Name = "MaxWidth", Description = "The maximum image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] public int? MaxWidth { get; set; } + /// <summary> /// The max height /// </summary> + [ApiMember(Name = "MaxHeight", Description = "The maximum image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] public int? MaxHeight { get; set; } + /// <summary> /// The width /// </summary> + [ApiMember(Name = "Width", Description = "The fixed image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] public int? Width { get; set; } + /// <summary> /// The height /// </summary> + [ApiMember(Name = "Height", Description = "The fixed image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] public int? Height { get; set; } + /// <summary> /// Gets or sets the quality. /// </summary> /// <value>The quality.</value> + [ApiMember(Name = "Quality", Description = "Optional quality setting, from 0-100. Defaults to 90 and should suffice in most cases.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] public int? Quality { get; set; } + /// <summary> /// Gets or sets the tag. /// </summary> /// <value>The tag.</value> + [ApiMember(Name = "Tag", Description = "Optional. Supply the cache tag from the item object to receive strong caching headers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] public string Tag { get; set; } } @@ -44,11 +56,18 @@ namespace MediaBrowser.Api.Images /// Gets or sets the type of the image. /// </summary> /// <value>The type of the image.</value> + [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] + [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] + [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")] public ImageType Type { get; set; } + /// <summary> /// Gets or sets the index. /// </summary> /// <value>The index.</value> + [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] + [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")] + [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "DELETE")] public int? Index { get; set; } } } |