43 lines
1.5 KiB
C#
43 lines
1.5 KiB
C#
using System.Collections.Generic;
|
|
using System.Collections.ObjectModel;
|
|
using System.Net.Http.Headers;
|
|
using System.Web.Http.Description;
|
|
|
|
namespace HRMobileAPI.Areas.HelpPage.Models
|
|
{
|
|
/// <summary>
|
|
/// The model that represents an API displayed on the help page.
|
|
/// </summary>
|
|
public class HelpPageApiModel
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="HelpPageApiModel"/> class.
|
|
/// </summary>
|
|
public HelpPageApiModel()
|
|
{
|
|
SampleRequests = new Dictionary<MediaTypeHeaderValue, object>();
|
|
SampleResponses = new Dictionary<MediaTypeHeaderValue, object>();
|
|
ErrorMessages = new Collection<string>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the <see cref="ApiDescription"/> that describes the API.
|
|
/// </summary>
|
|
public ApiDescription ApiDescription { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets the sample requests associated with the API.
|
|
/// </summary>
|
|
public IDictionary<MediaTypeHeaderValue, object> SampleRequests { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the sample responses associated with the API.
|
|
/// </summary>
|
|
public IDictionary<MediaTypeHeaderValue, object> SampleResponses { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the error messages associated with this model.
|
|
/// </summary>
|
|
public Collection<string> ErrorMessages { get; private set; }
|
|
}
|
|
} |