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
8 lines
468 B
Swift
8 lines
468 B
Swift
/// This error definitions represents any error happening while the client makes a request to the remote API and handles the respective response, excluding the decoding of the retrieved data into a particular model.
|
|
public enum AmiiboClientError: Error {
|
|
/// The status code of the response is not the expected one, which is `.ok` (`200`).
|
|
case responseCode(Int)
|
|
/// The status code of the response was not received at all.
|
|
case responseCodeNotFound
|
|
}
|