Add OAS 3.2.0 defaultMapping field for Discriminator Object

Sources/OpenAPIKit/Discriminator.swift

@@ -0,0 +1,86 @@
+//
+//  Discriminator.swift
+//  
+//
+//  Created by Mathew Polzin on 10/6/19.
+//
+
+import OpenAPIKitCore
+
+extension OpenAPI {
+    /// OpenAPI Spec "Discriminator Object"
+    ///
+    /// See [OpenAPI Discriminator Object](https://spec.openapis.org/oas/v3.2.0.html#discriminator-object).
+    public struct Discriminator: HasConditionalWarnings, Sendable {
+        public let propertyName: String
+        public let mapping: OrderedDictionary<String, String>?
+        public let defaultMapping: String?
+
+        public let conditionalWarnings: [(any Condition, OpenAPI.Warning)]
+
+        public init(propertyName: String,
+                    mapping: OrderedDictionary<String, String>? = nil,
+                    defaultMapping: String? = nil) {
+            self.propertyName = propertyName
+            self.mapping = mapping
+            self.defaultMapping = defaultMapping
+
+            self.conditionalWarnings = [
+                nonNilVersionWarning(fieldName: "defaultMapping", value: defaultMapping, minimumVersion: .v3_2_0)
+            ].compactMap { $0 }
+        }
+    }
+}
+
+extension OpenAPI.Discriminator: Equatable {
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.propertyName == rhs.propertyName
+        && lhs.mapping == rhs.mapping
+        && lhs.defaultMapping == rhs.defaultMapping
+    }
+}
+
+fileprivate func nonNilVersionWarning<Subject>(fieldName: String, value: Subject?, minimumVersion: OpenAPI.Document.Version) -> (any Condition, OpenAPI.Warning)? {
+    value.map { _ in
+        OpenAPI.Document.ConditionalWarnings.version(
+            lessThan: minimumVersion,
+            doesNotSupport: "The Discriminator \(fieldName) field"
+        )
+    }
+}
+
+// MARK: - Codable
+
+extension OpenAPI.Discriminator: Encodable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(propertyName, forKey: .propertyName)
+        try container.encodeIfPresent(mapping, forKey: .mapping)
+        try container.encodeIfPresent(defaultMapping, forKey: .defaultMapping)
+    }
+}
+
+extension OpenAPI.Discriminator: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        propertyName = try container.decode(String.self, forKey: .propertyName)
+        mapping = try container.decodeIfPresent(OrderedDictionary<String, String>.self, forKey: .mapping)
+        defaultMapping = try container.decodeIfPresent(String.self, forKey: .defaultMapping)
+
+        conditionalWarnings = [
+            nonNilVersionWarning(fieldName: "defaultMapping", value: defaultMapping, minimumVersion: .v3_2_0)
+        ].compactMap { $0 }
+    }
+}
+
+extension OpenAPI.Discriminator {
+    private enum CodingKeys: String, CodingKey {
+        case propertyName
+        case mapping
+        case defaultMapping
+    }
+}
+
+extension OpenAPI.Discriminator: Validatable {}

Sources/OpenAPIKit/_CoreReExport.swift

@@ -22,7 +22,6 @@ public extension OpenAPI {
     typealias Warning = OpenAPIKitCore.Warning
     typealias Path = OpenAPIKitCore.Shared.Path
     typealias ComponentKey = OpenAPIKitCore.Shared.ComponentKey
-    typealias Discriminator = OpenAPIKitCore.Shared.Discriminator
     typealias CallbackURL = OpenAPIKitCore.Shared.CallbackURL
 }
 

Sources/OpenAPIKitCore/Shared/Discriminator.swift → Sources/OpenAPIKit30/Discriminator.swift

@@ -5,8 +5,10 @@
 //  Created by Mathew Polzin on 10/6/19.
 //
 
-extension Shared {
-    /// OpenAPI Spec "Disciminator Object"
+import OpenAPIKitCore
+
+extension OpenAPI {
+    /// OpenAPI Spec "Discriminator Object"
     ///
     /// See [OpenAPI Discriminator Object](https://spec.openapis.org/oas/v3.0.4.html#discriminator-object).
     public struct Discriminator: Equatable, Sendable {
@@ -23,7 +25,7 @@ extension Shared {
 
 // MARK: - Codable
 
-extension Shared.Discriminator: Encodable {
+extension OpenAPI.Discriminator: Encodable {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
 
@@ -32,7 +34,7 @@ extension Shared.Discriminator: Encodable {
     }
 }
 
-extension Shared.Discriminator: Decodable {
+extension OpenAPI.Discriminator: Decodable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
@@ -41,11 +43,11 @@ extension Shared.Discriminator: Decodable {
     }
 }
 
-extension Shared.Discriminator {
+extension OpenAPI.Discriminator {
     private enum CodingKeys: String, CodingKey {
         case propertyName
         case mapping
     }
 }
 
-extension Shared.Discriminator: Validatable {}
+extension OpenAPI.Discriminator: Validatable {}

Sources/OpenAPIKit30/_CoreReExport.swift

@@ -22,7 +22,6 @@ public extension OpenAPI {
     typealias Warning = OpenAPIKitCore.Warning
     typealias Path = OpenAPIKitCore.Shared.Path
     typealias ComponentKey = OpenAPIKitCore.Shared.ComponentKey
-    typealias Discriminator = OpenAPIKitCore.Shared.Discriminator
     typealias CallbackURL = OpenAPIKitCore.Shared.CallbackURL
 }
 

Sources/OpenAPIKitCompat/Compat30To31.swift

@@ -527,6 +527,12 @@ extension OpenAPIKit30.JSONTypeFormat: To31 {
     }
 }
 
+extension OpenAPIKit30.OpenAPI.Discriminator: To31 {
+    fileprivate func to31() -> OpenAPIKit.OpenAPI.Discriminator {
+        .init(propertyName: propertyName, mapping: mapping)
+    }
+}
+
 extension OpenAPIKit30.JSONSchema.CoreContext: To31 where Format: OpenAPIKit.OpenAPIFormat {
     fileprivate func to31() -> OpenAPIKit.JSONSchema.CoreContext<Format> {
         OpenAPIKit.JSONSchema.CoreContext<Format>(
@@ -537,7 +543,7 @@ extension OpenAPIKit30.JSONSchema.CoreContext: To31 where Format: OpenAPIKit.Ope
             deprecated: deprecated,
             title: title,
             description: description,
-            discriminator: discriminator,
+            discriminator: discriminator?.to31(),
             externalDocs: externalDocs?.to31(),
             allowedValues: allowedValues,
             defaultValue: defaultValue,
@@ -557,7 +563,7 @@ extension OpenAPIKit30.JSONSchema.CoreContext where Format == OpenAPIKit30.JSONT
             deprecated: deprecated,
             title: title,
             description: description,
-            discriminator: discriminator,
+            discriminator: discriminator?.to31(),
             externalDocs: externalDocs?.to31(),
             allowedValues: allowedValues,
             defaultValue: defaultValue,

Tests/OpenAPIKitCompatTests/DocumentConversionTests.swift

@@ -1210,7 +1210,7 @@ fileprivate func assertEqualNewToOld(_ newCoreContext: OpenAPIKit.JSONSchemaCont
     XCTAssertEqual(newCoreContext.nullable, oldCoreContext.nullable)
     XCTAssertEqual(newCoreContext.title, oldCoreContext.title)
     XCTAssertEqual(newCoreContext.description, oldCoreContext.description)
-    XCTAssertEqual(newCoreContext.discriminator, oldCoreContext.discriminator)
+    try assertEqualNewToOld(newCoreContext.discriminator, oldCoreContext.discriminator)
     try assertEqualNewToOld(newCoreContext.externalDocs, oldCoreContext.externalDocs)
     XCTAssertEqual(newCoreContext.allowedValues, oldCoreContext.allowedValues)
     XCTAssertEqual(newCoreContext.defaultValue, oldCoreContext.defaultValue)
@@ -1278,6 +1278,11 @@ fileprivate func assertEqualNewToOld(_ newStyle: OpenAPIKit.OpenAPI.Parameter.Sc
     }
 }
 
+fileprivate func assertEqualNewToOld(_ newDiscriminator: OpenAPIKit.OpenAPI.Discriminator?, _ oldDiscriminator: OpenAPIKit30.OpenAPI.Discriminator?) throws {
+    XCTAssertEqual(newDiscriminator?.mapping, oldDiscriminator?.mapping)
+    XCTAssertEqual(newDiscriminator?.propertyName, oldDiscriminator?.propertyName)
+}
+
 fileprivate func assertEqualNewToOld(_ newHeader: OpenAPIKit.OpenAPI.Header, _ oldHeader: OpenAPIKit30.OpenAPI.Header) throws {
     XCTAssertEqual(newHeader.description, oldHeader.description)
     XCTAssertEqual(newHeader.required, oldHeader.required)

Tests/OpenAPIKitTests/DiscriminatorTests.swift

@@ -14,11 +14,21 @@ final class DiscriminatorTests: XCTestCase {
         let t1 = OpenAPI.Discriminator(propertyName: "hello world")
         XCTAssertEqual(t1.propertyName, "hello world")
         XCTAssertNil(t1.mapping)
+        XCTAssertEqual(t1.conditionalWarnings.count, 0)
 
         let t2 = OpenAPI.Discriminator(propertyName: "hello world",
                                        mapping: ["hello": "world"])
         XCTAssertEqual(t2.propertyName, "hello world")
         XCTAssertEqual(t2.mapping, ["hello": "world"])
+        XCTAssertEqual(t2.conditionalWarnings.count, 0)
+
+        let t3 = OpenAPI.Discriminator(propertyName: "hello world",
+                                       mapping: ["hello": "world"],
+                                       defaultMapping: "world")
+        XCTAssertEqual(t3.propertyName, "hello world")
+        XCTAssertEqual(t3.mapping, ["hello": "world"])
+        XCTAssertEqual(t3.defaultMapping, "world")
+        XCTAssertEqual(t3.conditionalWarnings.count, 1)
     }
 }
 
@@ -85,4 +95,35 @@ extension DiscriminatorTests {
         XCTAssertEqual(discriminator, OpenAPI.Discriminator(propertyName: "hello",
                                                             mapping: [ "hello": "world"]))
     }
+
+    func test_withDefaultMapping_encode() {
+        let discriminator = OpenAPI.Discriminator(propertyName: "hello",
+                                                  defaultMapping: "world")
+        let encodedDiscriminator = try! orderUnstableTestStringFromEncoding(of: discriminator)
+
+        assertJSONEquivalent(
+            encodedDiscriminator,
+            """
+            {
+              "defaultMapping" : "world",
+              "propertyName" : "hello"
+            }
+            """
+        )
+    }
+
+    func test_withDefaultMapping_decode() {
+        let discriminatorData =
+        """
+        {
+            "defaultMapping" : "world",
+            "propertyName": "hello",
+        }
+        """.data(using: .utf8)!
+
+        let discriminator = try! orderUnstableDecode(OpenAPI.Discriminator.self, from: discriminatorData)
+
+        XCTAssertEqual(discriminator, OpenAPI.Discriminator(propertyName: "hello",
+                                                            defaultMapping: "world"))
+    }
 }