Skip to content

Commit 2b70f87

Browse files
algolia-botJerska
algolia-bot
and
Jerska
committed
docs(specs): update api's length minimum value (#3574) (generated) [skip ci]
Co-authored-by: Matthieu Dumont <[email protected]>
1 parent 9b6dc0b commit 2b70f87

File tree

61 files changed

+102
-102
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+102
-102
lines changed

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/base_search_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ final class BaseSearchParams {
110110
final int? offset;
111111

112112
/// Number of hits to retrieve (used in combination with `offset`).
113-
// minimum: 1
113+
// minimum: 0
114114
// maximum: 1000
115115
@JsonKey(name: r'length')
116116
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/base_search_params_without_query.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ final class BaseSearchParamsWithoutQuery {
105105
final int? offset;
106106

107107
/// Number of hits to retrieve (used in combination with `offset`).
108-
// minimum: 1
108+
// minimum: 0
109109
// maximum: 1000
110110
@JsonKey(name: r'length')
111111
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/browse_params_object.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ final class BrowseParamsObject {
163163
final int? offset;
164164

165165
/// Number of hits to retrieve (used in combination with `offset`).
166-
// minimum: 1
166+
// minimum: 0
167167
// maximum: 1000
168168
@JsonKey(name: r'length')
169169
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/consequence_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ final class ConsequenceParams {
160160
final int? offset;
161161

162162
/// Number of hits to retrieve (used in combination with `offset`).
163-
// minimum: 1
163+
// minimum: 0
164164
// maximum: 1000
165165
@JsonKey(name: r'length')
166166
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/fallback_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class FallbackParams {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/search_for_facets.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ final class SearchForFacets {
167167
final int? offset;
168168

169169
/// Number of hits to retrieve (used in combination with `offset`).
170-
// minimum: 1
170+
// minimum: 0
171171
// maximum: 1000
172172
@JsonKey(name: r'length')
173173
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/search_for_hits.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ final class SearchForHits {
165165
final int? offset;
166166

167167
/// Number of hits to retrieve (used in combination with `offset`).
168-
// minimum: 1
168+
// minimum: 0
169169
// maximum: 1000
170170
@JsonKey(name: r'length')
171171
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/search_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class SearchParams {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/search_params_object.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class SearchParamsObject {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/base_search_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ final class BaseSearchParams {
110110
final int? offset;
111111

112112
/// Number of hits to retrieve (used in combination with `offset`).
113-
// minimum: 1
113+
// minimum: 0
114114
// maximum: 1000
115115
@JsonKey(name: r'length')
116116
final int? length;

‎clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/base_search_params_without_query.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ final class BaseSearchParamsWithoutQuery {
105105
final int? offset;
106106

107107
/// Number of hits to retrieve (used in combination with `offset`).
108-
// minimum: 1
108+
// minimum: 0
109109
// maximum: 1000
110110
@JsonKey(name: r'length')
111111
final int? length;

‎clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/fallback_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class FallbackParams {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/search_params.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class SearchParams {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/search_params_object.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class SearchParamsObject {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ final class BaseSearchParams {
110110
final int? offset;
111111

112112
/// Number of hits to retrieve (used in combination with `offset`).
113-
// minimum: 1
113+
// minimum: 0
114114
// maximum: 1000
115115
@JsonKey(name: r'length')
116116
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ final class BaseSearchParamsWithoutQuery {
105105
final int? offset;
106106

107107
/// Number of hits to retrieve (used in combination with `offset`).
108-
// minimum: 1
108+
// minimum: 0
109109
// maximum: 1000
110110
@JsonKey(name: r'length')
111111
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ final class BrowseParamsObject {
163163
final int? offset;
164164

165165
/// Number of hits to retrieve (used in combination with `offset`).
166-
// minimum: 1
166+
// minimum: 0
167167
// maximum: 1000
168168
@JsonKey(name: r'length')
169169
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ final class ConsequenceParams {
160160
final int? offset;
161161

162162
/// Number of hits to retrieve (used in combination with `offset`).
163-
// minimum: 1
163+
// minimum: 0
164164
// maximum: 1000
165165
@JsonKey(name: r'length')
166166
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ final class SearchForFacets {
172172
final int? offset;
173173

174174
/// Number of hits to retrieve (used in combination with `offset`).
175-
// minimum: 1
175+
// minimum: 0
176176
// maximum: 1000
177177
@JsonKey(name: r'length')
178178
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ final class SearchForHits {
170170
final int? offset;
171171

172172
/// Number of hits to retrieve (used in combination with `offset`).
173-
// minimum: 1
173+
// minimum: 0
174174
// maximum: 1000
175175
@JsonKey(name: r'length')
176176
final int? length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class SearchParamsObject {
162162
final int? offset;
163163

164164
/// Number of hits to retrieve (used in combination with `offset`).
165-
// minimum: 1
165+
// minimum: 0
166166
// maximum: 1000
167167
@JsonKey(name: r'length')
168168
final int? length;

‎clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ public FallbackParams setLength(Integer length) {
445445
return this;
446446
}
447447

448-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
448+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
449449
@javax.annotation.Nullable
450450
public Integer getLength() {
451451
return length;

‎clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchParams.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ public SearchParams setLength(Integer length) {
445445
return this;
446446
}
447447

448-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
448+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
449449
@javax.annotation.Nullable
450450
public Integer getLength() {
451451
return length;

‎clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchParamsObject.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ public SearchParamsObject setLength(Integer length) {
445445
return this;
446446
}
447447

448-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
448+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
449449
@javax.annotation.Nullable
450450
public Integer getLength() {
451451
return length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ public BrowseParamsObject setLength(Integer length) {
449449
return this;
450450
}
451451

452-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
452+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
453453
@javax.annotation.Nullable
454454
public Integer getLength() {
455455
return length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ public ConsequenceParams setLength(Integer length) {
440440
return this;
441441
}
442442

443-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
443+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
444444
@javax.annotation.Nullable
445445
public Integer getLength() {
446446
return length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ public SearchForFacets setLength(Integer length) {
472472
return this;
473473
}
474474

475-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
475+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
476476
@javax.annotation.Nullable
477477
public Integer getLength() {
478478
return length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ public SearchForHits setLength(Integer length) {
466466
return this;
467467
}
468468

469-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
469+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
470470
@javax.annotation.Nullable
471471
public Integer getLength() {
472472
return length;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ public SearchParamsObject setLength(Integer length) {
446446
return this;
447447
}
448448

449-
/** Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 */
449+
/** Number of hits to retrieve (used in combination with `offset`). minimum: 0 maximum: 1000 */
450450
@javax.annotation.Nullable
451451
public Integer getLength() {
452452
return length;

‎clients/algoliasearch-client-php/lib/Model/Recommend/FallbackParams.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -746,8 +746,8 @@ public function listInvalidProperties()
746746
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
747747
}
748748

749-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
750-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
749+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
750+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
751751
}
752752

753753
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1138,8 +1138,8 @@ public function setLength($length)
11381138
if (!is_null($length) && ($length > 1000)) {
11391139
throw new \InvalidArgumentException('invalid value for $length when calling FallbackParams., must be smaller than or equal to 1000.');
11401140
}
1141-
if (!is_null($length) && ($length < 1)) {
1142-
throw new \InvalidArgumentException('invalid value for $length when calling FallbackParams., must be bigger than or equal to 1.');
1141+
if (!is_null($length) && ($length < 0)) {
1142+
throw new \InvalidArgumentException('invalid value for $length when calling FallbackParams., must be bigger than or equal to 0.');
11431143
}
11441144

11451145
$this->container['length'] = $length;

‎clients/algoliasearch-client-php/lib/Model/Recommend/SearchParams.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -746,8 +746,8 @@ public function listInvalidProperties()
746746
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
747747
}
748748

749-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
750-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
749+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
750+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
751751
}
752752

753753
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1138,8 +1138,8 @@ public function setLength($length)
11381138
if (!is_null($length) && ($length > 1000)) {
11391139
throw new \InvalidArgumentException('invalid value for $length when calling SearchParams., must be smaller than or equal to 1000.');
11401140
}
1141-
if (!is_null($length) && ($length < 1)) {
1142-
throw new \InvalidArgumentException('invalid value for $length when calling SearchParams., must be bigger than or equal to 1.');
1141+
if (!is_null($length) && ($length < 0)) {
1142+
throw new \InvalidArgumentException('invalid value for $length when calling SearchParams., must be bigger than or equal to 0.');
11431143
}
11441144

11451145
$this->container['length'] = $length;

‎clients/algoliasearch-client-php/lib/Model/Recommend/SearchParamsObject.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -748,8 +748,8 @@ public function listInvalidProperties()
748748
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
749749
}
750750

751-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
752-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
751+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
752+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
753753
}
754754

755755
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1140,8 +1140,8 @@ public function setLength($length)
11401140
if (!is_null($length) && ($length > 1000)) {
11411141
throw new \InvalidArgumentException('invalid value for $length when calling SearchParamsObject., must be smaller than or equal to 1000.');
11421142
}
1143-
if (!is_null($length) && ($length < 1)) {
1144-
throw new \InvalidArgumentException('invalid value for $length when calling SearchParamsObject., must be bigger than or equal to 1.');
1143+
if (!is_null($length) && ($length < 0)) {
1144+
throw new \InvalidArgumentException('invalid value for $length when calling SearchParamsObject., must be bigger than or equal to 0.');
11451145
}
11461146

11471147
$this->container['length'] = $length;

‎clients/algoliasearch-client-php/lib/Model/Search/BrowseParams.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -762,8 +762,8 @@ public function listInvalidProperties()
762762
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
763763
}
764764

765-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
766-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
765+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
766+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
767767
}
768768

769769
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1178,8 +1178,8 @@ public function setLength($length)
11781178
if (!is_null($length) && ($length > 1000)) {
11791179
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParams., must be smaller than or equal to 1000.');
11801180
}
1181-
if (!is_null($length) && ($length < 1)) {
1182-
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParams., must be bigger than or equal to 1.');
1181+
if (!is_null($length) && ($length < 0)) {
1182+
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParams., must be bigger than or equal to 0.');
11831183
}
11841184

11851185
$this->container['length'] = $length;

‎clients/algoliasearch-client-php/lib/Model/Search/BrowseParamsObject.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -754,8 +754,8 @@ public function listInvalidProperties()
754754
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
755755
}
756756

757-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
758-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
757+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
758+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
759759
}
760760

761761
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1146,8 +1146,8 @@ public function setLength($length)
11461146
if (!is_null($length) && ($length > 1000)) {
11471147
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParamsObject., must be smaller than or equal to 1000.');
11481148
}
1149-
if (!is_null($length) && ($length < 1)) {
1150-
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParamsObject., must be bigger than or equal to 1.');
1149+
if (!is_null($length) && ($length < 0)) {
1150+
throw new \InvalidArgumentException('invalid value for $length when calling BrowseParamsObject., must be bigger than or equal to 0.');
11511151
}
11521152

11531153
$this->container['length'] = $length;

‎clients/algoliasearch-client-php/lib/Model/Search/ConsequenceParams.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -762,8 +762,8 @@ public function listInvalidProperties()
762762
$invalidProperties[] = "invalid value for 'length', must be smaller than or equal to 1000.";
763763
}
764764

765-
if (isset($this->container['length']) && ($this->container['length'] < 1)) {
766-
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 1.";
765+
if (isset($this->container['length']) && ($this->container['length'] < 0)) {
766+
$invalidProperties[] = "invalid value for 'length', must be bigger than or equal to 0.";
767767
}
768768

769769
if (isset($this->container['minimumAroundRadius']) && ($this->container['minimumAroundRadius'] < 1)) {
@@ -1130,8 +1130,8 @@ public function setLength($length)
11301130
if (!is_null($length) && ($length > 1000)) {
11311131
throw new \InvalidArgumentException('invalid value for $length when calling ConsequenceParams., must be smaller than or equal to 1000.');
11321132
}
1133-
if (!is_null($length) && ($length < 1)) {
1134-
throw new \InvalidArgumentException('invalid value for $length when calling ConsequenceParams., must be bigger than or equal to 1.');
1133+
if (!is_null($length) && ($length < 0)) {
1134+
throw new \InvalidArgumentException('invalid value for $length when calling ConsequenceParams., must be bigger than or equal to 0.');
11351135
}
11361136

11371137
$this->container['length'] = $length;

0 commit comments

Comments
 (0)