refactor(specs): re-organise response for Composition API (generated)

algolia/api-clients-automation#5744

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>

Author: algolia-bot

Sources/Composition/Models/CompositionRunAppliedRules.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 public struct CompositionRunAppliedRules: Codable, JSONEncodable {
-    /// Unique record identifier.
+    /// The objectID of the applied composition rule on this query.
     public var objectID: String
 
     public init(objectID: String) {

Sources/Composition/Models/CompositionRunSearchResponse.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 public struct CompositionRunSearchResponse: Codable, JSONEncodable {
-    /// Unique record identifier.
+    /// The objectID of the composition which generated this result set.
     public var objectID: String
     public var appliedRules: [CompositionRunAppliedRules]?
 

Sources/Composition/Models/CompositionSearchHits.swift

@@ -17,71 +17,22 @@ public struct ResultsCompositionsResponse: Codable, JSONEncodable {
         case compositions
     }
 
-    public var additionalProperties: [String: AnyCodable] = [:]
-
-    public subscript(key: String) -> AnyCodable? {
-        get {
-            if let value = additionalProperties[key] {
-                return value
-            }
-            return nil
-        }
-
-        set {
-            self.additionalProperties[key] = newValue
-        }
-    }
-
-    public init(from dictionary: [String: AnyCodable]) throws {
-        guard let compositions = dictionary["compositions"]?.value as? [String: ResultsCompositionInfoResponse] else {
-            throw GenericError(description: "Failed to cast")
-        }
-        self.compositions = compositions
-        for (key, value) in dictionary {
-            switch key {
-            case "compositions":
-                continue
-            default:
-                self.additionalProperties[key] = value
-            }
-        }
-    }
-
     // Encodable protocol methods
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(self.compositions, forKey: .compositions)
-        var additionalPropertiesContainer = encoder.container(keyedBy: String.self)
-        try additionalPropertiesContainer.encodeMap(self.additionalProperties)
-    }
-
-    // Decodable protocol methods
-
-    public init(from decoder: Decoder) throws {
-        let container = try decoder.container(keyedBy: CodingKeys.self)
-
-        self.compositions = try container.decode([String: ResultsCompositionInfoResponse].self, forKey: .compositions)
-        var nonAdditionalPropertyKeys = Set<String>()
-        nonAdditionalPropertyKeys.insert("compositions")
-        let additionalPropertiesContainer = try decoder.container(keyedBy: String.self)
-        self.additionalProperties = try additionalPropertiesContainer.decodeMap(
-            AnyCodable.self,
-            excludedKeys: nonAdditionalPropertyKeys
-        )
     }
 }
 
 extension ResultsCompositionsResponse: Equatable {
     public static func ==(lhs: ResultsCompositionsResponse, rhs: ResultsCompositionsResponse) -> Bool {
         lhs.compositions == rhs.compositions
-            && lhs.additionalProperties == rhs.additionalProperties
     }
 }
 
 extension ResultsCompositionsResponse: Hashable {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(self.compositions.hashValue)
-        hasher.combine(self.additionalProperties.hashValue)
     }
 }

Sources/Composition/Models/ResultsCompositionsResponse.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 public struct ResultsInjectedItemAppliedRulesInfoResponse: Codable, JSONEncodable {
-    /// Unique record identifier.
+    /// The objectID of the applied index level rule on this injected group.
     public var objectID: String
 
     public init(objectID: String) {

Sources/Composition/Models/ResultsInjectedItemAppliedRulesInfoResponse.swift

@@ -7,6 +7,7 @@ import Foundation
 #endif
 
 public struct ResultsInjectedItemInfoResponse: Codable, JSONEncodable {
+    /// The key of the injected group.
     public var key: String
     public var appliedRules: [ResultsInjectedItemAppliedRulesInfoResponse]?
 

Sources/Composition/Models/ResultsInjectedItemInfoResponse.swift

@@ -6,55 +6,77 @@ import Foundation
     import Core
 #endif
 
-public struct CompositionSearchPagination: Codable, JSONEncodable {
-    /// The current page of the results.
-    public var page: Int
+public struct SearchFields<T: Codable>: Codable, JSONEncodable {
+    /// Search results (hits).  Hits are records from your index that match the search criteria, augmented with
+    /// additional attributes, such as, for highlighting.
+    public var hits: [T]
+    /// Number of hits returned per page.
+    public var hitsPerPage: Int
     /// Number of results (hits).
     public var nbHits: Int
     /// Number of pages of results.
     public var nbPages: Int
-    /// Number of hits returned per page.
-    public var hitsPerPage: Int
+    /// The current page of the results.
+    public var page: Int
+    /// URL-encoded string of all search parameters.
+    public var params: String
+    /// The search query string.
+    public var query: String
 
-    public init(page: Int, nbHits: Int, nbPages: Int, hitsPerPage: Int) {
-        self.page = page
+    public init(hits: [T], hitsPerPage: Int, nbHits: Int, nbPages: Int, page: Int, params: String, query: String) {
+        self.hits = hits
+        self.hitsPerPage = hitsPerPage
         self.nbHits = nbHits
         self.nbPages = nbPages
-        self.hitsPerPage = hitsPerPage
+        self.page = page
+        self.params = params
+        self.query = query
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
-        case page
+        case hits
+        case hitsPerPage
         case nbHits
         case nbPages
-        case hitsPerPage
+        case page
+        case params
+        case query
     }
 
     // Encodable protocol methods
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
-        try container.encode(self.page, forKey: .page)
+        try container.encode(self.hits, forKey: .hits)
+        try container.encode(self.hitsPerPage, forKey: .hitsPerPage)
         try container.encode(self.nbHits, forKey: .nbHits)
         try container.encode(self.nbPages, forKey: .nbPages)
-        try container.encode(self.hitsPerPage, forKey: .hitsPerPage)
+        try container.encode(self.page, forKey: .page)
+        try container.encode(self.params, forKey: .params)
+        try container.encode(self.query, forKey: .query)
     }
 }
 
-extension CompositionSearchPagination: Equatable {
-    public static func ==(lhs: CompositionSearchPagination, rhs: CompositionSearchPagination) -> Bool {
-        lhs.page == rhs.page &&
+extension SearchFields: Equatable where T: Equatable {
+    public static func ==(lhs: SearchFields<T>, rhs: SearchFields<T>) -> Bool {
+        lhs.hits == rhs.hits &&
+            lhs.hitsPerPage == rhs.hitsPerPage &&
             lhs.nbHits == rhs.nbHits &&
             lhs.nbPages == rhs.nbPages &&
-            lhs.hitsPerPage == rhs.hitsPerPage
+            lhs.page == rhs.page &&
+            lhs.params == rhs.params &&
+            lhs.query == rhs.query
     }
 }
 
-extension CompositionSearchPagination: Hashable {
+extension SearchFields: Hashable where T: Hashable {
     public func hash(into hasher: inout Hasher) {
-        hasher.combine(self.page.hashValue)
+        hasher.combine(self.hits.hashValue)
+        hasher.combine(self.hitsPerPage.hashValue)
         hasher.combine(self.nbHits.hashValue)
         hasher.combine(self.nbPages.hashValue)
-        hasher.combine(self.hitsPerPage.hashValue)
+        hasher.combine(self.page.hashValue)
+        hasher.combine(self.params.hashValue)
+        hasher.combine(self.query.hashValue)
     }
 }