Merge pull request #376 from mattpolzin/defs

Add JSON Schema `$defs` encoding & decoding
mattpolzin · Jun 16, 2024 · ea46a4c · ea46a4c
2 parents 104d9e0 + 3070c0e
commit ea46a4c
Show file tree

Hide file tree

Showing 3 changed files with 249 additions and 46 deletions.
diff --git a/Sources/OpenAPIKit/Schema Object/JSONSchema.swift b/Sources/OpenAPIKit/Schema Object/JSONSchema.swift
@@ -237,6 +237,38 @@ public struct JSONSchema: JSONSchemaContext, HasWarnings {
 
     }
 
+    // See `JSONSchemaContext`
+    public var defs: OrderedDictionary<String, JSONSchema> {
+        switch value {
+        case .null(let core):
+            return core.defs
+        case .boolean(let core):
+            return core.defs
+        case .number(let core, _):
+            return core.defs
+        case .integer(let core, _):
+            return core.defs
+        case .string(let core, _):
+            return core.defs
+        case .object(let core, _):
+            return core.defs
+        case .array(let core, _):
+            return core.defs
+        case .all(of: _, core: let core):
+            return core.defs
+        case .one(of: _, core: let core):
+            return core.defs
+        case .any(of: _, core: let core):
+            return core.defs
+        case .not(_, core: let core):
+            return core.defs
+        case .reference(_, let core):
+            return core.defs
+        case .fragment(let core):
+            return core.defs
+        }
+    }
+
     // See `JSONSchemaContext`
     public var inferred: Bool {
         return coreContext.inferred
@@ -1086,7 +1118,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let context = JSONSchema.CoreContext<JSONTypeFormat.BooleanFormat>(
             format: format,
@@ -1102,7 +1135,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         return .boolean(context)
     }
@@ -1123,7 +1157,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .boolean(
             format: format,
@@ -1139,7 +1174,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
     }
 
@@ -1164,7 +1200,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let context = JSONSchema.CoreContext<JSONTypeFormat.AnyFormat>(
             format: format,
@@ -1180,7 +1217,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         return .fragment(context)
     }
@@ -1201,7 +1239,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .fragment(
             format: format,
@@ -1217,7 +1256,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
     }
 
@@ -1250,7 +1290,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let genericContext = JSONSchema.CoreContext<JSONTypeFormat.StringFormat>(
             format: format,
@@ -1266,7 +1307,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         let stringContext = JSONSchema.StringContext(
             maxLength: maxLength,
@@ -1299,7 +1341,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .string(
             format: format,
@@ -1320,7 +1363,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
     }
 
@@ -1348,7 +1392,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let genericContext = JSONSchema.CoreContext<JSONTypeFormat.NumberFormat>(
             format: format,
@@ -1364,7 +1409,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         let numbericContext = JSONSchema.NumericContext(
             multipleOf: multipleOf,
@@ -1393,7 +1439,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .number(
             format: format,
@@ -1412,7 +1459,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
     }
 
@@ -1440,7 +1488,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let genericContext = JSONSchema.CoreContext<JSONTypeFormat.IntegerFormat>(
             format: format,
@@ -1456,7 +1505,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         let integerContext = JSONSchema.IntegerContext(
             multipleOf: multipleOf,
@@ -1485,7 +1535,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .integer(
             format: format,
@@ -1504,7 +1555,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
     }
 
@@ -1533,7 +1585,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let coreContext = JSONSchema.CoreContext<JSONTypeFormat.ObjectFormat>(
             format: format,
@@ -1549,7 +1602,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
         let objectContext = JSONSchema.ObjectContext(
             properties: properties,
@@ -1585,7 +1639,8 @@ extension JSONSchema {
         defaultValue: AnyCodable? = nil,
         examples: [AnyCodable] = [],
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         let coreContext = JSONSchema.CoreContext<JSONTypeFormat.ArrayFormat>(
             format: format,
@@ -1601,7 +1656,8 @@ extension JSONSchema {
             defaultValue: defaultValue,
             examples: examples,
             anchor: anchor,
-            dynamicAnchor: dynamicAnchor
+            dynamicAnchor: dynamicAnchor,
+            defs: defs
         )
 
         let arrayContext = JSONSchema.ArrayContext(
@@ -1635,7 +1691,8 @@ extension JSONSchema {
         description: String? = nil,
         discriminator: OpenAPI.Discriminator? = nil,
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .all(
             of: schemas,
@@ -1645,7 +1702,8 @@ extension JSONSchema {
                 description: description,
                 discriminator: discriminator,
                 anchor: anchor,
-                dynamicAnchor: dynamicAnchor
+                dynamicAnchor: dynamicAnchor,
+                defs: defs
             )
         )
     }
@@ -1667,7 +1725,8 @@ extension JSONSchema {
         description: String? = nil,
         discriminator: OpenAPI.Discriminator? = nil,
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .one(
             of: schemas,
@@ -1677,7 +1736,8 @@ extension JSONSchema {
                 description: description,
                 discriminator: discriminator,
                 anchor: anchor,
-                dynamicAnchor: dynamicAnchor
+                dynamicAnchor: dynamicAnchor,
+                defs: defs
             )
         )
     }
@@ -1699,7 +1759,8 @@ extension JSONSchema {
         description: String? = nil,
         discriminator: OpenAPI.Discriminator? = nil,
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .any(
             of: schemas,
@@ -1709,7 +1770,8 @@ extension JSONSchema {
                 description: description,
                 discriminator: discriminator,
                 anchor: anchor,
-                dynamicAnchor: dynamicAnchor
+                dynamicAnchor: dynamicAnchor,
+                defs: defs
             )
         )
     }
@@ -1728,7 +1790,8 @@ extension JSONSchema {
         description: String? = nil,
         discriminator: OpenAPI.Discriminator? = nil,
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .not(
             schema,
@@ -1738,7 +1801,8 @@ extension JSONSchema {
                 description: description,
                 discriminator: discriminator,
                 anchor: anchor,
-                dynamicAnchor: dynamicAnchor
+                dynamicAnchor: dynamicAnchor,
+                defs: defs
             )
         )
     }
@@ -1750,11 +1814,12 @@ extension JSONSchema {
         title: String? = nil,
         description: String? = nil,
         anchor: String? = nil,
-        dynamicAnchor: String? = nil
+        dynamicAnchor: String? = nil,
+        defs: OrderedDictionary<String, JSONSchema> = [:]
     ) -> JSONSchema {
         return .reference(
             reference,
-            .init(required: required, title: title, description: description, anchor: anchor, dynamicAnchor: dynamicAnchor)
+            .init(required: required, title: title, description: description, anchor: anchor, dynamicAnchor: dynamicAnchor, defs: defs)
         )
     }
 }