rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

Overall improvements and data update (#22)

Browse Source 
This PR contains the work done to update the live tests to the latest data plus lots of QoL improvements to the library, including:

* added test cases to test the ``AmiiboService` locally;
* conformed the models to the `Hashable` protocol;
* documented the use of caching with the `AmiiboService` service;
* updated the reference to the new AmiiboAPI url;
* updated the year on the copyrights and header files;
* updated the overall documentation of the source code and the package.

Reviewed-on: #22
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #22.
This commit is contained in:
Javier Cicchelli
2026-03-22 23:39:48 +00:00
committed by Javier Cicchelli
parent fae4b44698
commit 2b01ec14bf
375 changed files with 1177 additions and 700 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Errors/AmiiboServiceError.swift
+8 -8
View File
@@ -2,7 +2,7 @@
//
// This source file is part of the Amiibo Service open source project
//
// Copyright (c) 2025 Röck+Cöde VoF. and the Amiibo Service project authors
// Copyright (c) 2026 Röck+Cöde VoF. and the Amiibo Service project authors
// Licensed under Apache license v2.0
//
// See LICENSE for license information
@@ -14,19 +14,19 @@
/// A representation of all the possible errors that the ``AmiiboService`` service could throw.
public enum AmiiboServiceError: Error {
/// A bad request has been given to the client.
/// The request was malformed or contained invalid filter parameters.
case badRequest
/// A call to an endpoint has been cancelled by the user.
/// The request was cancelled before a response was received.
case cancelled
/// A response cannot be decoded.
/// The response body could not be decoded into the expected model.
case decoding
/// An online service is not currently available.
/// The backend service is currently unreachable due to a network or server issue.
case notAvailable
/// A response cannot be found.
/// No results were found matching the given filter criteria.
case notFound
/// An undocumented/unsupported status code error.
/// The server returned an undocumented HTTP status code.
case undocumented(_ statusCode: Int)
/// An unknown error.
/// An unexpected error that does not fall into any other category.
case unknown
}