Javier Cicchelli 629aaf10a0 [Improvement] Codable models (#20)
This PR contains the work done to make all the public models to conform to the `Codable` protocol. Of course, this work required the Xcode and the Web documentations to be regenerated.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #20
2023-07-23 14:40:24 +00:00

51 lines
1.4 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the AmiiboService open source project
//
// Copyright (c) 2023 Röck+Cöde VoF. and the AmiiboService project authors
// Licensed under the EUPL 1.2 or later.
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of AmiiboService project authors
//
//===----------------------------------------------------------------------===//
extension DTO {
/// This model is a concrete genetic definition that represents the following models: ``AmiiboSeries``, ``AmiiboType``, ``Character`` and ``GameSeries``.
public struct KeyName {
// MARK: Properties
/// The key of the model.
public let key: String
/// The name of the model.
public let name: String
}
}
// MARK: - Type aliases
extension DTO {
/// This model represents the series an amiibo belongs to.
public typealias AmiiboSeries = DTO.KeyName
/// This model represents the type an amiibo belongs to.
public typealias AmiiboType = KeyName
/// This model represents the character an amiibo is associated to.
public typealias Character = KeyName
/// This model represents the games series an amiibo is associated to.
public typealias GameSeries = KeyName
}
// MARK: - Codable
extension DTO.KeyName: Codable {}