Javier Cicchelli
c4a25afad4
This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers. To provide further details about the work done: - [x] restructured the hierarchy of some models that are related to the `Amiibo` model; - [x] written documentation for the `AmiiboService` service; - [x] written documentation for the `AmiiboFilter` and `KeyNameFilter` filters; - [x] written documentation for the `Amiibo`, `KeyName`, `LastUpdated` and children model; - [x] written documentation for the `AmiiboClientError` error; - [x] written documentation for the README file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #10
28 lines
781 B
Swift
28 lines
781 B
Swift
extension Amiibo {
|
|
/// This model structs represents a game that is related to an amiibo, when requested to the respective [remote API endpoint](https://www.amiiboapi.com/docs/#showGames).
|
|
public struct Game {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The list of identifiers associated to the game.
|
|
public let ids: [String]
|
|
|
|
/// The name of the game.
|
|
public let name: String
|
|
|
|
/// The list of usages that explains how the amiibo is being used in the game.
|
|
public let usage: [Usage]?
|
|
|
|
}
|
|
}
|
|
|
|
// MARK: - Decodable
|
|
|
|
extension Amiibo.Game: Decodable {
|
|
enum CodingKeys: String, CodingKey {
|
|
case ids = "gameID"
|
|
case name = "gameName"
|
|
case usage = "amiiboUsage"
|
|
}
|
|
}
|