Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ The Algolia API clients are generated from [OpenAPI specs](https://swagger.io/sp

**Migration note from current API clients**

> 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/).
> 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/).

## 💡 Getting Started with the clients

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

## ✨ Contributing

Expand Down
6 changes: 3 additions & 3 deletions clients/algoliasearch-client-csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

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

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

> 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/).
> 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).
Version 5.x will **no longer** be under active development.

## 💡 Getting Started
Expand Down Expand Up @@ -89,7 +89,7 @@ var response = await client.SearchAsync<Object>(
);
```

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</p>

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

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

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

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

## ❓ Troubleshooting

Expand Down
7 changes: 3 additions & 4 deletions clients/algoliasearch-client-javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@
</p>

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

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

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

## ❓ Troubleshooting

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)
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)

## 📄 License

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-kotlin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

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

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-php/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/libraries/php/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#php" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/scout-extended" target="_blank">Laravel</a> •
<a href="https://github.com/algolia/search-bundle" target="_blank">Symfony</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
Expand Down Expand Up @@ -72,7 +72,7 @@ $response = $client->search(
var_dump($response);
```

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/libraries/python/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#python" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-django" target="_blank">Django</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -79,7 +79,7 @@ print(response)
print(response.to_json())
```

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-ruby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/libraries/ruby/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#ruby" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -46,7 +46,7 @@ Finally, you may begin searching a object using the `search` method:
objects = client.search_single_index('your_index_name', 'Foo')
```

For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/ruby/)**.
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/sdk/install#ruby)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-scala/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/libraries/scala/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#scala" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-scala/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -115,7 +115,7 @@ val response = client.search(
val value = Await.result(response, Duration(100, "sec"))
```

For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/libraries/scala/)**.
For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/libraries/sdk/install#scala)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-swift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


<p align="center">
<a href="https://www.algolia.com/doc/libraries/swift/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#swift" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-swift/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -132,7 +132,7 @@ let response: SearchResponses<Hit> = try await client
))]))
```

For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/swift/)**.
For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/sdk/install#swift)**.

## Notes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ exports[`createGithubRelease > generates a release 1`] = `

**Full Changelog**: https://github.com/algolia/algoliasearch-client-dart/compare/5.19.0...5.20.0

→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/dart)
→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/sdk/install#dart)
",
"name": "5.20.0",
"owner": "algolia",
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/codegen/createGitHubReleases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ${stripCommitMessage(changelog)}

**Full Changelog**: ${repositoryLink}/compare/${previousVersion}...${newVersion}

→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/${lang})
→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/sdk/install#${lang === 'csharp' ? 'c%23' : lang})
`;

try {
Expand Down
2 changes: 1 addition & 1 deletion templates/csharp/netcore_project.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for the .NET framework lets you easily use the Algolia Search REST API from your .NET code.
</PackageDescription>
<PackageIcon>icon.png</PackageIcon>
<PackageProjectUrl>https://www.algolia.com/doc/libraries/csharp/</PackageProjectUrl>
<PackageProjectUrl>https://www.algolia.com/doc/libraries/sdk/install#c%23</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryUrl>https://github.com/algolia/algoliasearch-client-csharp</RepositoryUrl>
<RepositoryType>git</RepositoryType>
Expand Down
7 changes: 3 additions & 4 deletions templates/javascript/clients/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@
</p>

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

Expand Down Expand Up @@ -90,11 +89,11 @@ const client = {{clientName}}('YOUR_APP_ID', 'YOUR_API_KEY');
{{/isAlgoliasearchClient}}
```

For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/{{#lambda.kebabcase}}{{apiName}}{{/lambda.kebabcase}}/)**.
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/{{#lambda.kebabcase}}{{apiName}}{{/lambda.kebabcase}}/)**.

## ❓ Troubleshooting

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)
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)

## 📄 License

Expand Down
4 changes: 2 additions & 2 deletions templates/kotlin/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/libraries/kotlin/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/sdk/install#kotlin" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -113,7 +113,7 @@ var response = client.search(
println(response)
```

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

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions templates/swift/podspec.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Pod::Spec.new do |s|
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.homepage = 'https://github.com/algolia/algoliasearch-client-swift/tree/main'
s.summary = 'Algolia Search API Client written in Swift.'
s.documentation_url = 'https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/swift/'
s.documentation_url = 'https://www.algolia.com/doc/libraries/sdk/install#swift'
s.ios.deployment_target = '14.0'
s.osx.deployment_target = '11.0'
s.watchos.deployment_target = '7.0'
Expand All @@ -24,4 +24,4 @@ Pod::Spec.new do |s|
subs.dependency '{{projectName}}/Core'
end
{{/packageList}}
end
end
10 changes: 5 additions & 5 deletions website/docs/CLI/build-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ apic build specs <client... | all>

### Available options

| Option | Command | Description |
| ---------- | :--------------- | :------------------------------------------------------------- |
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
| skip cache | -s, --skip-cache | Skip cache checking to force building specs |
| docs | -d, --docs | Builds the specs for the Algolia doc, which embeds the snippets|
| Option | Command | Description |
| ---------- | :--------------- | :-------------------------------------------------------------- |
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
| skip cache | -s, --skip-cache | Skip cache checking to force building specs |
| docs | -d, --docs | Builds the specs for the Algolia doc, which embeds the snippets |

## Build specs

Expand Down
2 changes: 1 addition & 1 deletion website/docs/CLI/cts-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ apic cts generate <language | all> <client... | all>
### Available options

| Option | Command | Description |
|----------|:---------------|:----------------------------------------------------------------------------------|
| -------- | :------------- | :-------------------------------------------------------------------------------- |
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
| debugger | -d, --debugger | runs the generator in debug mode, it will wait for a Java debugger to be attached |

Expand Down
2 changes: 1 addition & 1 deletion website/docs/CLI/generate-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ apic generate <language | all> <client... | all>
### Available options

| Option | Command | Description |
|----------|:---------------|:----------------------------------------------------------------------------------|
| -------- | :------------- | :-------------------------------------------------------------------------------- |
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
| debugger | -d, --debugger | runs the generator in debug mode, it will wait for a Java debugger to be attached |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ To make using the specs in these contexts easier, follow these guidelines:
- Prefer using `externalDocs` objects over inline Markdown links.
- Use inline Markdown links judiciously.
They don't render in CLI/code environments.

- Don't link to readily searchable information, such as internet RFCs or Wikipedia.
- Don't link to endpoints of other Algolia APIs. These links won't be portable.

Expand Down
1 change: 0 additions & 1 deletion website/docs/custom-helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ This section explains the decision over the implementation of complicated helper

:::


### `replaceAllObjects`

:::caution
Expand Down
Loading
Loading