fix(specs): add searchResponsePartial fallback to searchResult oneOf (#6350)

Fluf22 · eric-zaharia · web-flow · commit 35bf16c848bc · 2026-05-26T11:46:25.000+03:00
Co-authored-by: Eric Zaharia &lt;94015633+eric-zaharia@users.noreply.github.com&gt;
diff --git a/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift b/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift
@@ -370,6 +370,8 @@ public extension SearchClient {
                 acc.append(searchResponse)
             case .searchForFacetValuesResponse:
                 break
+            case .searchResponsePartial:
+                break
             }
         }
     }
@@ -392,6 +394,8 @@ public extension SearchClient {
                 acc.append(contentsOf: searchResponse.hits)
             case .searchForFacetValuesResponse:
                 break
+            case .searchResponsePartial:
+                break
             }
         }
     }
@@ -414,6 +418,8 @@ public extension SearchClient {
                 break
             case let .searchForFacetValuesResponse(searchForFacet):
                 acc.append(searchForFacet)
+            case .searchResponsePartial:
+                break
             }
         }
     }
diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
@@ -5,6 +5,36 @@ searchResponse:
     - $ref: '../../../common/schemas/SearchResponse.yml#/SearchPagination'
     - $ref: '#/searchHits'
 
+searchResponsePartial:
+  description: |
+    Partial search response returned when the `responseFields` parameter excludes
+    fields like `hits`. Contains all possible search response properties but
+    none are required, so it acts as an unconditional fallback during oneOf
+    deserialization.
+  additionalProperties: true
+  allOf:
+    - $ref: '../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
+    - $ref: '../../../common/schemas/SearchResponse.yml#/SearchPagination'
+    - type: object
+      additionalProperties: true
+      properties:
+        hits:
+          type: array
+          description: |
+            Search results (hits).
+
+            Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+          items:
+            $ref: 'Hit.yml#/hit'
+        query:
+          $ref: '../../../common/schemas/SearchParams.yml#/query'
+        params:
+          type: string
+          description: URL-encoded string of all search parameters.
+          example: query=a&hitsPerPage=20
+        extensions:
+          $ref: '#/responseExtensions'
+
 searchHits:
   type: object
   additionalProperties: true
diff --git a/specs/search/common/schemas/SearchResult.yml b/specs/search/common/schemas/SearchResult.yml
@@ -2,3 +2,4 @@ searchResult:
   oneOf:
     - $ref: 'SearchResponse.yml#/searchResponse'
     - $ref: 'SearchForFacetValuesResponse.yml#/searchForFacetValuesResponse'
+    - $ref: 'SearchResponse.yml#/searchResponsePartial'
diff --git a/templates/csharp/modelOneOf.mustache b/templates/csharp/modelOneOf.mustache
@@ -45,7 +45,7 @@
           /// with a {{#lambdaCref}}{{{dataType}}}{{/lambdaCref}}
           /// </summary>
           /// <param name="actualInstance">An instance of {{{dataType}}}.</param>
-          public {{classname}}(object actualInstance)
+          public {{classname}}({{{dataType}}}<T> actualInstance)
           {
               ActualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}}{{^allowableValues}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/allowableValues}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}};
           }
diff --git a/templates/swift/modelObject.mustache b/templates/swift/modelObject.mustache
@@ -75,7 +75,7 @@
           throw GenericError(description: "Failed to cast")
         }
         self.{{{name}}} = {{{name}}}{{/required}}{{^required}}
-        self.{{{name}}} = dictionary["{{{name}}}"]?.value as? {{{datatype}}}
+        self.{{{name}}} = dictionary["{{{name}}}"]?.value as? {{> generic_type}}
         {{/required}}
       {{/vars}}
 

Original file line number	Diff line number	Diff line change
`@@ -370,6 +370,8 @@ public extension SearchClient {`
`370`	`370`	`acc.append(searchResponse)`
`371`	`371`	`case .searchForFacetValuesResponse:`
`372`	`372`	`break`
	`373`	`+ case .searchResponsePartial:`
	`374`	`+ break`
`373`	`375`	`}`
`374`	`376`	`}`
`375`	`377`	`}`
`@@ -392,6 +394,8 @@ public extension SearchClient {`
`392`	`394`	`acc.append(contentsOf: searchResponse.hits)`
`393`	`395`	`case .searchForFacetValuesResponse:`
`394`	`396`	`break`
	`397`	`+ case .searchResponsePartial:`
	`398`	`+ break`
`395`	`399`	`}`
`396`	`400`	`}`
`397`	`401`	`}`
`@@ -414,6 +418,8 @@ public extension SearchClient {`
`414`	`418`	`break`
`415`	`419`	`case let .searchForFacetValuesResponse(searchForFacet):`
`416`	`420`	`acc.append(searchForFacet)`
	`421`	`+ case .searchResponsePartial:`
	`422`	`+ break`
`417`	`423`	`}`
`418`	`424`	`}`
`419`	`425`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`	`/// with a {{#lambdaCref}}{{{dataType}}}{{/lambdaCref}}`
`46`	`46`	`/// </summary>`
`47`	`47`	`/// <param name="actualInstance">An instance of {{{dataType}}}.</param>`
`48`		`- public {{classname}}(object actualInstance)`
	`48`	`+ public {{classname}}({{{dataType}}}<T> actualInstance)`
`49`	`49`	`{`
`50`	`50`	ActualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}}{{^allowableValues}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/allowableValues}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}};
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@`
`75`	`75`	`throw GenericError(description: "Failed to cast")`
`76`	`76`	`}`
`77`	`77`	`self.{{{name}}} = {{{name}}}{{/required}}{{^required}}`
`78`		`- self.{{{name}}} = dictionary["{{{name}}}"]?.value as? {{{datatype}}}`
	`78`	`+ self.{{{name}}} = dictionary["{{{name}}}"]?.value as? {{> generic_type}}`
`79`	`79`	`{{/required}}`
`80`	`80`	`{{/vars}}`
`81`	`81`