Support setting vendor extensions including on JSON Schemas and carry through external dereference process

Author: mattpolzin

Sources/OpenAPIKit30/CodableVendorExtendable.swift

@@ -18,7 +18,7 @@ public protocol VendorExtendable {
     /// These should be of the form:
     /// `[ "x-extensionKey": <anything>]`
     /// where the values are anything codable.
-    var vendorExtensions: VendorExtensions { get }
+    var vendorExtensions: VendorExtensions { get set }
 }
 
 public enum VendorExtensionsConfiguration {

Sources/OpenAPIKit30/Example.swift

@@ -25,7 +25,7 @@ extension OpenAPI {
         /// These should be of the form:
         /// `[ "x-extensionKey": <anything>]`
         /// where the values are anything codable.
-        public let vendorExtensions: [String: AnyCodable]
+        public var vendorExtensions: [String: AnyCodable]
 
         public init(
             summary: String? = nil,

Sources/OpenAPIKit30/Schema Object/DereferencedJSONSchema.swift

@@ -451,7 +451,8 @@ extension JSONSchema: ExternallyDereferenceable {
                         maxProperties: object.maxProperties, 
                         minProperties: object._minProperties
                     )
-                )
+                ),
+                vendorExtensions: vendorExtensions
             )
         case .array(let core, let array): 
             let (newItems, components) = try await array.items.externallyDereferenced(with: loader)
@@ -465,37 +466,43 @@ extension JSONSchema: ExternallyDereferenceable {
                         minItems: array._minItems,
                         uniqueItems: array._uniqueItems
                     )
-                )
+                ),
+                vendorExtensions: vendorExtensions
             )
         case .all(let schema, let core): 
             let (newSubschemas, components) = try await schema.externallyDereferenced(with: loader)
             newComponents = components
             newSchema = .init(
-                schema: .all(of: newSubschemas, core: core)
+                schema: .all(of: newSubschemas, core: core),
+                vendorExtensions: vendorExtensions
             )
         case .one(let schema, let core): 
             let (newSubschemas, components) = try await schema.externallyDereferenced(with: loader)
             newComponents = components
             newSchema = .init(
-                schema: .one(of: newSubschemas, core: core)
+                schema: .one(of: newSubschemas, core: core),
+                vendorExtensions: vendorExtensions
             )
         case .any(let schema, let core): 
             let (newSubschemas, components) = try await schema.externallyDereferenced(with: loader)
             newComponents = components
             newSchema = .init(
-                schema: .any(of: newSubschemas, core: core)
+                schema: .any(of: newSubschemas, core: core),
+                vendorExtensions: vendorExtensions
             )
         case .not(let schema, let core): 
             let (newSubschema, components) = try await schema.externallyDereferenced(with: loader)
             newComponents = components
             newSchema = .init(
-                schema: .not(newSubschema, core: core)
+                schema: .not(newSubschema, core: core),
+                vendorExtensions: vendorExtensions
             )
         case .reference(let reference, let core): 
             let (newReference, components) = try await reference.externallyDereferenced(with: loader)
             newComponents = components
             newSchema = .init(
-                schema: .reference(newReference, core)
+                schema: .reference(newReference, core),
+                vendorExtensions: vendorExtensions
             )
         case .fragment(_): 
             newComponents = .noComponents

Sources/OpenAPIKit30/Schema Object/JSONSchema.swift

@@ -14,7 +14,7 @@ public struct JSONSchema: JSONSchemaContext, HasWarnings, VendorExtendable {
     public let warnings: [OpenAPI.Warning]
     public let value: Schema
 
-    public let vendorExtensions: [String: AnyCodable]
+    public var vendorExtensions: [String: AnyCodable]
 
     internal init(warnings: [OpenAPI.Warning], schema: Schema, vendorExtensions: [String: AnyCodable]) {
         self.warnings = warnings

Tests/OpenAPIKit30Tests/Document/ExternalDereferencingDocumentTests.swift

@@ -25,9 +25,7 @@ final class ExternalDereferencingDocumentTests: XCTestCase {
                 // to keep track of where a reference was loaded from. This test makes sure
                 // the following strategy of using vendor extensions works.
                 if var extendable = decoded as? VendorExtendable {
-                    //TODO: revisit vendor extensions mutability
-#warning("revisit vendor extensions mutability")
-//                    extendable.vendorExtensions["x-source-url"] = AnyCodable(url)
+                    extendable.vendorExtensions["x-source-url"] = AnyCodable(url)
                     finished = extendable as! T
                 } else {
                     finished = decoded 

Tests/OpenAPIKit30Tests/VendorExtendableTests.swift

@@ -145,7 +145,7 @@ private struct TestStruct: Codable, CodableVendorExtendable {
         }
     }
 
-    public let vendorExtensions: Self.VendorExtensions
+    public var vendorExtensions: Self.VendorExtensions
 
     init(vendorExtensions: Self.VendorExtensions) {
         self.vendorExtensions = vendorExtensions