From 7a6d65a290ddb4eebd3c45197acc245f45c06b32 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sun, 23 Apr 2023 14:12:30 +0200 Subject: [PATCH] Written the documentation for the Usage model. --- Sources/Models/Usage.swift | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Sources/Models/Usage.swift b/Sources/Models/Usage.swift index 7d54439..5b55dab 100644 --- a/Sources/Models/Usage.swift +++ b/Sources/Models/Usage.swift @@ -1,6 +1,14 @@ +/// This model struct represents how an amiibo is used with a particular game, when requested to the respective [remote API endpoint](https://www.amiiboapi.com/docs/#showUsage). public struct Usage { + + // MARK: Properties + + /// The explanation on how an amiibo is being used with a particular game. public let explanation: String + + /// A flag that indicates whether an amiibo is only read-only or the game can also write information to the amiibo. public let isWritable: Bool + } // MARK: - Decodable