Skip to content

Commit e3ec895

Browse files
algolia-botFluf22
algolia-bot
and
Fluf22
committed
chore: add searchSingleIndex snippet [skip-bc] (#3975) (generated) [skip-ci]
Co-authored-by: Thomas Raffray <[email protected]>
1 parent 4d23232 commit e3ec895

File tree

13 files changed

+147
-38
lines changed

13 files changed

+147
-38
lines changed

‎docs/bundled/search-snippets.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
"default": "var response = await client.SearchRulesAsync(\n \"<YOUR_INDEX_NAME>\",\n new SearchRulesParams { Query = \"zorro\" }\n);"
211211
},
212212
"searchSingleIndex": {
213-
"default": "var response = await client.SearchSingleIndexAsync<Hit>(\"<YOUR_INDEX_NAME>\");"
213+
"default": "var response = await client.SearchSingleIndexAsync<Hit>(\n \"<YOUR_INDEX_NAME>\",\n new SearchParams(\n new SearchParamsObject\n {\n Query = \"myQuery\",\n FacetFilters = new FacetFilters(\n new List<FacetFilters> { new FacetFilters(\"tags:algolia\") }\n ),\n }\n )\n);"
214214
},
215215
"searchSynonyms": {
216216
"default": "var response = await client.SearchSynonymsAsync(\"<YOUR_INDEX_NAME>\");"
@@ -456,7 +456,7 @@
456456
"default": "final response = await client.searchRules(\n indexName: \"<YOUR_INDEX_NAME>\",\n searchRulesParams: SearchRulesParams(\n query: \"zorro\",\n ),\n);"
457457
},
458458
"searchSingleIndex": {
459-
"default": "final response = await client.searchSingleIndex(\n indexName: \"<YOUR_INDEX_NAME>\",\n);"
459+
"default": "final response = await client.searchSingleIndex(\n indexName: \"<YOUR_INDEX_NAME>\",\n searchParams: SearchParamsObject(\n query: \"myQuery\",\n facetFilters: [\n \"tags:algolia\",\n ],\n ),\n);"
460460
},
461461
"searchSynonyms": {
462462
"default": "final response = await client.searchSynonyms(\n indexName: \"<YOUR_INDEX_NAME>\",\n);"
@@ -702,7 +702,7 @@
702702
"default": "response, err := client.SearchRules(client.NewApiSearchRulesRequest(\n \"<YOUR_INDEX_NAME>\",\n).WithSearchRulesParams(\n search.NewEmptySearchRulesParams().SetQuery(\"zorro\")))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
703703
},
704704
"searchSingleIndex": {
705-
"default": "response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(\n \"<YOUR_INDEX_NAME>\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
705+
"default": "response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(\n \"<YOUR_INDEX_NAME>\",\n).WithSearchParams(search.SearchParamsObjectAsSearchParams(\n search.NewEmptySearchParamsObject().SetQuery(\"myQuery\").SetFacetFilters(search.ArrayOfFacetFiltersAsFacetFilters(\n []search.FacetFilters{*search.StringAsFacetFilters(\"tags:algolia\")})))))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
706706
},
707707
"searchSynonyms": {
708708
"default": "response, err := client.SearchSynonyms(client.NewApiSearchSynonymsRequest(\n \"<YOUR_INDEX_NAME>\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}"
@@ -948,7 +948,7 @@
948948
"default": "client.searchRules(\"<YOUR_INDEX_NAME>\", new SearchRulesParams().setQuery(\"zorro\"));"
949949
},
950950
"searchSingleIndex": {
951-
"default": "client.searchSingleIndex(\"<YOUR_INDEX_NAME>\", Hit.class);"
951+
"default": "client.searchSingleIndex(\n \"<YOUR_INDEX_NAME>\",\n new SearchParamsObject().setQuery(\"myQuery\").setFacetFilters(FacetFilters.of(Arrays.asList(FacetFilters.of(\"tags:algolia\")))),\n Hit.class\n);"
952952
},
953953
"searchSynonyms": {
954954
"default": "client.searchSynonyms(\"<YOUR_INDEX_NAME>\");"
@@ -1194,7 +1194,7 @@
11941194
"default": "const response = await client.searchRules({ indexName: 'cts_e2e_browse', searchRulesParams: { query: 'zorro' } });"
11951195
},
11961196
"searchSingleIndex": {
1197-
"default": "const response = await client.searchSingleIndex({ indexName: 'indexName' });"
1197+
"default": "const response = await client.searchSingleIndex({\n indexName: 'indexName',\n searchParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },\n});"
11981198
},
11991199
"searchSynonyms": {
12001200
"default": "const response = await client.searchSynonyms({ indexName: 'indexName' });"
@@ -1440,7 +1440,7 @@
14401440
"default": "var response = client.searchRules(\n indexName = \"<YOUR_INDEX_NAME>\",\n searchRulesParams = SearchRulesParams(\n query = \"zorro\",\n ),\n)"
14411441
},
14421442
"searchSingleIndex": {
1443-
"default": "var response = client.searchSingleIndex(\n indexName = \"<YOUR_INDEX_NAME>\",\n)"
1443+
"default": "var response = client.searchSingleIndex(\n indexName = \"<YOUR_INDEX_NAME>\",\n searchParams = SearchParamsObject(\n query = \"myQuery\",\n facetFilters = FacetFilters.of(listOf(FacetFilters.of(\"tags:algolia\"))),\n ),\n)"
14441444
},
14451445
"searchSynonyms": {
14461446
"default": "var response = client.searchSynonyms(\n indexName = \"<YOUR_INDEX_NAME>\",\n)"
@@ -1686,7 +1686,7 @@
16861686
"default": "$response = $client->searchRules(\n '<YOUR_INDEX_NAME>',\n ['query' => 'zorro',\n ],\n);"
16871687
},
16881688
"searchSingleIndex": {
1689-
"default": "$response = $client->searchSingleIndex(\n '<YOUR_INDEX_NAME>',\n);"
1689+
"default": "$response = $client->searchSingleIndex(\n '<YOUR_INDEX_NAME>',\n ['query' => 'myQuery',\n 'facetFilters' => [\n 'tags:algolia',\n ],\n ],\n);"
16901690
},
16911691
"searchSynonyms": {
16921692
"default": "$response = $client->searchSynonyms(\n '<YOUR_INDEX_NAME>',\n);"
@@ -1932,7 +1932,7 @@
19321932
"default": "response = client.search_rules(\n index_name=\"<YOUR_INDEX_NAME>\",\n search_rules_params={\n \"query\": \"zorro\",\n },\n)"
19331933
},
19341934
"searchSingleIndex": {
1935-
"default": "response = client.search_single_index(\n index_name=\"<YOUR_INDEX_NAME>\",\n)"
1935+
"default": "response = client.search_single_index(\n index_name=\"<YOUR_INDEX_NAME>\",\n search_params={\n \"query\": \"myQuery\",\n \"facetFilters\": [\n \"tags:algolia\",\n ],\n },\n)"
19361936
},
19371937
"searchSynonyms": {
19381938
"default": "response = client.search_synonyms(\n index_name=\"<YOUR_INDEX_NAME>\",\n)"
@@ -2178,7 +2178,7 @@
21782178
"default": "response = client.search_rules(\"<YOUR_INDEX_NAME>\", Algolia::Search::SearchRulesParams.new(query: \"zorro\"))"
21792179
},
21802180
"searchSingleIndex": {
2181-
"default": "response = client.search_single_index(\"<YOUR_INDEX_NAME>\")"
2181+
"default": "response = client.search_single_index(\n \"<YOUR_INDEX_NAME>\",\n Algolia::Search::SearchParamsObject.new(query: \"myQuery\", facet_filters: [\"tags:algolia\"])\n)"
21822182
},
21832183
"searchSynonyms": {
21842184
"default": "response = client.search_synonyms(\"<YOUR_INDEX_NAME>\")"
@@ -2401,7 +2401,7 @@
24012401
"default": "val response = client.searchRules(\n indexName = \"<YOUR_INDEX_NAME>\",\n searchRulesParams = Some(\n SearchRulesParams(\n query = Some(\"zorro\")\n )\n )\n)"
24022402
},
24032403
"searchSingleIndex": {
2404-
"default": "val response = client.searchSingleIndex(\n indexName = \"<YOUR_INDEX_NAME>\"\n)"
2404+
"default": "val response = client.searchSingleIndex(\n indexName = \"<YOUR_INDEX_NAME>\",\n searchParams = Some(\n SearchParamsObject(\n query = Some(\"myQuery\"),\n facetFilters = Some(FacetFilters(Seq(FacetFilters(\"tags:algolia\"))))\n )\n )\n)"
24052405
},
24062406
"searchSynonyms": {
24072407
"default": "val response = client.searchSynonyms(\n indexName = \"<YOUR_INDEX_NAME>\"\n)"
@@ -2633,7 +2633,7 @@
26332633
"default": "let response = try await client.searchRules(\n indexName: \"<YOUR_INDEX_NAME>\",\n searchRulesParams: SearchRulesParams(query: \"zorro\")\n)"
26342634
},
26352635
"searchSingleIndex": {
2636-
"default": "let response: SearchResponse<Hit> = try await client.searchSingleIndex(indexName: \"<YOUR_INDEX_NAME>\")"
2636+
"default": "let response: SearchResponse<Hit> = try await client.searchSingleIndex(\n indexName: \"<YOUR_INDEX_NAME>\",\n searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(\n query: \"myQuery\",\n facetFilters: SearchFacetFilters.arrayOfSearchFacetFilters([SearchFacetFilters.string(\"tags:algolia\")])\n ))\n)"
26372637
},
26382638
"searchSynonyms": {
26392639
"default": "let response = try await client.searchSynonyms(indexName: \"<YOUR_INDEX_NAME>\")"

‎docs/snippets/csharp/src/Search.cs

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1885,7 +1885,7 @@ public async Task SnippetForSearchClientSearchRules()
18851885
/// <summary>
18861886
/// Snippet for the SearchSingleIndex method.
18871887
///
1888-
/// search with minimal parameters
1888+
/// search with searchParams
18891889
/// </summary>
18901890
public async Task SnippetForSearchClientSearchSingleIndex()
18911891
{
@@ -1894,7 +1894,18 @@ public async Task SnippetForSearchClientSearchSingleIndex()
18941894
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
18951895

18961896
// Call the API
1897-
var response = await client.SearchSingleIndexAsync<Hit>("<YOUR_INDEX_NAME>");
1897+
var response = await client.SearchSingleIndexAsync<Hit>(
1898+
"<YOUR_INDEX_NAME>",
1899+
new SearchParams(
1900+
new SearchParamsObject
1901+
{
1902+
Query = "myQuery",
1903+
FacetFilters = new FacetFilters(
1904+
new List<FacetFilters> { new FacetFilters("tags:algolia") }
1905+
),
1906+
}
1907+
)
1908+
);
18981909
// >LOG
18991910
// SEPARATOR<
19001911
}

‎docs/snippets/dart/lib/search.dart

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1834,7 +1834,7 @@ void snippetForsearchRules() async {
18341834

18351835
// Snippet for the searchSingleIndex method.
18361836
//
1837-
// search with minimal parameters
1837+
// search with searchParams
18381838
void snippetForsearchSingleIndex() async {
18391839
// >SEPARATOR searchSingleIndex default
18401840
// Initialize the client
@@ -1844,6 +1844,12 @@ void snippetForsearchSingleIndex() async {
18441844
// Call the API
18451845
final response = await client.searchSingleIndex(
18461846
indexName: "<YOUR_INDEX_NAME>",
1847+
searchParams: SearchParamsObject(
1848+
query: "myQuery",
1849+
facetFilters: [
1850+
"tags:algolia",
1851+
],
1852+
),
18471853
);
18481854
// >LOG
18491855
// SEPARATOR<

‎docs/snippets/go/src/search.go

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

‎docs/snippets/java/src/test/java/com/algolia/Search.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1618,14 +1618,18 @@ void snippetForSearchRules() throws Exception {
16181618

16191619
// Snippet for the searchSingleIndex method.
16201620
//
1621-
// search with minimal parameters
1621+
// search with searchParams
16221622
void snippetForSearchSingleIndex() throws Exception {
16231623
// >SEPARATOR searchSingleIndex default
16241624
// Initialize the client
16251625
SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
16261626

16271627
// Call the API
1628-
client.searchSingleIndex("<YOUR_INDEX_NAME>", Hit.class);
1628+
client.searchSingleIndex(
1629+
"<YOUR_INDEX_NAME>",
1630+
new SearchParamsObject().setQuery("myQuery").setFacetFilters(FacetFilters.of(Arrays.asList(FacetFilters.of("tags:algolia")))),
1631+
Hit.class
1632+
);
16291633
// >LOG
16301634
// SEPARATOR<
16311635
}

‎docs/snippets/javascript/src/search.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1681,15 +1681,18 @@ export async function snippetForSearchRules(): Promise<void> {
16811681

16821682
// Snippet for the searchSingleIndex method.
16831683
//
1684-
// search with minimal parameters
1684+
// search with searchParams
16851685
export async function snippetForSearchSingleIndex(): Promise<void> {
16861686
// >SEPARATOR searchSingleIndex default
16871687
// Initialize the client
16881688
//
16891689
const client = searchClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
16901690

16911691
// Call the API
1692-
const response = await client.searchSingleIndex({ indexName: 'indexName' });
1692+
const response = await client.searchSingleIndex({
1693+
indexName: 'indexName',
1694+
searchParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },
1695+
});
16931696

16941697
// >LOG
16951698
// use typed response

‎docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2036,6 +2036,10 @@ class SnippetSearchClient {
20362036
// Call the API
20372037
var response = client.searchSingleIndex(
20382038
indexName = "<YOUR_INDEX_NAME>",
2039+
searchParams = SearchParamsObject(
2040+
query = "myQuery",
2041+
facetFilters = FacetFilters.of(listOf(FacetFilters.of("tags:algolia"))),
2042+
),
20392043
)
20402044

20412045
// >LOG

‎docs/snippets/php/src/Search.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2193,7 +2193,7 @@ public function snippetForSearchRules(): void
21932193
/**
21942194
* Snippet for the SearchSingleIndex method.
21952195
*
2196-
* search with minimal parameters
2196+
* search with searchParams
21972197
*/
21982198
public function snippetForSearchSingleIndex(): void
21992199
{
@@ -2204,6 +2204,11 @@ public function snippetForSearchSingleIndex(): void
22042204
// Call the API
22052205
$response = $client->searchSingleIndex(
22062206
'<YOUR_INDEX_NAME>',
2207+
['query' => 'myQuery',
2208+
'facetFilters' => [
2209+
'tags:algolia',
2210+
],
2211+
],
22072212
);
22082213

22092214
// >LOG

‎docs/snippets/python/search.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2247,7 +2247,7 @@ def snippet_for_search_single_index():
22472247
"""
22482248
Snippet for the searchSingleIndex method.
22492249
2250-
search with minimal parameters
2250+
search with searchParams
22512251
"""
22522252
# >SEPARATOR searchSingleIndex default
22532253
# Initialize the client
@@ -2257,6 +2257,12 @@ def snippet_for_search_single_index():
22572257
# Call the API
22582258
response = client.search_single_index(
22592259
index_name="<YOUR_INDEX_NAME>",
2260+
search_params={
2261+
"query": "myQuery",
2262+
"facetFilters": [
2263+
"tags:algolia",
2264+
],
2265+
},
22602266
)
22612267

22622268
# >LOG

‎docs/snippets/ruby/search.rb

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1910,14 +1910,17 @@ def snippet_for_search_rules
19101910

19111911
# Snippet for the searchSingleIndex method.
19121912
#
1913-
# search with minimal parameters
1913+
# search with searchParams
19141914
def snippet_for_search_single_index
19151915
# >SEPARATOR searchSingleIndex default
19161916
# Initialize the client
19171917
client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
19181918

19191919
# Call the API
1920-
response = client.search_single_index("<YOUR_INDEX_NAME>")
1920+
response = client.search_single_index(
1921+
"<YOUR_INDEX_NAME>",
1922+
Algolia::Search::SearchParamsObject.new(query: "myQuery", facet_filters: ["tags:algolia"])
1923+
)
19211924

19221925
# >LOG
19231926
# use the class directly

‎docs/snippets/scala/src/main/scala/Search.scala

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1712,7 +1712,7 @@ class SnippetSearchClient {
17121712

17131713
/** Snippet for the searchSingleIndex method.
17141714
*
1715-
* search with minimal parameters
1715+
* search with searchParams
17161716
*/
17171717
def snippetForSearchClientSearchSingleIndex(): Unit = {
17181718
// >SEPARATOR searchSingleIndex default
@@ -1721,7 +1721,13 @@ class SnippetSearchClient {
17211721

17221722
// Call the API
17231723
val response = client.searchSingleIndex(
1724-
indexName = "<YOUR_INDEX_NAME>"
1724+
indexName = "<YOUR_INDEX_NAME>",
1725+
searchParams = Some(
1726+
SearchParamsObject(
1727+
query = Some("myQuery"),
1728+
facetFilters = Some(FacetFilters(Seq(FacetFilters("tags:algolia"))))
1729+
)
1730+
)
17251731
)
17261732

17271733
// >LOG

‎docs/snippets/swift/Sources/Search.swift

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1422,14 +1422,20 @@ final class SearchClientSnippet {
14221422

14231423
/// Snippet for the searchSingleIndex method.
14241424
///
1425-
/// search with minimal parameters
1425+
/// search with searchParams
14261426
func snippetForSearchSingleIndex() async throws {
14271427
// >SEPARATOR searchSingleIndex default
14281428
// Initialize the client
14291429
let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
14301430

14311431
// Call the API
1432-
let response: SearchResponse<Hit> = try await client.searchSingleIndex(indexName: "<YOUR_INDEX_NAME>")
1432+
let response: SearchResponse<Hit> = try await client.searchSingleIndex(
1433+
indexName: "<YOUR_INDEX_NAME>",
1434+
searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
1435+
query: "myQuery",
1436+
facetFilters: SearchFacetFilters.arrayOfSearchFacetFilters([SearchFacetFilters.string("tags:algolia")])
1437+
))
1438+
)
14331439
// >LOG
14341440
// SEPARATOR<
14351441
}

0 commit comments

Comments
 (0)