Skip to content

Commit 3dbaeae

Browse files
committed
docs: replace links for the new doc
1 parent eafef18 commit 3dbaeae

File tree

20 files changed

+56
-58
lines changed

20 files changed

+56
-58
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ The Algolia API clients are generated from [OpenAPI specs](https://swagger.io/sp
1717

1818
**Migration note from current API clients**
1919

20-
> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://www.algolia.com/doc/libraries/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
20+
> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://www.algolia.com/doc/libraries/sdk/upgrade). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
2121
2222
## 💡 Getting Started with the clients
2323

24-
You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/).
24+
You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/sdk/install).
2525

2626
## ✨ Contributing
2727

clients/algoliasearch-client-csharp/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</p>
1313

1414
<p align="center">
15-
<a href="https://www.algolia.com/doc/libraries/csharp/v7/" target="_blank">Documentation</a> •
15+
<a href="https://www.algolia.com/doc/libraries/sdk/install#c%23" target="_blank">Documentation</a> •
1616
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-csharp/issues" target="_blank">Report a bug</a> •
@@ -32,7 +32,7 @@
3232

3333
**Migration note from v5.x to v6.x**
3434

35-
> In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the [migration guide to version 6.x](https://www.algolia.com/doc/api-client/getting-started/upgrade-guides/csharp/).
35+
> In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the [migration guide to version 6.x](https://www.algolia.com/doc/libraries/sdk/v1/upgrade/csharp).
3636
Version 5.x will **no longer** be under active development.
3737

3838
## 💡 Getting Started
@@ -89,7 +89,7 @@ var response = await client.SearchAsync<Object>(
8989
);
9090
```
9191

92-
For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**.
92+
For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/sdk/install#c%23)**.
9393

9494
## ❓ Troubleshooting
9595

clients/algoliasearch-client-csharp/algoliasearch/Serializer/EnumConverter.cs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,21 +91,21 @@ JsonSerializerOptions options
9191
switch (type)
9292
{
9393
case JsonTokenType.String:
94+
{
95+
var stringValue = reader.GetString();
96+
if (stringValue != null && _stringToEnum.TryGetValue(stringValue, out var enumValue))
9497
{
95-
var stringValue = reader.GetString();
96-
if (stringValue != null && _stringToEnum.TryGetValue(stringValue, out var enumValue))
97-
{
98-
return enumValue;
99-
}
100-
101-
break;
102-
}
103-
case JsonTokenType.Number:
104-
{
105-
var numValue = reader.GetInt32();
106-
_numberToEnum.TryGetValue(numValue, out var enumValue);
10798
return enumValue;
10899
}
100+
101+
break;
102+
}
103+
case JsonTokenType.Number:
104+
{
105+
var numValue = reader.GetInt32();
106+
_numberToEnum.TryGetValue(numValue, out var enumValue);
107+
return enumValue;
108+
}
109109
}
110110

111111
return default;

clients/algoliasearch-client-csharp/algoliasearch/Utils/QueryStringHelper.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@ public static string ParameterToString(object obj)
3636
case bool boolean:
3737
return boolean ? "true" : "false";
3838
case ICollection collection:
39-
{
40-
var entries = new List<string>();
41-
foreach (var entry in collection)
42-
entries.Add(ParameterToString(entry));
43-
return string.Join(",", entries);
44-
}
39+
{
40+
var entries = new List<string>();
41+
foreach (var entry in collection)
42+
entries.Add(ParameterToString(entry));
43+
return string.Join(",", entries);
44+
}
4545
case Enum when HasEnumMemberAttrValue(obj):
4646
return GetEnumMemberAttrValue(obj);
4747
case AbstractSchema schema when obj.GetType().IsClass:
48-
{
49-
return ParameterToString(schema.ActualInstance);
50-
}
48+
{
49+
return ParameterToString(schema.ActualInstance);
50+
}
5151
default:
5252
return Convert.ToString(obj, CultureInfo.InvariantCulture);
5353
}

clients/algoliasearch-client-go/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
</p>
1616

1717
<p align="center">
18-
<a href="https://www.algolia.com/doc/libraries/go/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/libraries/sdk/install#go" target="_blank">Documentation</a> •
1919
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
2020
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2121
<a href="https://github.com/algolia/algoliasearch-client-go/issues" target="_blank">Report a bug</a> •
@@ -79,7 +79,7 @@ if err != nil {
7979
print(response)
8080
```
8181

82-
For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/go/)**.
82+
For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/sdk/install#go)**.
8383

8484
## ❓ Troubleshooting
8585

clients/algoliasearch-client-java/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</p>
1313

1414
<p align="center">
15-
<a href="https://www.algolia.com/doc/libraries/java/" target="_blank">Documentation</a> •
15+
<a href="https://www.algolia.com/doc/libraries/sdk/install#java" target="_blank">Documentation</a> •
1616
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-java/issues" target="_blank">Report a bug</a> •
@@ -68,7 +68,7 @@ client.search(
6868
);
6969
```
7070

71-
For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/java/)**.
71+
For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/sdk/install#java)**.
7272

7373
## ❓ Troubleshooting
7474

clients/algoliasearch-client-javascript/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@
1414
</p>
1515

1616
<p align="center">
17-
<a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a> •
17+
<a href="https://www.algolia.com/doc/libraries/sdk/install#javascript" target="_blank">Documentation</a> •
1818
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
1919
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
2020
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2121
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22-
<a href="https://www.algolia.com/doc/libraries/javascript/v5/" target="_blank">FAQ</a> •
2322
<a href="https://alg.li/support" target="_blank">Support</a>
2423
</p>
2524

@@ -72,11 +71,11 @@ import { liteClient } from 'algoliasearch/lite';
7271
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
7372
```
7473

75-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
74+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/search/)**.
7675

7776
## ❓ Troubleshooting
7877

79-
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
78+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/en-us/sections/15061037630609-API-Client-FAQs) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
8079

8180
## 📄 License
8281

clients/algoliasearch-client-kotlin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</p>
1313

1414
<p align="center">
15-
<a href="https://www.algolia.com/doc/libraries/kotlin/" target="_blank">Documentation</a> •
15+
<a href="https://www.algolia.com/doc/libraries/sdk/install#kotlin" target="_blank">Documentation</a> •
1616
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
@@ -47,7 +47,7 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
4747
Also, choose and add to your dependencies one of [Ktor http client engines](https://ktor.io/docs/http-client-engines.html).
4848
Alternatively, you can use [algoliasearch-client-kotlin-bom](/client-bom).
4949

50-
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.
50+
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/sdk/install#kotlin)**.
5151

5252
## ❓ Troubleshooting
5353

clients/algoliasearch-client-php/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</p>
1515

1616
<p align="center">
17-
<a href="https://www.algolia.com/doc/libraries/php/" target="_blank">Documentation</a> •
17+
<a href="https://www.algolia.com/doc/libraries/sdk/install#php" target="_blank">Documentation</a> •
1818
<a href="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/algolia/scout-extended" target="_blank">Laravel</a> •
1919
<a href="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/algolia/search-bundle" target="_blank">Symfony</a> •
2020
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
@@ -72,7 +72,7 @@ $response = $client->search(
7272
var_dump($response);
7373
```
7474

75-
For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/php/)**.
75+
For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/sdk/install#php)**.
7676

7777
## ❓ Troubleshooting
7878

clients/algoliasearch-client-python/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</p>
1414

1515
<p align="center">
16-
<a href="https://www.algolia.com/doc/libraries/python/" target="_blank">Documentation</a> •
16+
<a href="https://www.algolia.com/doc/libraries/sdk/install#python" target="_blank">Documentation</a> •
1717
<a href="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/algolia/algoliasearch-django" target="_blank">Django</a> •
1818
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
1919
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
@@ -79,7 +79,7 @@ print(response)
7979
print(response.to_json())
8080
```
8181

82-
For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/python/)**.
82+
For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/sdk/install#python)**.
8383

8484
## ❓ Troubleshooting
8585

0 commit comments

Comments
 (0)