added xml comments for existing api parts and pieces.

This commit is contained in:
StevanFreeborn
2022-06-21 17:17:32 -05:00
parent 19729f4cc7
commit 5e201182ba
9 changed files with 149 additions and 14 deletions
+27
View File
@@ -5,31 +5,58 @@ namespace server.Models
{
public class Character
{
/// <summary>
/// Identifier for the character.
/// </summary>
[BsonId]
[BsonRepresentation(BsonType.ObjectId)]
public string? Id { get; set; }
/// <summary>
/// The character's first name.
/// </summary>
[BsonElement("firstName")]
public string? FirstName { get; set; }
/// <summary>
/// The character's last name.
/// </summary>
[BsonElement("lastName")]
public string? LastName { get; set; }
/// <summary>
/// The first name of the actor who potrayed the character.
/// </summary>
[BsonElement("actorFirstName")]
public string? ActorFirstName { get; set; }
/// <summary>
/// The last name of the actor who potrayed the character.
/// </summary>
[BsonElement("actorLastName")]
public string? ActorLastName { get; set; }
/// <summary>
/// The seasons in which the character appeared.
/// </summary>
[BsonElement("seasons")]
public int[]? Seasons { get; set; }
/// <summary>
/// The first episode where the character appeared.
/// </summary>
[BsonElement("firstEpisode")]
public string? FirstEpisode { get; set; }
/// <summary>
/// The last episode where the character appeared.
/// </summary>
[BsonElement("lastEpisode")]
public string? LastEpisode { get; set; }
/// <summary>
/// A link to an image of the character.
/// </summary>
[BsonElement("image")]
public string? Image { get; set; }
}
+30
View File
@@ -5,35 +5,65 @@ namespace server.Models
{
public class Episode
{
/// <summary>
/// Identifier for the episode.
/// </summary>
[BsonId]
[BsonRepresentation(BsonType.ObjectId)]
public string? Id { get; set; }
/// <summary>
/// Season number for the episode.
/// </summary>
[BsonElement("season")]
public int? Season { get; set; }
/// <summary>
/// The episde number relative to the entire series.
/// </summary>
[BsonElement("numberInSeries")]
public int? NumberInSeries { get; set; }
/// <summary>
/// The episode number relative to its season.
/// </summary>
[BsonElement("numberInSeason")]
public int? NumberInSeason { get; set; }
/// <summary>
/// The title of the episode.
/// </summary>
[BsonElement("title")]
public string? Title { get; set; }
/// <summary>
/// A brief summary of the episode.
/// </summary>
[BsonElement("summary")]
public string? Summary { get; set; }
/// <summary>
/// The director of the episode.
/// </summary>
[BsonElement("directedBy")]
public string? DirectedBy { get; set; }
/// <summary>
/// The writer of the episode.
/// </summary>
[BsonElement("writtenBy")]
public string[]? WrittenBy { get; set; }
/// <summary>
/// Date the episode aired.
/// </summary>
[BsonElement("airDate")]
[BsonDateTimeOptions(DateOnly = true)]
public DateTime? AirDate { get; set; }
/// <summary>
/// Number of us viewers in millions for the episode.
/// </summary>
[BsonElement("usViewersInMillions")]
public double? UsViewersInMillions { get; set; }
+18
View File
@@ -5,22 +5,40 @@ namespace server.Models
{
public class Quote
{
/// <summary>
/// Identifier for the quote.
/// </summary>
[BsonId]
[BsonRepresentation(BsonType.ObjectId)]
public string? Id { get; set; }
/// <summary>
/// The season number during which the quote was said.
/// </summary>
[BsonElement("season")]
public int? Season { get; set; }
/// <summary>
/// The episode number during which the quote was said.
/// </summary>
[BsonElement("episode")]
public int Episode { get; set; }
/// <summary>
/// The quote text.
/// </summary>
[BsonElement("text")]
public string? Text { get; set; }
/// <summary>
/// The source of the quote.
/// </summary>
[BsonElement("source")]
public string? Source { get; set; }
/// <summary>
/// The narrator of the quote.
/// </summary>
[BsonElement("narrator")]
public string? Narrator { get; set; }
}
+15
View File
@@ -5,20 +5,35 @@ namespace server.Models
{
public class Season
{
/// <summary>
/// Identifier for the season.
/// </summary>
[BsonId]
[BsonRepresentation(BsonType.ObjectId)]
public string? Id { get; set; }
/// <summary>
/// The season number.
/// </summary>
[BsonElement("seasonNumber")]
public int? SeasonNumber { get; set; }
/// <summary>
/// The number of episodes in the season.
/// </summary>
[BsonElement("numberOfEpisodes")]
public int? NumberOfEpisodes { get; set; }
/// <summary>
/// The date the season first aired.
/// </summary>
[BsonElement("dateFirstAired")]
[BsonDateTimeOptions(DateOnly = true)]
public DateTime? DateFirstAired { get; set; }
/// <summary>
/// The date the season last aired.
/// </summary>
[BsonElement("dateLastAired")]
[BsonDateTimeOptions(DateOnly = true)]
public DateTime? DateLastAired { get; set; }