Skip to content

Commit c38e91b

Browse files
algolia-botshortcutskai687millotp
committed
chore(specs): change oneOf order for docs (#5676) (generated) [skip ci]
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com> Co-authored-by: Kai Welke <kai.welke@algolia.com> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
1 parent bc8460c commit c38e91b

File tree

30 files changed

+521
-57
lines changed

30 files changed

+521
-57
lines changed

‎clients/algoliasearch-client-javascript/packages/client-search/model/browseParams.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ import type { BrowseParamsObject } from './browseParamsObject';
44

55
import type { SearchParamsString } from './searchParamsString';
66

7-
export type BrowseParams = SearchParamsString | BrowseParamsObject;
7+
export type BrowseParams = BrowseParamsObject | SearchParamsString;

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

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
2020
* @var string[]
2121
*/
2222
protected static $modelTypes = [
23-
'params' => 'string',
2423
'query' => 'string',
2524
'similarQuery' => 'string',
2625
'filters' => 'string',
@@ -95,6 +94,7 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
9594
'enableReRanking' => 'bool',
9695
'reRankingApplyFilter' => '\Algolia\AlgoliaSearch\Model\Search\ReRankingApplyFilter',
9796
'cursor' => 'string',
97+
'params' => 'string',
9898
];
9999

100100
/**
@@ -103,7 +103,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
103103
* @var string[]
104104
*/
105105
protected static $modelFormats = [
106-
'params' => null,
107106
'query' => null,
108107
'similarQuery' => null,
109108
'filters' => null,
@@ -178,6 +177,7 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
178177
'enableReRanking' => null,
179178
'reRankingApplyFilter' => null,
180179
'cursor' => null,
180+
'params' => null,
181181
];
182182

183183
/**
@@ -187,7 +187,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
187187
* @var string[]
188188
*/
189189
protected static $attributeMap = [
190-
'params' => 'params',
191190
'query' => 'query',
192191
'similarQuery' => 'similarQuery',
193192
'filters' => 'filters',
@@ -262,6 +261,7 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
262261
'enableReRanking' => 'enableReRanking',
263262
'reRankingApplyFilter' => 'reRankingApplyFilter',
264263
'cursor' => 'cursor',
264+
'params' => 'params',
265265
];
266266

267267
/**
@@ -270,7 +270,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
270270
* @var string[]
271271
*/
272272
protected static $setters = [
273-
'params' => 'setParams',
274273
'query' => 'setQuery',
275274
'similarQuery' => 'setSimilarQuery',
276275
'filters' => 'setFilters',
@@ -345,6 +344,7 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
345344
'enableReRanking' => 'setEnableReRanking',
346345
'reRankingApplyFilter' => 'setReRankingApplyFilter',
347346
'cursor' => 'setCursor',
347+
'params' => 'setParams',
348348
];
349349

350350
/**
@@ -353,7 +353,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
353353
* @var string[]
354354
*/
355355
protected static $getters = [
356-
'params' => 'getParams',
357356
'query' => 'getQuery',
358357
'similarQuery' => 'getSimilarQuery',
359358
'filters' => 'getFilters',
@@ -428,6 +427,7 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
428427
'enableReRanking' => 'getEnableReRanking',
429428
'reRankingApplyFilter' => 'getReRankingApplyFilter',
430429
'cursor' => 'getCursor',
430+
'params' => 'getParams',
431431
];
432432

433433
/**
@@ -444,9 +444,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
444444
*/
445445
public function __construct(?array $data = null)
446446
{
447-
if (isset($data['params'])) {
448-
$this->container['params'] = $data['params'];
449-
}
450447
if (isset($data['query'])) {
451448
$this->container['query'] = $data['query'];
452449
}
@@ -669,6 +666,9 @@ public function __construct(?array $data = null)
669666
if (isset($data['cursor'])) {
670667
$this->container['cursor'] = $data['cursor'];
671668
}
669+
if (isset($data['params'])) {
670+
$this->container['params'] = $data['params'];
671+
}
672672
}
673673

674674
/**
@@ -743,30 +743,6 @@ public function valid()
743743
return 0 === count($this->listInvalidProperties());
744744
}
745745

746-
/**
747-
* Gets params.
748-
*
749-
* @return null|string
750-
*/
751-
public function getParams()
752-
{
753-
return $this->container['params'] ?? null;
754-
}
755-
756-
/**
757-
* Sets params.
758-
*
759-
* @param null|string $params search parameters as a URL-encoded query string
760-
*
761-
* @return self
762-
*/
763-
public function setParams($params)
764-
{
765-
$this->container['params'] = $params;
766-
767-
return $this;
768-
}
769-
770746
/**
771747
* Gets query.
772748
*
@@ -2543,6 +2519,30 @@ public function setCursor($cursor)
25432519
return $this;
25442520
}
25452521

2522+
/**
2523+
* Gets params.
2524+
*
2525+
* @return null|string
2526+
*/
2527+
public function getParams()
2528+
{
2529+
return $this->container['params'] ?? null;
2530+
}
2531+
2532+
/**
2533+
* Sets params.
2534+
*
2535+
* @param null|string $params search parameters as a URL-encoded query string
2536+
*
2537+
* @return self
2538+
*/
2539+
public function setParams($params)
2540+
{
2541+
$this->container['params'] = $params;
2542+
2543+
return $this;
2544+
}
2545+
25462546
/**
25472547
* Returns true if offset exists. False otherwise.
25482548
*

‎clients/algoliasearch-client-python/algoliasearch/search/models/browse_params.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ class BrowseParams(BaseModel):
2727
BrowseParams
2828
"""
2929

30-
oneof_schema_1_validator: Optional[SearchParamsString] = Field(default=None)
30+
oneof_schema_1_validator: Optional[BrowseParamsObject] = Field(default=None)
3131

32-
oneof_schema_2_validator: Optional[BrowseParamsObject] = Field(default=None)
32+
oneof_schema_2_validator: Optional[SearchParamsString] = Field(default=None)
3333

3434
actual_instance: Union[BrowseParamsObject, SearchParamsString, None] = None
3535
one_of_schemas: Set[str] = {"BrowseParamsObject", "SearchParamsString"}
@@ -69,13 +69,13 @@ def from_json(cls, json_str: str) -> Self:
6969
error_messages = []
7070

7171
try:
72-
instance.actual_instance = SearchParamsString.from_json(json_str)
72+
instance.actual_instance = BrowseParamsObject.from_json(json_str)
7373

7474
return instance
7575
except (ValidationError, ValueError) as e:
7676
error_messages.append(str(e))
7777
try:
78-
instance.actual_instance = BrowseParamsObject.from_json(json_str)
78+
instance.actual_instance = SearchParamsString.from_json(json_str)
7979

8080
return instance
8181
except (ValidationError, ValueError) as e:

‎docs/bundled/search-snippets.json‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737
"browse": {
3838
"browse with minimal parameters": "var response = await client.BrowseAsync<Hit>(\"<YOUR_INDEX_NAME>\");",
3939
"browse with search parameters": "var response = await client.BrowseAsync<Hit>(\n \"<YOUR_INDEX_NAME>\",\n new BrowseParams(\n new BrowseParamsObject\n {\n Query = \"myQuery\",\n FacetFilters = new FacetFilters(\n new List<FacetFilters> { new FacetFilters(\"tags:algolia\") }\n ),\n }\n )\n);",
40-
"browse allow a cursor in parameters": "var response = await client.BrowseAsync<Hit>(\n \"<YOUR_INDEX_NAME>\",\n new BrowseParams(new BrowseParamsObject { Cursor = \"test\" })\n);"
40+
"browse allow a cursor in parameters": "var response = await client.BrowseAsync<Hit>(\n \"<YOUR_INDEX_NAME>\",\n new BrowseParams(new BrowseParamsObject { Cursor = \"test\" })\n);",
41+
"browse with query string": "var response = await client.BrowseAsync<Hit>(\n \"<YOUR_INDEX_NAME>\",\n new BrowseParams(new SearchParamsString { Params = \"foo=bar&cursor=test\" })\n);"
4142
},
4243
"clearObjects": {
4344
"default": "var response = await client.ClearObjectsAsync(\"<YOUR_INDEX_NAME>\");"
@@ -627,7 +628,8 @@
627628
"browse": {
628629
"browse with minimal parameters": "final response = await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n);",
629630
"browse with search parameters": "final response = await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParamsObject(\n query: \"myQuery\",\n facetFilters: [\n \"tags:algolia\",\n ],\n ),\n);",
630-
"browse allow a cursor in parameters": "final response = await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParamsObject(\n cursor: \"test\",\n ),\n);"
631+
"browse allow a cursor in parameters": "final response = await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParamsObject(\n cursor: \"test\",\n ),\n);",
632+
"browse with query string": "final response = await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: SearchParamsString(\n params: \"foo=bar&cursor=test\",\n ),\n);"
631633
},
632634
"clearObjects": {
633635
"default": "final response = await client.clearObjects(\n indexName: \"<YOUR_INDEX_NAME>\",\n);"
@@ -1165,7 +1167,8 @@
11651167
"browse": {
11661168
"browse with minimal parameters": "response, err := client.Browse(client.NewApiBrowseRequest(\n \"<YOUR_INDEX_NAME>\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}",
11671169
"browse with search parameters": "response, err := client.Browse(client.NewApiBrowseRequest(\n \"<YOUR_INDEX_NAME>\").WithBrowseParams(search.BrowseParamsObjectAsBrowseParams(\n search.NewEmptyBrowseParamsObject().SetQuery(\"myQuery\").SetFacetFilters(search.ArrayOfFacetFiltersAsFacetFilters(\n []search.FacetFilters{*search.StringAsFacetFilters(\"tags:algolia\")})))))\nif err != nil {\n // handle the eventual error\n panic(err)\n}",
1168-
"browse allow a cursor in parameters": "response, err := client.Browse(client.NewApiBrowseRequest(\n \"<YOUR_INDEX_NAME>\").WithBrowseParams(search.BrowseParamsObjectAsBrowseParams(\n search.NewEmptyBrowseParamsObject().SetCursor(\"test\"))))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
1170+
"browse allow a cursor in parameters": "response, err := client.Browse(client.NewApiBrowseRequest(\n \"<YOUR_INDEX_NAME>\").WithBrowseParams(search.BrowseParamsObjectAsBrowseParams(\n search.NewEmptyBrowseParamsObject().SetCursor(\"test\"))))\nif err != nil {\n // handle the eventual error\n panic(err)\n}",
1171+
"browse with query string": "response, err := client.Browse(client.NewApiBrowseRequest(\n \"<YOUR_INDEX_NAME>\").WithBrowseParams(search.SearchParamsStringAsBrowseParams(\n search.NewEmptySearchParamsString().SetParams(\"foo=bar&cursor=test\"))))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
11691172
},
11701173
"clearObjects": {
11711174
"default": "response, err := client.ClearObjects(client.NewApiClearObjectsRequest(\n \"<YOUR_INDEX_NAME>\"))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
@@ -1755,7 +1758,8 @@
17551758
"browse": {
17561759
"browse with minimal parameters": "BrowseResponse response = client.browse(\"<YOUR_INDEX_NAME>\", Hit.class);",
17571760
"browse with search parameters": "BrowseResponse response = client.browse(\n \"<YOUR_INDEX_NAME>\",\n new BrowseParamsObject().setQuery(\"myQuery\").setFacetFilters(FacetFilters.of(Arrays.asList(FacetFilters.of(\"tags:algolia\")))),\n Hit.class\n);",
1758-
"browse allow a cursor in parameters": "BrowseResponse response = client.browse(\"<YOUR_INDEX_NAME>\", new BrowseParamsObject().setCursor(\"test\"), Hit.class);"
1761+
"browse allow a cursor in parameters": "BrowseResponse response = client.browse(\"<YOUR_INDEX_NAME>\", new BrowseParamsObject().setCursor(\"test\"), Hit.class);",
1762+
"browse with query string": "BrowseResponse response = client.browse(\"<YOUR_INDEX_NAME>\", new SearchParamsString().setParams(\"foo=bar&cursor=test\"), Hit.class);"
17591763
},
17601764
"clearObjects": {
17611765
"default": "UpdatedAtResponse response = client.clearObjects(\"<YOUR_INDEX_NAME>\");"
@@ -2348,7 +2352,8 @@
23482352
"browse": {
23492353
"browse with minimal parameters": "const response = await client.browse({ indexName: 'cts_e2e_browse' });",
23502354
"browse with search parameters": "const response = await client.browse({\n indexName: 'indexName',\n browseParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },\n});",
2351-
"browse allow a cursor in parameters": "const response = await client.browse({ indexName: 'indexName', browseParams: { cursor: 'test' } });"
2355+
"browse allow a cursor in parameters": "const response = await client.browse({ indexName: 'indexName', browseParams: { cursor: 'test' } });",
2356+
"browse with query string": "const response = await client.browse({ indexName: 'indexName', browseParams: { params: 'foo=bar&cursor=test' } });"
23522357
},
23532358
"clearObjects": {
23542359
"default": "const response = await client.clearObjects({ indexName: 'theIndexName' });"
@@ -2935,7 +2940,8 @@
29352940
"browse": {
29362941
"browse with minimal parameters": "var response = client.browse(indexName = \"<YOUR_INDEX_NAME>\")",
29372942
"browse with search parameters": "var response =\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams =\n BrowseParamsObject(\n query = \"myQuery\",\n facetFilters = FacetFilters.of(listOf(FacetFilters.of(\"tags:algolia\"))),\n ),\n )",
2938-
"browse allow a cursor in parameters": "var response =\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = BrowseParamsObject(cursor = \"test\"),\n )"
2943+
"browse allow a cursor in parameters": "var response =\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = BrowseParamsObject(cursor = \"test\"),\n )",
2944+
"browse with query string": "var response =\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = SearchParamsString(params = \"foo=bar&cursor=test\"),\n )"
29392945
},
29402946
"clearObjects": {
29412947
"default": "var response = client.clearObjects(indexName = \"<YOUR_INDEX_NAME>\")"
@@ -3516,7 +3522,8 @@
35163522
"browse": {
35173523
"browse with minimal parameters": "$response = $client->browse(\n '<YOUR_INDEX_NAME>',\n);",
35183524
"browse with search parameters": "$response = $client->browse(\n '<YOUR_INDEX_NAME>',\n ['query' => 'myQuery',\n 'facetFilters' => [\n 'tags:algolia',\n ],\n ],\n);",
3519-
"browse allow a cursor in parameters": "$response = $client->browse(\n '<YOUR_INDEX_NAME>',\n ['cursor' => 'test',\n ],\n);"
3525+
"browse allow a cursor in parameters": "$response = $client->browse(\n '<YOUR_INDEX_NAME>',\n ['cursor' => 'test',\n ],\n);",
3526+
"browse with query string": "$response = $client->browse(\n '<YOUR_INDEX_NAME>',\n ['params' => 'foo=bar&cursor=test',\n ],\n);"
35203527
},
35213528
"clearObjects": {
35223529
"default": "$response = $client->clearObjects(\n '<YOUR_INDEX_NAME>',\n);"
@@ -4106,7 +4113,8 @@
41064113
"browse": {
41074114
"browse with minimal parameters": "response = client.browse(\n index_name=\"<YOUR_INDEX_NAME>\",\n)",
41084115
"browse with search parameters": "response = client.browse(\n index_name=\"<YOUR_INDEX_NAME>\",\n browse_params={\n \"query\": \"myQuery\",\n \"facetFilters\": [\n \"tags:algolia\",\n ],\n },\n)",
4109-
"browse allow a cursor in parameters": "response = client.browse(\n index_name=\"<YOUR_INDEX_NAME>\",\n browse_params={\n \"cursor\": \"test\",\n },\n)"
4116+
"browse allow a cursor in parameters": "response = client.browse(\n index_name=\"<YOUR_INDEX_NAME>\",\n browse_params={\n \"cursor\": \"test\",\n },\n)",
4117+
"browse with query string": "response = client.browse(\n index_name=\"<YOUR_INDEX_NAME>\",\n browse_params={\n \"params\": \"foo=bar&cursor=test\",\n },\n)"
41104118
},
41114119
"clearObjects": {
41124120
"default": "response = client.clear_objects(\n index_name=\"<YOUR_INDEX_NAME>\",\n)"
@@ -4696,7 +4704,8 @@
46964704
"browse": {
46974705
"browse with minimal parameters": "response = client.browse(\"<YOUR_INDEX_NAME>\")",
46984706
"browse with search parameters": "response = client.browse(\n \"<YOUR_INDEX_NAME>\",\n Algolia::Search::BrowseParamsObject.new(query: \"myQuery\", facet_filters: [\"tags:algolia\"])\n)",
4699-
"browse allow a cursor in parameters": "response = client.browse(\"<YOUR_INDEX_NAME>\", Algolia::Search::BrowseParamsObject.new(cursor: \"test\"))"
4707+
"browse allow a cursor in parameters": "response = client.browse(\"<YOUR_INDEX_NAME>\", Algolia::Search::BrowseParamsObject.new(cursor: \"test\"))",
4708+
"browse with query string": "response = client.browse(\"<YOUR_INDEX_NAME>\", Algolia::Search::SearchParamsString.new(params: \"foo=bar&cursor=test\"))"
47004709
},
47014710
"clearObjects": {
47024711
"default": "response = client.clear_objects(\"<YOUR_INDEX_NAME>\")"
@@ -5277,7 +5286,8 @@
52775286
"browse": {
52785287
"browse with minimal parameters": "val response = Await.result(\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\"\n ),\n Duration(100, \"sec\")\n)",
52795288
"browse with search parameters": "val response = Await.result(\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = Some(\n BrowseParamsObject(\n query = Some(\"myQuery\"),\n facetFilters = Some(FacetFilters(Seq(FacetFilters(\"tags:algolia\"))))\n )\n )\n ),\n Duration(100, \"sec\")\n)",
5280-
"browse allow a cursor in parameters": "val response = Await.result(\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = Some(\n BrowseParamsObject(\n cursor = Some(\"test\")\n )\n )\n ),\n Duration(100, \"sec\")\n)"
5289+
"browse allow a cursor in parameters": "val response = Await.result(\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = Some(\n BrowseParamsObject(\n cursor = Some(\"test\")\n )\n )\n ),\n Duration(100, \"sec\")\n)",
5290+
"browse with query string": "val response = Await.result(\n client.browse(\n indexName = \"<YOUR_INDEX_NAME>\",\n browseParams = Some(\n SearchParamsString(\n params = Some(\"foo=bar&cursor=test\")\n )\n )\n ),\n Duration(100, \"sec\")\n)"
52815291
},
52825292
"clearObjects": {
52835293
"default": "val response = Await.result(\n client.clearObjects(\n indexName = \"<YOUR_INDEX_NAME>\"\n ),\n Duration(100, \"sec\")\n)"
@@ -5858,7 +5868,8 @@
58585868
"browse": {
58595869
"browse with minimal parameters": "let response: BrowseResponse<Hit> = try await client.browse(indexName: \"<YOUR_INDEX_NAME>\")",
58605870
"browse with search parameters": "let response: BrowseResponse<Hit> = try await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParams.browseParamsObject(BrowseParamsObject(\n query: \"myQuery\",\n facetFilters: SearchFacetFilters.arrayOfSearchFacetFilters([SearchFacetFilters.string(\"tags:algolia\")])\n ))\n)",
5861-
"browse allow a cursor in parameters": "let response: BrowseResponse<Hit> = try await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParams.browseParamsObject(BrowseParamsObject(cursor: \"test\"))\n)"
5871+
"browse allow a cursor in parameters": "let response: BrowseResponse<Hit> = try await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParams.browseParamsObject(BrowseParamsObject(cursor: \"test\"))\n)",
5872+
"browse with query string": "let response: BrowseResponse<Hit> = try await client.browse(\n indexName: \"<YOUR_INDEX_NAME>\",\n browseParams: BrowseParams.searchParamsString(SearchParamsString(params: \"foo=bar&cursor=test\"))\n)"
58625873
},
58635874
"clearObjects": {
58645875
"default": "let response = try await client.clearObjects(indexName: \"<YOUR_INDEX_NAME>\")"

‎docs/bundled/search.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5060,7 +5060,7 @@
50605060
},
50615061
"searchParamsString": {
50625062
"type": "object",
5063-
"title": "Search parameters as query string.",
5063+
"title": "Search parameters as query string",
50645064
"description": "Search parameters as query string.",
50655065
"additionalProperties": false,
50665066
"x-discriminator-fields": [
@@ -7390,10 +7390,11 @@
73907390
"browseParams": {
73917391
"oneOf": [
73927392
{
7393-
"$ref": "#/components/schemas/searchParamsString"
7393+
"title": "Search parameters as object",
7394+
"$ref": "#/components/schemas/browseParamsObject"
73947395
},
73957396
{
7396-
"$ref": "#/components/schemas/browseParamsObject"
7397+
"$ref": "#/components/schemas/searchParamsString"
73977398
}
73987399
]
73997400
},

0 commit comments

Comments
 (0)