Diagnostic
A message emitted by the generator.
struct DiagnosticA message emitted by the generator.
struct Diagnosticimport _OpenAPIGeneratorCoreInvoke the core logic of the Swift OpenAPI Generator tool and plugin.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol DecodableA type that can decode itself from an external representation.
protocol EncodableA type that can encode itself to an external representation.
protocol Error : SendableA type representing an error value that can be thrown.
protocol Escapableprotocol LocalizedError : ErrorDescribes an error that provides localized messages describing why an error occurred and provides more information about the error.
protocol Sendableinit(from decoder: any Decoder) throws static func error(message: String, location: Location? = nil, context: [String : String] = [:]) -> Diagnostic Creates a non-recoverable issue, which leads the generator to stop.
static func note(message: String, location: Location? = nil, context: [String : String] = [:]) -> Diagnostic Creates an informative message, which doesn’t represent an issue.
static func unsupported(_ feature: String, foundIn: String, location: Location? = nil, context: [String : String] = [:]) -> Diagnostic Creates a diagnostic for an unsupported feature.
static func unsupportedSchema(reason: String, schema: JSONSchema, foundIn: String, location: Location? = nil, context: [String : String] = [:]) -> Diagnostic Creates a diagnostic for an unsupported schema.
static func warning(message: String, location: Location? = nil, context: [String : String] = [:]) -> Diagnostic Creates a recoverable issue, which doesn’t prevent the generator from continuing.
var context: [String : String]Additional information about where the issue occurred.
var description: String { get }A textual representation of the diagnostic, including location, severity, message, and context.
var errorDescription: String? { get }A localized description of the diagnostic.
var location: Location?The source file that triggered the diagnostic.
var message: StringA user-friendly description of the diagnostic.
var severity: SeverityThe severity of the diagnostic.
struct LocationDescribes the source file that triggered a diagnostic.
enum SeverityDescribes the severity of a diagnostic.
var failureReason: String? { get }var helpAnchor: String? { get }var localizedDescription: String { get }Retrieve the localized description for this error.
var recoverySuggestion: String? { get }