javier
37c0f3e322
This PR contains the work done to: * Documented all the `private`, `internal`, and `public` interfaces on the existing codebase; * Set the DocC documentation catalog in the project; * Written the main `Library` article for the DocC documentation catalog; * Added the documentation tasks in the `Makefile` file. Reviewed-on: #4 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
32 lines
1.0 KiB
Swift
32 lines
1.0 KiB
Swift
//===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the AmiiboService open source project
|
|
//
|
|
// Copyright (c) 2024-2025 Röck+Cöde VoF. and the AmiiboAPI project authors
|
|
// Licensed under the EUPL 1.2 or later.
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of AmiiboAPI project authors
|
|
//
|
|
//===----------------------------------------------------------------------===
|
|
|
|
/// 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.
|
|
case badRequest
|
|
/// A response cannot be decoded.
|
|
case decoding
|
|
/// An online service is not currently available.
|
|
case notAvailable
|
|
/// A response cannot be found.
|
|
case notFound
|
|
/// An undocumented/unsupported status code error.
|
|
case undocumented(_ statusCode: Int)
|
|
/// An unknown error.
|
|
case unknown
|
|
}
|
|
|
|
// MARK: - Equatable
|
|
|
|
extension AmiiboServiceError: Equatable {}
|