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

Improved the documentation throughout the library (#30)

Browse Source 
This PR contains the work done to improve the overall documentation effort throughout the library.

Reviewed-on: #30
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #30.
This commit is contained in:
javier
2026-09-14 10:13:41 +00:00
committed by javier
parent aa135cb04a
commit 44bfaca553
151 changed files with 304 additions and 286 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Errors/AmiiboServiceError.swift
+3 -1
View File
@@ -14,7 +14,7 @@
import Foundation
/// A representation of all the possible errors that the ``AmiiboService`` service could throw.
/// An error thrown by ``AmiiboService`` and ``AmiiboClient`` methods.
public enum AmiiboServiceError: Error {
/// The request was malformed or contained invalid filter parameters.
case badRequest
@@ -25,6 +25,8 @@ public enum AmiiboServiceError: Error {
/// The backend service is currently unreachable due to a network or server issue.
case notAvailable
/// No results were found matching the given filter criteria.
///
/// When no amiibos match, ``AmiiboService/getAmiibos(_:)`` returns an empty array instead of throwing this error.
case notFound
/// The server returned an undocumented HTTP status code.
case undocumented(_ statusCode: Int)