Merge pull request #414 from true-false-maybe/add-prefixItems

add prefixItems to array

Author: mattpolzin

Sources/OpenAPIKit/Schema Object/JSONSchema.swift

@@ -8,7 +8,7 @@
 import OpenAPIKitCore
 
 /// OpenAPI "Schema Object"
-/// 
+///
 /// See [OpenAPI Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#schema-object).
 public struct JSONSchema: JSONSchemaContext, HasWarnings {
 
@@ -475,7 +475,7 @@ extension JSONSchema: VendorExtendable {
 
     public func with(vendorExtensions: [String: AnyCodable]) -> JSONSchema {
         .init(
-            warnings: warnings, 
+            warnings: warnings,
             schema: value.with(vendorExtensions: vendorExtensions)
         )
     }
@@ -1634,6 +1634,7 @@ extension JSONSchema {
         minItems: Int? = nil,
         maxItems: Int? = nil,
         uniqueItems: Bool? = nil,
+        prefixItems: [JSONSchema]? = nil,
         items: JSONSchema? = nil,
         allowedValues: [AnyCodable]? = nil,
         defaultValue: AnyCodable? = nil,
@@ -1664,6 +1665,7 @@ extension JSONSchema {
             items: items,
             maxItems: maxItems,
             minItems: minItems,
+            prefixItems: prefixItems,
             uniqueItems: uniqueItems
         )
         return .array(coreContext, arrayContext)
@@ -2149,22 +2151,22 @@ extension JSONSchema: Decodable {
 
         self.value = value.with(vendorExtensions: extensions)
     }
-    
+
     private static func decodeVenderExtensions(from decoder: Decoder) throws -> [String: AnyCodable] {
         guard VendorExtensionsConfiguration.isEnabled else {
             return [:]
         }
-        
+
         let decoded = try AnyCodable(from: decoder).value
-        
+
         guard (decoded as? [Any]) == nil else {
             throw VendorExtensionDecodingError.selfIsArrayNotDict
         }
-        
+
         guard let decodedAny = decoded as? [String: Any] else {
             throw VendorExtensionDecodingError.foundNonStringKeys
         }
-        
+
         return decodedAny
             .filter { $0.key.lowercased().starts(with: "x-") }
             .mapValues(AnyCodable.init)

Sources/OpenAPIKit/Schema Object/JSONSchemaContext.swift

@@ -1,6 +1,6 @@
 //
 //  JSONSchemaContext.swift
-//  
+//
 //
 //  Created by Mathew Polzin on 6/22/19.
 //
@@ -334,7 +334,7 @@ extension JSONSchema.CoreContext: Equatable {
           && lhs.externalDocs == rhs.externalDocs
           && lhs.discriminator == rhs.discriminator
 
-      return step1 
+      return step1
           && lhs.allowedValues == rhs.allowedValues
           && lhs.defaultValue == rhs.defaultValue
           && lhs.examples == rhs.examples
@@ -725,6 +725,11 @@ extension JSONSchema {
         /// Defaults to 0.
         public var minItems: Int { _minItems ?? 0 }
 
+        /// Multiple JSON Type Node that describe
+        /// the types of the first few elements in the array.
+        /// Useful for describing tuples.
+        public let prefixItems: [JSONSchema]?
+
         let _uniqueItems: Bool?
         /// Setting to true indicates all
         /// elements of the array are expected
@@ -735,11 +740,13 @@ extension JSONSchema {
             items: JSONSchema? = nil,
             maxItems: Int? = nil,
             minItems: Int? = nil,
+            prefixItems: [JSONSchema]? = nil,
             uniqueItems: Bool? = nil
         ) {
             self.items = items
             self.maxItems = maxItems
             self._minItems = minItems
+            self.prefixItems = prefixItems
             self._uniqueItems = uniqueItems
         }
     }
@@ -1056,7 +1063,6 @@ extension JSONSchema.CoreContext: Decodable {
                       )
                   )
             )
-            
         }
         else if let types = try? container.decodeIfPresent([JSONType].self, forKey: .type) {
             nullable = types.contains(JSONType.null)
@@ -1209,6 +1215,7 @@ extension JSONSchema.ArrayContext {
         case maxItems
         case minItems
         case uniqueItems
+        case prefixItems
     }
 }
 
@@ -1219,6 +1226,7 @@ extension JSONSchema.ArrayContext: Encodable {
         try container.encodeIfPresent(items, forKey: .items)
         try container.encodeIfPresent(maxItems, forKey: .maxItems)
         try container.encodeIfPresent(_minItems, forKey: .minItems)
+        try container.encodeIfPresent(prefixItems, forKey: .prefixItems)
         try container.encodeIfPresent(_uniqueItems, forKey: .uniqueItems)
     }
 }
@@ -1230,6 +1238,7 @@ extension JSONSchema.ArrayContext: Decodable {
         items = try container.decodeIfPresent(JSONSchema.self, forKey: .items)
         maxItems = try container.decodeIfPresent(Int.self, forKey: .maxItems)
         _minItems = try container.decodeIfPresent(Int.self, forKey: .minItems)
+        prefixItems = try container.decodeIfPresent([JSONSchema].self, forKey: .prefixItems)
         _uniqueItems = try container.decodeIfPresent(Bool.self, forKey: .uniqueItems)
     }
 }

Tests/OpenAPIKitTests/Schema Object/SchemaFragmentTests.swift

@@ -1,6 +1,6 @@
 //
 //  SchemaFragmentTests.swift
-//  
+//
 //
 //  Created by Mathew Polzin on 4/21/20.
 //
@@ -663,6 +663,30 @@ extension SchemaFragmentTests {
             }
             """
         )
+
+        let t5 = JSONSchema.array(.init(), .init(items: .string, prefixItems: [.integer, .boolean]))
+
+        let encoded5 = try orderUnstableTestStringFromEncoding(of: t5)
+
+        assertJSONEquivalent(
+            encoded5,
+            """
+            {
+              "items" : {
+                "type" : "string"
+              },
+              "prefixItems" : [
+                {
+                  "type" : "integer"
+                },
+                {
+                  "type" : "boolean"
+                }
+              ],
+              "type" : "array"
+            }
+            """
+        )
     }
 
     func test_arrayDecode() throws {
@@ -724,6 +748,24 @@ extension SchemaFragmentTests {
         let decoded5 = try orderUnstableDecode(JSONSchema.self, from: t5)
 
         XCTAssertEqual(decoded5, JSONSchema.array(.init(), .init(items: .string)))
+
+        let t6 =
+        """
+        {
+          "items" : {
+            "type" : "string"
+          },
+          "prefixItems": [
+            {
+              "type" : "integer"
+            }
+          ]
+        }
+        """.data(using: .utf8)!
+
+        let decoded6 = try orderUnstableDecode(JSONSchema.self, from: t6)
+
+        XCTAssertEqual(decoded6, JSONSchema.array(.init(), .init(items: .string, prefixItems: [.integer])))
     }
 
     func test_objectEncode() throws {