javier
b14a9fa816
This PR contains the work done to improve the documentation efforts in the package, aiming at improving the documentation of the source code as well as the OpenAPI specification document. In addition, a breaking bug has been fixed. Reviewed-on: #16 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
35 lines
1.4 KiB
Swift
35 lines
1.4 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the DiscogsService open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the DiscogsService project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of DiscogsService project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
/// A protocol that defines an input validation rule to be applied to an input by the ``ValidateInputUseCase`` use case.
|
|
protocol InputValidationRule {
|
|
|
|
// MARK: Functions
|
|
|
|
#if swift(>=6.0)
|
|
/// Validates a given input against a validation rule.
|
|
/// - Parameter input: An input to be validated.
|
|
/// - Returns: A flag that indicates whether an input has been validated or not.
|
|
/// - Throws: An error of type ``InputValidationError`` in case a given input failed a validation.
|
|
@discardableResult func validate(_ input: String?) throws(InputValidationError) -> Bool
|
|
#else
|
|
/// Validates a given input against a validation rule.
|
|
/// - Parameter input: An input to be validated.
|
|
/// - Returns: A flag that indicates whether an input has been validated or not.
|
|
/// - Throws: An error of type ``InputValidationError`` in case a given input failed a validation.
|
|
@discardableResult func validate(_ input: String?) throws -> Bool
|
|
#endif
|
|
|
|
}
|