Merge pull request #408 from mattpolzin/update-error-phrasing

Update inconsistency error to be better suited to general use

Author: mattpolzin

Sources/OpenAPIKit/CodableVendorExtendable.swift

@@ -111,7 +111,7 @@ extension CodableVendorExtendable {
         let invalidKeys = extensions.keys.filter { !$0.lowercased().starts(with: "x-") }
         if !invalidKeys.isEmpty {
             let invalidKeysList = "[ " + invalidKeys.joined(separator: ", ") + " ]"
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: "Vendor Extension",
                 details: "Found at least one vendor extension property that does not begin with the required 'x-' prefix. Invalid properties: \(invalidKeysList)",
                 codingPath: decoder.codingPath

Sources/OpenAPIKit/Components Object/Components.swift

@@ -220,7 +220,7 @@ extension OpenAPI.Components: Decodable {
             vendorExtensions = try Self.extensions(from: decoder)
         } catch let error as DecodingError {
             if let underlyingError = error.underlyingError as? KeyDecodingError {
-                throw InconsistencyError(
+                throw GenericError(
                     subjectName: error.subjectName,
                     details: underlyingError.localizedDescription,
                     codingPath: error.codingPath

Sources/OpenAPIKit/Content/Content.swift

@@ -172,7 +172,7 @@ extension OpenAPI.Content: Decodable {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         guard !(container.contains(.examples) && container.contains(.example)) else {
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: "Example and Examples",
                 details: "Only one of `example` and `examples` is allowed in the Media Type Object (`OpenAPI.Content`).",
                 codingPath: container.codingPath

Sources/OpenAPIKit/Document/Document.swift

@@ -538,7 +538,7 @@ extension OpenAPI.Document: Decodable {
         } catch let error as OpenAPI.Error.Decoding.Path {
 
             throw OpenAPI.Error.Decoding.Document(error)
-        } catch let error as InconsistencyError {
+        } catch let error as GenericError {
 
             throw OpenAPI.Error.Decoding.Document(error)
         } catch let error as DecodingError {
@@ -679,7 +679,7 @@ internal func decodeSecurityRequirements<CodingKeys: CodingKey>(from container:
                     return (try? components.contains(ref)) ?? false
                 }
                 guard securityKeysAndValues.map({ $0.key }).allSatisfy(foundInComponents) else {
-                    throw InconsistencyError(
+                    throw GenericError(
                         subjectName: key.stringValue,
                         details: "Each key found in a Security Requirement dictionary must refer to a Security Scheme present in the Components dictionary",
                         codingPath: container.codingPath + [key]
@@ -728,7 +728,7 @@ internal func validate(securityRequirements: [OpenAPI.SecurityRequirement], at p
             ]
             .map(AnyCodingKey.init(stringValue:))
 
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: schemeKey,
                 details: "Each key found in a Security Requirement dictionary must refer to a Security Scheme present in the Components dictionary",
                 codingPath: keys

Sources/OpenAPIKit/Encoding and Decoding Errors/DocumentDecodingError.swift

@@ -14,7 +14,7 @@ extension OpenAPI.Error.Decoding {
 
         public enum Context: Sendable {
             case path(Path)
-            case inconsistency(InconsistencyError)
+            case inconsistency(GenericError)
             case other(Swift.DecodingError)
             case neither(EitherDecodeNoTypesMatchedError)
         }
@@ -82,7 +82,7 @@ extension OpenAPI.Error.Decoding.Document {
         codingPath = error.codingPath
     }
 
-    internal init(_ error: InconsistencyError) {
+    internal init(_ error: GenericError) {
         context = .inconsistency(error)
         codingPath = error.codingPath
     }
@@ -107,7 +107,7 @@ extension OpenAPI.Error.Decoding.Document: DiggingError {
     public init(unwrapping error: Swift.DecodingError) {
         if let decodingError = error.underlyingError as? Swift.DecodingError {
             self = Self(unwrapping: decodingError)
-        } else if let inconsistencyError = error.underlyingError as? InconsistencyError {
+        } else if let inconsistencyError = error.underlyingError as? GenericError {
             self = Self(inconsistencyError)
         } else if let pathError = error.underlyingError as? OpenAPI.Error.Decoding.Path {
             self = Self(pathError)

Sources/OpenAPIKit/Encoding and Decoding Errors/OperationDecodingError.swift

@@ -16,7 +16,7 @@ extension OpenAPI.Error.Decoding {
         public enum Context: Sendable {
             case request(Request)
             case response(Response)
-            case inconsistency(InconsistencyError)
+            case inconsistency(GenericError)
             case other(Swift.DecodingError)
             case neither(EitherDecodeNoTypesMatchedError)
         }
@@ -95,7 +95,7 @@ extension OpenAPI.Error.Decoding.Operation {
         relativeCodingPath = Array(codingPath)
     }
 
-    internal init(_ error: InconsistencyError) {
+    internal init(_ error: GenericError) {
         var codingPath = error.codingPath.dropFirst(2)
         // this part of the coding path is structurally guaranteed to be an HTTP verb.
         let verb = OpenAPI.HttpMethod(rawValue: codingPath.removeFirst().stringValue.uppercased())!
@@ -139,7 +139,7 @@ extension OpenAPI.Error.Decoding.Operation: DiggingError {
             self = Self(responseError)
         } else if let responseError = error.underlyingError as? OpenAPI.Error.Decoding.Response {
             self = Self(responseError)
-        } else if let inconsistencyError = error.underlyingError as? InconsistencyError {
+        } else if let inconsistencyError = error.underlyingError as? GenericError {
             self = Self(inconsistencyError)
         } else if let eitherError = error.underlyingError as? EitherDecodeNoTypesMatchedError {
             self = Self(eitherError)

Sources/OpenAPIKit/Encoding and Decoding Errors/PathDecodingError.swift

@@ -15,7 +15,7 @@ extension OpenAPI.Error.Decoding {
 
         public enum Context: Sendable {
             case endpoint(Operation)
-            case inconsistency(InconsistencyError)
+            case inconsistency(GenericError)
             case other(Swift.DecodingError)
             case neither(EitherDecodeNoTypesMatchedError)
         }
@@ -120,7 +120,7 @@ extension OpenAPI.Error.Decoding.Path {
         relativeCodingPath = Array(codingPath)
     }
 
-    internal init(_ error: InconsistencyError) {
+    internal init(_ error: GenericError) {
         var codingPath = error.codingPath.dropFirst()
         let route = OpenAPI.Path(rawValue: codingPath.removeFirst().stringValue)
 
@@ -165,7 +165,7 @@ extension OpenAPI.Error.Decoding.Path {
 //    public init(unwrapping error: Swift.DecodingError) {
 //        if let decodingError = error.underlyingError as? Swift.DecodingError {
 //            self = Self(unwrapping: decodingError)
-//        } else if let inconsistencyError = error.underlyingError as? InconsistencyError {
+//        } else if let inconsistencyError = error.underlyingError as? GenericError {
 //            self = Self(inconsistencyError)
 //        } else if let eitherError = error.underlyingError as? EitherDecodeNoTypesMatchedError {
 //            self = Self(eitherError)

Sources/OpenAPIKit/Encoding and Decoding Errors/ResponseDecodingError.swift

@@ -14,7 +14,7 @@ extension OpenAPI.Error.Decoding {
         internal let relativeCodingPath: [CodingKey]
 
         public enum Context: Sendable {
-            case inconsistency(InconsistencyError)
+            case inconsistency(GenericError)
             case other(Swift.DecodingError)
             case neither(EitherDecodeNoTypesMatchedError)
         }
@@ -68,7 +68,7 @@ extension OpenAPI.Error.Decoding.Response {
         return Array(path.dropFirst(responsesIndex.advanced(by: 1)))
     }
 
-    internal init(_ error: InconsistencyError) {
+    internal init(_ error: GenericError) {
         var codingPath = Self.relativePath(from: error.codingPath)
         let code = codingPath.removeFirst().stringValue.lowercased()
 
@@ -114,7 +114,7 @@ extension OpenAPI.Error.Decoding.Response: DiggingError {
     public init(unwrapping error: Swift.DecodingError) {
         if let decodingError = error.underlyingError as? Swift.DecodingError {
             self = Self(unwrapping: decodingError)
-        } else if let inconsistencyError = error.underlyingError as? InconsistencyError {
+        } else if let inconsistencyError = error.underlyingError as? GenericError {
             self = Self(inconsistencyError)
         } else if let eitherError = error.underlyingError as? EitherDecodeNoTypesMatchedError {
             self = Self(eitherError)

Sources/OpenAPIKit/Example.swift

@@ -117,7 +117,7 @@ extension OpenAPI.Example: Decodable {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         guard !(container.contains(.externalValue) && container.contains(.value)) else {
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: "example value",
                 details: "Found both `value` and `externalValue` keys in an Example. You must specify one or the other.",
                 codingPath: container.codingPath

Sources/OpenAPIKit/Header/Header.swift

@@ -316,13 +316,13 @@ extension OpenAPI.Header: Decodable {
         case (nil, let schema?):
             schemaOrContent = .init(schema)
         case (nil, nil):
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: "Header",
                 details: "A header parameter must specify either `content` or `schema`",
                 codingPath: decoder.codingPath
             )
         case (_, _):
-            throw InconsistencyError(
+            throw GenericError(
                 subjectName: "Header",
                 details: "A header must specify one but not both `content` and `schema`",
                 codingPath: decoder.codingPath