Skip to content

Commit a56871c

Browse files
fix(specs): results in getObjects is required (#4024) (generated) [skip ci]
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 1f36e8f commit a56871c

File tree

14 files changed

+50
-60
lines changed

14 files changed

+50
-60
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/GetObjectsResponse.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,15 @@ public partial class GetObjectsResponse<T>
1919
/// <summary>
2020
/// Initializes a new instance of the GetObjectsResponse class.
2121
/// </summary>
22-
public GetObjectsResponse()
22+
[JsonConstructor]
23+
public GetObjectsResponse() { }
24+
/// <summary>
25+
/// Initializes a new instance of the GetObjectsResponse class.
26+
/// </summary>
27+
/// <param name="results">Retrieved records. (required).</param>
28+
public GetObjectsResponse(List<T> results)
2329
{
30+
Results = results ?? throw new ArgumentNullException(nameof(results));
2431
}
2532

2633
/// <summary>

clients/algoliasearch-client-dart/packages/client_search/lib/src/model/get_objects_response.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ part 'get_objects_response.g.dart';
99
final class GetObjectsResponse {
1010
/// Returns a new [GetObjectsResponse] instance.
1111
const GetObjectsResponse({
12-
this.results,
12+
required this.results,
1313
});
1414

1515
/// Retrieved records.
1616
@JsonKey(name: r'results')
17-
final List<Object>? results;
17+
final List<Object> results;
1818

1919
@override
2020
bool operator ==(Object other) =>

clients/algoliasearch-client-dart/packages/client_search/lib/src/model/get_objects_response.g.dart

Lines changed: 5 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-go/algolia/search/model_get_objects_response.go

Lines changed: 10 additions & 28 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/GetObjectsResponse.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,20 @@
1313
public class GetObjectsResponse<T> {
1414

1515
@JsonProperty("results")
16-
private List<T> results;
16+
private List<T> results = new ArrayList<>();
1717

1818
public GetObjectsResponse<T> setResults(List<T> results) {
1919
this.results = results;
2020
return this;
2121
}
2222

2323
public GetObjectsResponse<T> addResults(T resultsItem) {
24-
if (this.results == null) {
25-
this.results = new ArrayList<>();
26-
}
2724
this.results.add(resultsItem);
2825
return this;
2926
}
3027

3128
/** Retrieved records. */
32-
@javax.annotation.Nullable
29+
@javax.annotation.Nonnull
3330
public List<T> getResults() {
3431
return results;
3532
}

clients/algoliasearch-client-javascript/packages/client-search/model/getObjectsResponse.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ export type GetObjectsResponse<T = Record<string, unknown>> = {
44
/**
55
* Retrieved records.
66
*/
7-
results?: T[];
7+
results: T[];
88
};

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/GetObjectsResponse.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ import kotlinx.serialization.json.*
1313
public data class GetObjectsResponse(
1414

1515
/** Retrieved records. */
16-
@SerialName(value = "results") val results: List<JsonObject>? = null,
16+
@SerialName(value = "results") val results: List<JsonObject>,
1717
)

clients/algoliasearch-client-php/lib/Model/Search/GetObjectsResponse.php

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,13 @@ public static function getters()
137137
*/
138138
public function listInvalidProperties()
139139
{
140-
return [];
140+
$invalidProperties = [];
141+
142+
if (!isset($this->container['results']) || null === $this->container['results']) {
143+
$invalidProperties[] = "'results' can't be null";
144+
}
145+
146+
return $invalidProperties;
141147
}
142148

143149
/**
@@ -154,7 +160,7 @@ public function valid()
154160
/**
155161
* Gets results.
156162
*
157-
* @return null|object[]
163+
* @return object[]
158164
*/
159165
public function getResults()
160166
{
@@ -164,7 +170,7 @@ public function getResults()
164170
/**
165171
* Sets results.
166172
*
167-
* @param null|object[] $results retrieved records
173+
* @param object[] $results retrieved records
168174
*
169175
* @return self
170176
*/

clients/algoliasearch-client-python/algoliasearch/search/models/get_objects_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class GetObjectsResponse(BaseModel):
3232
GetObjectsResponse
3333
"""
3434

35-
results: Optional[List[object]] = None
35+
results: List[object]
3636
""" Retrieved records. """
3737

3838
model_config = ConfigDict(

clients/algoliasearch-client-ruby/lib/algolia/models/search/get_objects_response.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ def initialize(attributes = {})
6262
if (value = attributes[:results]).is_a?(Array)
6363
self.results = value
6464
end
65+
else
66+
self.results = nil
6567
end
6668
end
6769

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/GetObjectsResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ package algoliasearch.search
3939
* Retrieved records.
4040
*/
4141
case class GetObjectsResponse(
42-
results: Option[Seq[Any]] = scala.None
42+
results: Seq[Any]
4343
)

clients/algoliasearch-client-swift/Sources/Search/Models/GetObjectsResponse.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import Foundation
88

99
public struct GetObjectsResponse<T: Codable>: Codable, JSONEncodable {
1010
/// Retrieved records.
11-
public var results: [T]?
11+
public var results: [T]
1212

13-
public init(results: [T]? = nil) {
13+
public init(results: [T]) {
1414
self.results = results
1515
}
1616

@@ -22,7 +22,7 @@ public struct GetObjectsResponse<T: Codable>: Codable, JSONEncodable {
2222

2323
public func encode(to encoder: Encoder) throws {
2424
var container = encoder.container(keyedBy: CodingKeys.self)
25-
try container.encodeIfPresent(self.results, forKey: .results)
25+
try container.encode(self.results, forKey: .results)
2626
}
2727
}
2828

@@ -34,6 +34,6 @@ extension GetObjectsResponse: Equatable where T: Equatable {
3434

3535
extension GetObjectsResponse: Hashable where T: Hashable {
3636
public func hash(into hasher: inout Hasher) {
37-
hasher.combine(self.results?.hashValue)
37+
hasher.combine(self.results.hashValue)
3838
}
3939
}

specs/bundled/search.doc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5329,6 +5329,8 @@ paths:
53295329
type: object
53305330
description: Retrieved record.
53315331
x-is-generic: true
5332+
required:
5333+
- results
53325334
'400':
53335335
$ref: '#/components/responses/BadRequest'
53345336
'402':

specs/bundled/search.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,6 +1217,8 @@ paths:
12171217
type: object
12181218
description: Retrieved record.
12191219
x-is-generic: true
1220+
required:
1221+
- results
12201222
'400':
12211223
$ref: '#/components/responses/BadRequest'
12221224
'402':

0 commit comments

Comments
 (0)