diff --git a/README.md b/README.md index 20ad8f491cb..c9009d5f421 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). diff --git a/clients/algoliasearch-client-csharp/README.md b/clients/algoliasearch-client-csharp/README.md index 7b3b763af0e..33460b0605c 100644 --- a/clients/algoliasearch-client-csharp/README.md +++ b/clients/algoliasearch-client-csharp/README.md @@ -16,7 +16,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-dart/README.md b/clients/algoliasearch-client-dart/README.md index ea4b2f1c3a7..cb38e992255 100644 --- a/clients/algoliasearch-client-dart/README.md +++ b/clients/algoliasearch-client-dart/README.md @@ -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 diff --git a/clients/algoliasearch-client-go/README.md b/clients/algoliasearch-client-go/README.md index 5f6078aad71..89cb9f895cd 100644 --- a/clients/algoliasearch-client-go/README.md +++ b/clients/algoliasearch-client-go/README.md @@ -19,7 +19,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-java/README.md b/clients/algoliasearch-client-java/README.md index 141fc43326a..8b60a2e1ab6 100644 --- a/clients/algoliasearch-client-java/README.md +++ b/clients/algoliasearch-client-java/README.md @@ -6,7 +6,7 @@

The perfect starting point to integrate Algolia within your Java project

- CircleCI + CircleCI Licence

@@ -16,7 +16,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-kotlin/README.md b/clients/algoliasearch-client-kotlin/README.md index 81c6297b3ac..e9e583caaeb 100644 --- a/clients/algoliasearch-client-kotlin/README.md +++ b/clients/algoliasearch-client-kotlin/README.md @@ -16,7 +16,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-php/README.md b/clients/algoliasearch-client-php/README.md index fcf73f5ca6a..a15f9b1478c 100644 --- a/clients/algoliasearch-client-php/README.md +++ b/clients/algoliasearch-client-php/README.md @@ -20,7 +20,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-python/README.md b/clients/algoliasearch-client-python/README.md index 91a7cd4f3ff..44464a3d4bf 100644 --- a/clients/algoliasearch-client-python/README.md +++ b/clients/algoliasearch-client-python/README.md @@ -18,7 +18,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-ruby/README.md b/clients/algoliasearch-client-ruby/README.md index 9b4c8589f4e..02adfbe9b72 100644 --- a/clients/algoliasearch-client-ruby/README.md +++ b/clients/algoliasearch-client-ruby/README.md @@ -18,7 +18,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-scala/README.md b/clients/algoliasearch-client-scala/README.md index 18500dad792..82eeb5e2798 100644 --- a/clients/algoliasearch-client-scala/README.md +++ b/clients/algoliasearch-client-scala/README.md @@ -6,7 +6,7 @@

The perfect starting point to integrate Algolia within your Scala project

- Maven Central + Maven Central Licence

@@ -16,7 +16,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/clients/algoliasearch-client-swift/README.md b/clients/algoliasearch-client-swift/README.md index 08c72aa512b..25a01e99858 100644 --- a/clients/algoliasearch-client-swift/README.md +++ b/clients/algoliasearch-client-swift/README.md @@ -33,7 +33,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -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 diff --git a/specs/abtesting-v3/spec.yml b/specs/abtesting-v3/spec.yml index 57b8232fcbd..0a6e21837b3 100644 --- a/specs/abtesting-v3/spec.yml +++ b/specs/abtesting-v3/spec.yml @@ -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 diff --git a/specs/abtesting/spec.yml b/specs/abtesting/spec.yml index 6c43a2dc546..afc51912d7e 100644 --- a/specs/abtesting/spec.yml +++ b/specs/abtesting/spec.yml @@ -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 diff --git a/specs/advanced-personalization/spec.yml b/specs/advanced-personalization/spec.yml index f787092cc4e..668b77db05b 100644 --- a/specs/advanced-personalization/spec.yml +++ b/specs/advanced-personalization/spec.yml @@ -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 diff --git a/specs/analytics/spec.yml b/specs/analytics/spec.yml index abaac95eca9..1c2f986b205 100644 --- a/specs/analytics/spec.yml +++ b/specs/analytics/spec.yml @@ -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 diff --git a/specs/common/schemas/SearchParams.yml b/specs/common/schemas/SearchParams.yml index 843f0b8f286..2d81a24cdbe 100644 --- a/specs/common/schemas/SearchParams.yml +++ b/specs/common/schemas/SearchParams.yml @@ -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 diff --git a/specs/common/schemas/SearchResponse.yml b/specs/common/schemas/SearchResponse.yml index 123b1832c02..b2cd78db62a 100644 --- a/specs/common/schemas/SearchResponse.yml +++ b/specs/common/schemas/SearchResponse.yml @@ -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 diff --git a/specs/composition/common/schemas/responses/SearchForFacetValuesResponse.yml b/specs/composition/common/schemas/responses/SearchForFacetValuesResponse.yml index 8c3b73ffa0b..d826553a797 100644 --- a/specs/composition/common/schemas/responses/SearchForFacetValuesResponse.yml +++ b/specs/composition/common/schemas/responses/SearchForFacetValuesResponse.yml @@ -39,12 +39,12 @@ searchForFacetValuesResults: highlighted: $ref: '../../../../common/schemas/HighlightResult.yml#/highlightedValue' count: - description: Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-). + description: Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). type: integer exhaustiveFacetsCount: type: boolean description: | Whether the facet count is exhaustive (true) or approximate (false). - For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-). + For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). processingTimeMS: $ref: '../../../../common/schemas/SearchResponse.yml#/processingTimeMS' diff --git a/specs/composition/spec.yml b/specs/composition/spec.yml index 3a21781bdb7..60a668301f0 100644 --- a/specs/composition/spec.yml +++ b/specs/composition/spec.yml @@ -44,7 +44,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). ## Request format diff --git a/specs/crawler/paths/crawlerTest.yml b/specs/crawler/paths/crawlerTest.yml index 42b2a6eaa89..d1b0ac179b5 100644 --- a/specs/crawler/paths/crawlerTest.yml +++ b/specs/crawler/paths/crawlerTest.yml @@ -102,8 +102,8 @@ post: items: type: string example: - - https://blog.algolia.com/challenging-migration-heroku-google-kubernetes-engine/ - - https://blog.algolia.com/tale-two-engines-algolia-unity/ + - https://www.algolia.com/blog/engineering/challenging-migration-heroku-google-kubernetes-engine + - https://www.algolia.com/blog/engineering/a-tale-of-two-engines-algolia-unity externalData: type: object description: | diff --git a/specs/ingestion/spec.yml b/specs/ingestion/spec.yml index 4f0712ec058..1dadc409380 100644 --- a/specs/ingestion/spec.yml +++ b/specs/ingestion/spec.yml @@ -24,7 +24,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). ## Request format diff --git a/specs/insights/spec.yml b/specs/insights/spec.yml index 4674e5af99f..ec46775f29a 100644 --- a/specs/insights/spec.yml +++ b/specs/insights/spec.yml @@ -30,7 +30,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). ## Request format diff --git a/specs/monitoring/spec.yml b/specs/monitoring/spec.yml index 8d8f77b530f..15747ec6006 100644 --- a/specs/monitoring/spec.yml +++ b/specs/monitoring/spec.yml @@ -22,7 +22,7 @@ info: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. Your Monitoring API key. - 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). Other endpoints don't require authentication. diff --git a/specs/personalization/spec.yml b/specs/personalization/spec.yml index 0990f2f7cfa..ea33f901a7e 100644 --- a/specs/personalization/spec.yml +++ b/specs/personalization/spec.yml @@ -23,7 +23,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). ## Request format diff --git a/specs/query-suggestions/spec.yml b/specs/query-suggestions/spec.yml index 87bb6be5e33..f8266bb44a0 100644 --- a/specs/query-suggestions/spec.yml +++ b/specs/query-suggestions/spec.yml @@ -25,7 +25,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). ## Request format diff --git a/specs/recommend/spec.yml b/specs/recommend/spec.yml index 68cf39a38f9..d3785405d8b 100644 --- a/specs/recommend/spec.yml +++ b/specs/recommend/spec.yml @@ -45,7 +45,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). ## Request format diff --git a/specs/search/common/schemas/SearchForFacetValuesResponse.yml b/specs/search/common/schemas/SearchForFacetValuesResponse.yml index 7e6794c5e6e..a2251809fb4 100644 --- a/specs/search/common/schemas/SearchForFacetValuesResponse.yml +++ b/specs/search/common/schemas/SearchForFacetValuesResponse.yml @@ -26,12 +26,12 @@ searchForFacetValuesResponse: highlighted: $ref: '../../../common/schemas/HighlightResult.yml#/highlightedValue' count: - description: Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-). + description: Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). type: integer exhaustiveFacetsCount: type: boolean description: | Whether the facet count is exhaustive (true) or approximate (false). - For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-). + For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate). processingTimeMS: $ref: '../../../common/schemas/SearchResponse.yml#/processingTimeMS' diff --git a/specs/search/paths/advanced/getLogs.yml b/specs/search/paths/advanced/getLogs.yml index d3d77877cd9..7744d24a7d7 100644 --- a/specs/search/paths/advanced/getLogs.yml +++ b/specs/search/paths/advanced/getLogs.yml @@ -9,7 +9,7 @@ get: - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. + - This request counts towards your [operations quota](https://support.algolia.com/hc/articles/17245378392977-How-does-Algolia-count-records-and-operations) but doesn't appear in the logs itself. summary: Retrieve log entries parameters: - name: offset diff --git a/specs/search/paths/manage_indices/operationIndex.yml b/specs/search/paths/manage_indices/operationIndex.yml index db7f0d93bd2..cea6f939762 100644 --- a/specs/search/paths/manage_indices/operationIndex.yml +++ b/specs/search/paths/manage_indices/operationIndex.yml @@ -29,7 +29,7 @@ post: - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). parameters: - $ref: '../../../common/parameters.yml#/IndexName' requestBody: diff --git a/specs/search/paths/objects/batch.yml b/specs/search/paths/objects/batch.yml index 0149d176a75..2a432a2a919 100644 --- a/specs/search/paths/objects/batch.yml +++ b/specs/search/paths/objects/batch.yml @@ -12,7 +12,7 @@ post: - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). parameters: - $ref: '../../../common/parameters.yml#/IndexName' x-codegen-request-body-name: batchWriteParams diff --git a/specs/search/paths/objects/clearObjects.yml b/specs/search/paths/objects/clearObjects.yml index d9c4f963bcc..f5944a8325d 100644 --- a/specs/search/paths/objects/clearObjects.yml +++ b/specs/search/paths/objects/clearObjects.yml @@ -7,7 +7,7 @@ post: summary: Delete all records from an index description: | Deletes only the records from an index while keeping settings, synonyms, and rules. - This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). parameters: - $ref: '../../../common/parameters.yml#/IndexName' responses: diff --git a/specs/search/paths/objects/deleteBy.yml b/specs/search/paths/objects/deleteBy.yml index 2fcf59fd68b..2b8046d5674 100644 --- a/specs/search/paths/objects/deleteBy.yml +++ b/specs/search/paths/objects/deleteBy.yml @@ -14,9 +14,9 @@ post: It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). externalDocs: - url: https://support.algolia.com/hc/en-us/articles/16385098766353-Should-I-use-the-deleteby-method-for-deleting-records-matching-a-query- + url: https://support.algolia.com/hc/articles/16385098766353-Should-I-use-the-deleteBy-method-for-deleting-records-that-match-a-query description: Should I use the deleteBy method for deleting records. parameters: - $ref: '../../../common/parameters.yml#/IndexName' diff --git a/specs/search/paths/objects/multipleBatch.yml b/specs/search/paths/objects/multipleBatch.yml index 40481ae6c83..b1349cfe5b8 100644 --- a/specs/search/paths/objects/multipleBatch.yml +++ b/specs/search/paths/objects/multipleBatch.yml @@ -9,7 +9,7 @@ post: - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). summary: Batch indexing operations on multiple indices requestBody: required: true diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index b6f65e3700e..1195e24cb17 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -16,7 +16,7 @@ post: To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). summary: Add a new record (with auto-generated object ID) parameters: - $ref: '../../../common/parameters.yml#/IndexName' diff --git a/specs/search/paths/objects/partialUpdate.yml b/specs/search/paths/objects/partialUpdate.yml index 1b2919114d8..efe1f451c7b 100644 --- a/specs/search/paths/objects/partialUpdate.yml +++ b/specs/search/paths/objects/partialUpdate.yml @@ -34,7 +34,7 @@ post: When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: '../../../common/parameters.yml#/ObjectID' diff --git a/specs/search/paths/rules/saveRules.yml b/specs/search/paths/rules/saveRules.yml index b4e30093958..18690b74a7e 100644 --- a/specs/search/paths/rules/saveRules.yml +++ b/specs/search/paths/rules/saveRules.yml @@ -11,7 +11,7 @@ post: If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). x-codegen-request-body-name: rules parameters: - $ref: '../../../common/parameters.yml#/IndexName' diff --git a/specs/search/paths/synonyms/saveSynonyms.yml b/specs/search/paths/synonyms/saveSynonyms.yml index 7918d00c818..3444bf5a7bf 100644 --- a/specs/search/paths/synonyms/saveSynonyms.yml +++ b/specs/search/paths/synonyms/saveSynonyms.yml @@ -9,7 +9,7 @@ post: If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. - This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: '../../../common/parameters.yml#/ForwardToReplicas' diff --git a/specs/search/spec.yml b/specs/search/spec.yml index 296a1b52632..917b088c700 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -45,7 +45,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). ## Request format @@ -156,7 +156,7 @@ tags: Records are individual items in your index. When they match a search query, they're returned as search results, in the order determined by your ranking. Records are schemaless JSON objects. - When adding or updating many records, check the [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). + When adding or updating many records, check the [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). externalDocs: url: https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data description: Prepare your records. diff --git a/templates/javascript/clients/README.mustache b/templates/javascript/clients/README.mustache index 133b867e3b4..2838fd78682 100644 --- a/templates/javascript/clients/README.mustache +++ b/templates/javascript/clients/README.mustache @@ -6,7 +6,7 @@

The perfect starting point to integrate Algolia within your JavaScript project

- NPM version + NPM version NPM downloads jsDelivr Downloads License diff --git a/templates/kotlin/README.mustache b/templates/kotlin/README.mustache index 07aae838621..8a3d11a1d4d 100644 --- a/templates/kotlin/README.mustache +++ b/templates/kotlin/README.mustache @@ -6,7 +6,7 @@

The perfect starting point to integrate Algolia within your Kotlin project

- Latest version + Latest version Licence

@@ -16,7 +16,6 @@ Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -118,7 +117,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. 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