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
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,17 @@ yarn docker:setup

The CLI allows you to make changes locally and run commands through the docker container.

- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/CLI/specs-commands)
- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/CLI/clients-commands)
- [Generate CLI commands](https://api-clients-automation.netlify.app/docs/CLI/generate-commands)
- [Build CLI commands](https://api-clients-automation.netlify.app/docs/CLI/build-commands)
- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/CLI/cts-commands)
- [Release CLI commands](https://api-clients-automation.netlify.app/docs/CLI/release-commands)

### Guides and requirements

Read the guides and requirements to:

- [Add a new client](https://api-clients-automation.netlify.app/docs/add-new-api-client)
- [Add a new language](https://api-clients-automation.netlify.app/docs/add-new-api-language)
- [Add a new client](https://api-clients-automation.netlify.app/docs/add-a-new-api/write-a-specification)
- [Add a new language](https://api-clients-automation.netlify.app/docs/add-a-new-language)

### Tests

Expand All @@ -69,7 +70,7 @@ For full documentation, visit the **[online documentation](https://api-clients-a

## ❓ Troubleshooting

Encountering an issue with the API clients? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers to the most common issues and gotchas with the client.
Encountering an issue with the API clients? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/sections/15061037630609-API-Client-FAQs) where you will find answers to the most common issues and gotchas with the client.

You can also [open an issue on GitHub](https://github.com/algolia/api-clients-automation/issues/new/choose).

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/csharp/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -94,7 +93,7 @@ For full documentation, visit the **[Algolia CSharp API Client](https://www.algo

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/csharp/) 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/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)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion clients/algoliasearch-client-dart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ final response = await client.search(

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/dart/) 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/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)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/go/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -84,7 +83,7 @@ For full documentation, visit the **[Algolia Go API Client](https://www.algolia.

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/go/) 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/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)

## Contributing

Expand Down
5 changes: 2 additions & 3 deletions clients/algoliasearch-client-java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Java project</h4>

<p align="center">
<a href="https://search.maven.org/artifact/com.algolia/algoliasearch/"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch.svg" alt="CircleCI"></img></a>
<a href="https://central.sonatype.com/artifact/com.algolia/algoliasearch"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch.svg" alt="CircleCI"></img></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Licence"></img></a>
</p>
</p>
Expand All @@ -16,7 +16,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/java/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -73,7 +72,7 @@ For full documentation, visit the **[Algolia Java API Client](https://www.algoli

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/java/) 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/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)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-kotlin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -52,7 +51,7 @@ For full documentation, visit the **[Algolia Kotlin API Client](https://www.algo

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/) where you will find answers for the most common issues and gotchas with the client.
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/sections/15061037630609-API-Client-FAQs) where you will find answers for the most common issues and gotchas with the client.

## Use the Dockerfile

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-php/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
<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-php/issues" target="_blank">Report a bug</a> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/php/" target="_blank">FAQ</a> •
<a href="https://www.algolia.com/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -77,7 +76,7 @@ For full documentation, visit the **[Algolia PHP API Client](https://www.algolia

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/php/) 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/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)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
<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-python/issues" target="_blank">Report a bug</a> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/python/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -84,7 +83,7 @@ For full documentation, visit the **[Algolia Python API Client](https://www.algo

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/python/) 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/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)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-ruby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
<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-ruby/issues" target="_blank">Report a bug</a> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -51,7 +50,7 @@ For full documentation, visit the **[Algolia Ruby API Client](https://www.algoli

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) 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/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)

## Contributing

Expand Down
5 changes: 2 additions & 3 deletions clients/algoliasearch-client-scala/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Scala project</h4>

<p align="center">
<a href="https://maven-badges.herokuapp.com/maven-central/com.algolia/algoliasearch-scala_2.13/"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch-scala_2.13" alt="Maven Central"></img></a>
<a href="https://central.sonatype.com/artifact/com.algolia/algoliasearch-scala_2.13"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch-scala_2.13" alt="Maven Central"></img></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="Licence"></img></a>
</p>
</p>
Expand All @@ -16,7 +16,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/scala/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -120,7 +119,7 @@ For full documentation, visit the **[Algolia Scala API Client](https://www.algol

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/scala/) 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/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)

## Contributing

Expand Down
3 changes: 1 addition & 2 deletions clients/algoliasearch-client-swift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
<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> •
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/swift/" target="_blank">FAQ</a> •
<a href="https://alg.li/support" target="_blank">Support</a>
</p>

Expand Down Expand Up @@ -157,7 +156,7 @@ You can use the old library with Swift by one of the following ways:

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/swift/) 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/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)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion specs/abtesting-v3/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ info:
- `x-algolia-api-key`. An API key with the necessary permissions to make the request.
The required access control list (ACL) to make a request is listed in each endpoint's reference.

You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).
You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion specs/abtesting/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ info:
- `x-algolia-api-key`. An API key with the necessary permissions to make the request.
The required access control list (ACL) to make a request is listed in each endpoint's reference.
You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).
You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).
## Rate limits
Expand Down
2 changes: 1 addition & 1 deletion specs/advanced-personalization/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ info:
- `x-algolia-application-id`. Your Algolia application ID.
- `x-algolia-api-key`. An API key with the `search`, `browse` and `recommendation` ACL permissions.

You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).
You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).

## Request format

Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ info:
- `x-algolia-api-key`. An API key with the necessary permissions to make the request.
The required access control list (ACL) to make a request is listed in each endpoint's reference.

You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).
You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys).

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion specs/common/schemas/SearchParams.yml
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ clickAnalytics:
type: boolean
description: |
Whether to include a `queryID` attribute in the response
The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
default: false
x-categories:
- Analytics
Expand Down
2 changes: 1 addition & 1 deletion specs/common/schemas/SearchResponse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ baseSearchResponse:
facetsCount:
type: boolean
title: facetsCount
description: Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
description: Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
facetValues:
type: boolean
title: facetValues
Expand Down
Loading