From b2d7a62449751cf90e8c12f17f990f8b91641d23 Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Fri, 26 Sep 2025 14:21:39 +0200 Subject: [PATCH 1/3] fix(specs): update links and descriptions --- .../paths/search/getTopFiltersNoResults.yml | 2 +- specs/common/responses/common.yml | 5 +++-- specs/composition/paths/rules/rule.yml | 7 ++++--- .../crawler/common/schemas/getCrawlerResponse.yml | 2 +- specs/crawler/paths/crawler.yml | 14 +++++++++----- specs/crawler/paths/crawlerConfigVersions.yml | 3 +-- specs/crawler/spec.yml | 2 +- specs/monitoring/spec.yml | 2 +- specs/search/paths/objects/deleteBy.yml | 4 ++-- specs/search/paths/objects/object.yml | 12 ++++++------ specs/search/paths/objects/objects.yml | 4 ++-- specs/search/paths/rules/rule.yml | 6 +++--- specs/search/paths/search/searchSingleIndex.yml | 4 ++-- specs/search/paths/synonyms/synonym.yml | 6 +++--- 14 files changed, 39 insertions(+), 34 deletions(-) diff --git a/specs/analytics/paths/search/getTopFiltersNoResults.yml b/specs/analytics/paths/search/getTopFiltersNoResults.yml index 4f1477f20a0..cc4efcda53f 100644 --- a/specs/analytics/paths/search/getTopFiltersNoResults.yml +++ b/specs/analytics/paths/search/getTopFiltersNoResults.yml @@ -8,7 +8,7 @@ get: description: | Retrieves the 1,000 most frequently used filters for a search that didn't return any results. - To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. + To get the most frequent searches without results, use the [Retrieve searches without results](https://www.algolia.com/doc/rest-api/analytics/get-searches-no-results) operation. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../common/parameters.yml#/Search' diff --git a/specs/common/responses/common.yml b/specs/common/responses/common.yml index e5853f91370..7c6ac5a50f5 100644 --- a/specs/common/responses/common.yml +++ b/specs/common/responses/common.yml @@ -5,8 +5,9 @@ taskID: description: | Unique identifier of a task. - A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`. - + A successful API response means that a task was added to a queue. + It might not run immediately. + You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID. objectIDs: type: array items: diff --git a/specs/composition/paths/rules/rule.yml b/specs/composition/paths/rules/rule.yml index fe67073d3ba..7c99efe67a5 100644 --- a/specs/composition/paths/rules/rule.yml +++ b/specs/composition/paths/rules/rule.yml @@ -8,8 +8,8 @@ get: summary: Retrieve a rule description: | Retrieves a rule by its ID. - To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). + To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules). parameters: - $ref: '../urlParams.yml#/compositionID' - $ref: './parameters.yml#/ObjectIDRule' @@ -35,9 +35,10 @@ put: operationId: putCompositionRule x-acl: - editSettings - summary: Upsert a composition rule + summary: Add or update a composition rule description: | - Upsert a Composition Rule for the specified composition ID. + If a composition rule with the provided ID already exists, + it's replaced. Otherwise, a new one is added. parameters: - $ref: '../urlParams.yml#/compositionID' - $ref: './parameters.yml#/ObjectIDRule' diff --git a/specs/crawler/common/schemas/getCrawlerResponse.yml b/specs/crawler/common/schemas/getCrawlerResponse.yml index 1a160ff6e4d..1c2e4f0a50a 100644 --- a/specs/crawler/common/schemas/getCrawlerResponse.yml +++ b/specs/crawler/common/schemas/getCrawlerResponse.yml @@ -26,7 +26,7 @@ BaseResponse: Whether this crawler is currently blocked. If `true`, you can unblock it from the [Crawler page](https://dashboard.algolia.com/crawler) in the Algolia dashboard - or by [cancelling the blocking task](#tag/tasks/operation/cancelBlockingAction). + or by [cancelling the blocking task](https://www.algolia.com/doc/rest-api/crawler/cancel-blocking-action). blockingError: type: string description: Reason why the crawler is blocked. diff --git a/specs/crawler/paths/crawler.yml b/specs/crawler/paths/crawler.yml index 9b13b14cf45..8e3635c5fcd 100644 --- a/specs/crawler/paths/crawler.yml +++ b/specs/crawler/paths/crawler.yml @@ -27,15 +27,19 @@ get: $ref: '../common/schemas/responses.yml#/NoRightsOnCrawler' patch: operationId: patchCrawler - summary: Change crawler name + summary: Replace crawler configuration description: | - Change the crawler's name. + Replaces the crawler configuration with a new one. - While you _could_ use this endpoint to replace the crawler configuration, - you should [update it](#tag/config/operation/patchConfig) instead since configuration changes made here aren't [versioned](#tag/config/operation/listConfigVersions). + If you only want to change the crawler's name, you can use this operation. + For other configuration changes, use the "Update configuration" endpoint instead instead, + because changes made here aren't versioned. - If you replace the configuration, you must provide the full configuration, + When replacing the configuration, you must provide the full configuration, including any settings you want to keep. + externalDocs: + url: https://www.algolia.com/doc/rest-api/crawler/patch-config + description: Update configuration. tags: - crawlers parameters: diff --git a/specs/crawler/paths/crawlerConfigVersions.yml b/specs/crawler/paths/crawlerConfigVersions.yml index 197c1195706..5606b91c419 100644 --- a/specs/crawler/paths/crawlerConfigVersions.yml +++ b/specs/crawler/paths/crawlerConfigVersions.yml @@ -3,8 +3,7 @@ get: summary: List configuration versions description: | Lists previous versions of the specified crawler's configuration, including who authored the change. - Every time you update a crawler's [configuration](#tag/config/operation/patchConfig), - a new version is added. + Every time you update a crawler's configuration, a new version is added. tags: - config parameters: diff --git a/specs/crawler/spec.yml b/specs/crawler/spec.yml index 1af804a0bb3..7bf98f0337d 100644 --- a/specs/crawler/spec.yml +++ b/specs/crawler/spec.yml @@ -78,7 +78,7 @@ tags: - name: crawlers x-displayName: Manage description: | - A crawler is an object with a name and a [configuration](#tag/config). + A crawler is an object with a name and a configuration. Use these endpoints to create, rename, and delete crawlers. - name: domains x-displayName: Domains diff --git a/specs/monitoring/spec.yml b/specs/monitoring/spec.yml index 553e495f4ef..8d8f77b530f 100644 --- a/specs/monitoring/spec.yml +++ b/specs/monitoring/spec.yml @@ -14,7 +14,7 @@ info: ## Availability and authentication - Access to the [Infrastructure](#tag/infrastructure) endpoints + Access to the Infrastructure endpoints is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). To authenticate requests to the Infrastructure endpoints, add these headers: diff --git a/specs/search/paths/objects/deleteBy.yml b/specs/search/paths/objects/deleteBy.yml index fd03035e5d2..2fcf59fd68b 100644 --- a/specs/search/paths/objects/deleteBy.yml +++ b/specs/search/paths/objects/deleteBy.yml @@ -11,8 +11,8 @@ post: This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. - It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), - and then delete the records using the [`batch` operation](#tag/Records/operation/batch). + 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). externalDocs: diff --git a/specs/search/paths/objects/object.yml b/specs/search/paths/objects/object.yml index 602e778faea..2b4af21d51c 100644 --- a/specs/search/paths/objects/object.yml +++ b/specs/search/paths/objects/object.yml @@ -8,7 +8,7 @@ get: description: | Retrieves one record by its object ID. - To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). + To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/get-objects). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: '../../../common/parameters.yml#/ObjectID' @@ -55,9 +55,9 @@ put: If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. - If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). - To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. - To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). + If you want to use auto-generated object IDs, use the [`saveObject` operation](https://www.algolia.com/doc/rest-api/search/save-object). + To update _some_ attributes of an existing record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object) instead. + To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: '../../../common/parameters.yml#/ObjectID' @@ -95,8 +95,8 @@ delete: description: | Deletes a record by its object ID. - To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). - To delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy). + To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). + To delete records matching a query, use the [`deleteBy` operation](https://www.algolia.com/doc/rest-api/search/delete-by). parameters: - $ref: '../../../common/parameters.yml#/IndexName' diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index 9d7eda2385f..905db4bb200 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -13,8 +13,8 @@ post: - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. - To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). - To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). + 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). summary: Add a new record (with auto-generated object ID) diff --git a/specs/search/paths/rules/rule.yml b/specs/search/paths/rules/rule.yml index 5b4036eea14..0bd98be232b 100644 --- a/specs/search/paths/rules/rule.yml +++ b/specs/search/paths/rules/rule.yml @@ -7,7 +7,7 @@ get: summary: Retrieve a rule description: | Retrieves a rule by its ID. - To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). + To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules). parameters: - $ref: '../../../common/parameters.yml#/IndexName' @@ -39,7 +39,7 @@ put: If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. - To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). + To create or update more than one rule, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-rules). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: 'common/parameters.yml#/ObjectIDRule' @@ -72,7 +72,7 @@ delete: description: | Deletes a rule by its ID. To find the object ID for rules, - use the [`search` operation](#tag/Rules/operation/searchRules). + use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: 'common/parameters.yml#/ObjectIDRule' diff --git a/specs/search/paths/search/searchSingleIndex.yml b/specs/search/paths/search/searchSingleIndex.yml index 0893f140ed6..1a018cd3b87 100644 --- a/specs/search/paths/search/searchSingleIndex.yml +++ b/specs/search/paths/search/searchSingleIndex.yml @@ -9,10 +9,10 @@ post: - search summary: Search an index description: | - Searches a single index and returns matching search results (_hits_). + Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. - If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. + If you need more, use the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse) or increase the `paginatedLimitedTo` index setting. parameters: - $ref: '../../../common/parameters.yml#/IndexName' requestBody: diff --git a/specs/search/paths/synonyms/synonym.yml b/specs/search/paths/synonyms/synonym.yml index 474f3a91b1a..c486871bd6c 100644 --- a/specs/search/paths/synonyms/synonym.yml +++ b/specs/search/paths/synonyms/synonym.yml @@ -8,7 +8,7 @@ get: description: | Retrieves a synonym by its ID. To find the object IDs for your synonyms, - use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: 'common/parameters.yml#/ObjectID' @@ -38,7 +38,7 @@ put: description: | If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. - To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + To add multiple synonyms in a single API request, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/save-synonyms). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: 'common/parameters.yml#/ObjectID' @@ -87,7 +87,7 @@ delete: summary: Delete a synonym description: | Deletes a synonym by its ID. - To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-synonyms). parameters: - $ref: '../../../common/parameters.yml#/IndexName' - $ref: 'common/parameters.yml#/ObjectID' From d2885755b7f38d520317a7a2238e8eaa55f7d51b Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Fri, 26 Sep 2025 19:58:34 +0200 Subject: [PATCH 2/3] fix: simpler externalDocs --- specs/abtesting-v3/spec.yml | 3 +-- specs/abtesting/spec.yml | 3 +-- specs/advanced-personalization/spec.yml | 3 +-- .../analytics/paths/search/getUsersCount.yml | 5 ++--- specs/analytics/spec.yml | 3 +-- specs/ingestion/paths/tasks/v2/pushTask.yml | 3 +-- specs/personalization/spec.yml | 3 +-- specs/recommend/spec.yml | 6 ++---- specs/search/paths/objects/objects.yml | 3 +-- specs/search/spec.yml | 21 +++++++------------ 10 files changed, 18 insertions(+), 35 deletions(-) diff --git a/specs/abtesting-v3/spec.yml b/specs/abtesting-v3/spec.yml index d25d3cf3871..ed11dae24ee 100644 --- a/specs/abtesting-v3/spec.yml +++ b/specs/abtesting-v3/spec.yml @@ -1,8 +1,7 @@ openapi: 3.0.2 externalDocs: url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/ - description: | - Related guide: A/B testing. + description: A/B testing. info: title: A/B Testing API description: | diff --git a/specs/abtesting/spec.yml b/specs/abtesting/spec.yml index a98cfb20a7f..6f511b1342e 100644 --- a/specs/abtesting/spec.yml +++ b/specs/abtesting/spec.yml @@ -1,8 +1,7 @@ openapi: 3.0.2 externalDocs: url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/ - description: | - Related guide: A/B testing. + description: A/B testing. info: title: A/B Testing API description: | diff --git a/specs/advanced-personalization/spec.yml b/specs/advanced-personalization/spec.yml index 8c88c2ad50d..3681060d654 100644 --- a/specs/advanced-personalization/spec.yml +++ b/specs/advanced-personalization/spec.yml @@ -92,8 +92,7 @@ tags: User profiles contain the affinities each user has for the different facets in your index. externalDocs: url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/ - description: | - Related guide: User Profiles. + description: User profiles. x-tagGroups: - name: Advanced Personalization tags: diff --git a/specs/analytics/paths/search/getUsersCount.yml b/specs/analytics/paths/search/getUsersCount.yml index 6b72d96d64b..97db703a05d 100644 --- a/specs/analytics/paths/search/getUsersCount.yml +++ b/specs/analytics/paths/search/getUsersCount.yml @@ -11,13 +11,12 @@ get: Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - + - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. - The analyzed period includes the last eight days including the current day. externalDocs: url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken/ - description: | - Related guide: Distinguish users for analytics. + description: Distinguish users for analytics. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/spec.yml b/specs/analytics/spec.yml index 62ed49524b5..a699b121b69 100644 --- a/specs/analytics/spec.yml +++ b/specs/analytics/spec.yml @@ -1,8 +1,7 @@ openapi: 3.0.2 externalDocs: url: https://www.algolia.com/doc/guides/search-analytics/overview/ - description: | - Related guide: Search analytics. + description: Search analytics. info: title: Analytics API description: | diff --git a/specs/ingestion/paths/tasks/v2/pushTask.yml b/specs/ingestion/paths/tasks/v2/pushTask.yml index 3a5ce8bc410..1dd73ef8c8f 100644 --- a/specs/ingestion/paths/tasks/v2/pushTask.yml +++ b/specs/ingestion/paths/tasks/v2/pushTask.yml @@ -12,8 +12,7 @@ post: operationId: pushTask externalDocs: url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/ - description: | - Related guide: Pre-indexing data transformation. + description: Pre-indexing data transformation. x-acl: - addObject - deleteIndex diff --git a/specs/personalization/spec.yml b/specs/personalization/spec.yml index 13315450e60..d8e88f1e5a4 100644 --- a/specs/personalization/spec.yml +++ b/specs/personalization/spec.yml @@ -55,8 +55,7 @@ info: version: 1.0.0 externalDocs: url: https://www.algolia.com/doc/guides/personalization/what-is-personalization/ - description: | - Related guide: Algolia Personalization. + description: Algolia Personalization. components: securitySchemes: appId: diff --git a/specs/recommend/spec.yml b/specs/recommend/spec.yml index 071d5ef01e0..e5c918d289d 100644 --- a/specs/recommend/spec.yml +++ b/specs/recommend/spec.yml @@ -99,15 +99,13 @@ tags: description: Retrieve recommendations from a pre-trained AI model. You can train models in the [Algolia dashboard](https://dashboard.algolia.com/recommend/). externalDocs: url: https://www.algolia.com/doc/guides/algolia-recommend/overview/ - description: | - Related guide: Algolia Recommend. + description: Algolia Recommend. - name: rules x-displayName: Rules description: Curate your recommendations with rules, which are _if_-_then_ statements. externalDocs: url: https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/ - description: | - Related guide: Recommend Rules. + description: Recommend Rules. x-tagGroups: - name: Recommend tags: diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index 905db4bb200..584871f7a06 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -76,8 +76,7 @@ delete: For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). externalDocs: url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/delete-indices/ - description: | - Related guide: Delete indices. + description: Delete indices. parameters: - $ref: '../../../common/parameters.yml#/IndexName' responses: diff --git a/specs/search/spec.yml b/specs/search/spec.yml index dfa93fbcaa7..1f81f7fb139 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -121,8 +121,7 @@ tags: API keys can have permissions (access control lists, ACL) and restrictions. externalDocs: url: https://www.algolia.com/doc/guides/security/api-keys/ - description: | - Related guide: API keys. + description: API keys. - name: Clusters description: | @@ -140,8 +139,7 @@ tags: Dictionaries are application-wide. externalDocs: url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/ - description: | - Related guide: Natural languages. + description: Natural languages. - name: Indices description: | Manage your indices and index settings. @@ -150,8 +148,7 @@ tags: They're optimal data structures for fast search and are made up of records and settings. externalDocs: url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/ - description: | - Related guide: Manage your indices. + description: Manage your indices. - name: Records description: | Add, update, and delete records from your indices. @@ -162,8 +159,7 @@ tags: 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). externalDocs: url: https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/ - description: | - Related guide: Prepare your records. + description: Prepare your records. - name: Rules description: | Create, update, delete, and search for rules. @@ -174,8 +170,7 @@ tags: This can be useful for tuning specific queries or for merchandising. externalDocs: url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/ - description: | - Related guide: Rules. + description: Index Rules. - name: Search description: Search one or more indices for matching records or facet values. - name: Synonyms @@ -185,14 +180,12 @@ tags: Synonyms are terms that the search engine should consider equal. externalDocs: url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/ - description: | - Related guide: Synonyms. + description: Synonyms. - name: Vaults description: Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest. externalDocs: url: https://www.algolia.com/doc/guides/security/algolia-vault/ - description: | - Related guide: Algolia Vault. + description: Algolia Vault. - name: _model_index_settings x-displayName: Index settings description: | From 077ea26d29694b8f00d780fccde5681e0e6effdd Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Fri, 26 Sep 2025 20:18:15 +0200 Subject: [PATCH 3/3] fix: remove trailing slashes --- specs/abtesting-v3/spec.yml | 2 +- specs/abtesting/spec.yml | 2 +- specs/advanced-personalization/spec.yml | 11 ++-- specs/analytics/common/parameters.yml | 2 +- .../paths/click/getAddToCartRate.yml | 2 +- .../paths/click/getAverageClickPosition.yml | 2 +- .../paths/click/getClickPositions.yml | 2 +- .../paths/click/getClickThroughRate.yml | 2 +- .../paths/click/getConversionRate.yml | 2 +- .../analytics/paths/click/getPurchaseRate.yml | 2 +- specs/analytics/paths/search/getTopHits.yml | 2 +- .../analytics/paths/search/getTopSearches.yml | 2 +- .../analytics/paths/search/getUsersCount.yml | 2 +- specs/analytics/spec.yml | 4 +- specs/common/parameters.yml | 4 +- specs/common/schemas/IndexSettings.yml | 56 +++++++++---------- specs/common/schemas/SearchParams.yml | 10 ++-- specs/common/schemas/SearchResponse.yml | 4 +- specs/composition/spec.yml | 2 +- specs/crawler/common/parameters.yml | 4 +- specs/crawler/common/schemas/action.yml | 4 +- .../crawler/common/schemas/configuration.yml | 10 ++-- specs/ingestion/helpers/chunkedPush.yml | 2 +- specs/ingestion/paths/push.yml | 2 +- specs/ingestion/paths/tasks/v2/pushTask.yml | 2 +- .../common/schemas/EventAttributes.yml | 4 +- specs/insights/paths/pushEvents.yml | 2 +- specs/insights/spec.yml | 4 +- specs/personalization/spec.yml | 4 +- .../common/schemas/Configuration.yml | 2 +- specs/query-suggestions/spec.yml | 2 +- specs/recommend/spec.yml | 10 ++-- ...partialUpdateObjectsWithTransformation.yml | 4 +- .../replaceAllObjectsWithTransformation.yml | 2 +- .../helpers/saveObjectsWithTransformation.yml | 4 +- .../paths/dictionaries/common/parameters.yml | 2 +- .../dictionaries/getDictionaryLanguages.yml | 2 +- specs/search/paths/keys/common/schemas.yml | 2 +- .../paths/manage_indices/operationIndex.yml | 4 +- .../paths/multiclusters/searchUserIds.yml | 1 - specs/search/paths/objects/objects.yml | 4 +- .../search/paths/synonyms/common/schemas.yml | 8 +-- specs/search/spec.yml | 18 +++--- 43 files changed, 109 insertions(+), 109 deletions(-) diff --git a/specs/abtesting-v3/spec.yml b/specs/abtesting-v3/spec.yml index ed11dae24ee..57b8232fcbd 100644 --- a/specs/abtesting-v3/spec.yml +++ b/specs/abtesting-v3/spec.yml @@ -1,6 +1,6 @@ openapi: 3.0.2 externalDocs: - url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/ + url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing description: A/B testing. info: title: A/B Testing API diff --git a/specs/abtesting/spec.yml b/specs/abtesting/spec.yml index 6f511b1342e..6c43a2dc546 100644 --- a/specs/abtesting/spec.yml +++ b/specs/abtesting/spec.yml @@ -1,6 +1,6 @@ openapi: 3.0.2 externalDocs: - url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/ + url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing description: A/B testing. info: title: A/B Testing API diff --git a/specs/advanced-personalization/spec.yml b/specs/advanced-personalization/spec.yml index 3681060d654..f787092cc4e 100644 --- a/specs/advanced-personalization/spec.yml +++ b/specs/advanced-personalization/spec.yml @@ -7,9 +7,9 @@ info: ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. - The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). + The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla). - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem) ## Base URLs @@ -51,7 +51,7 @@ info: - `x-ratelimit-limit`: The number of requests allowed every 60 seconds. - `x-ratelimit-remaining`: The number of requests remaining in the current 60 second period. - - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period. + - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of the next time period. ## Version @@ -72,7 +72,8 @@ servers: enum: [eu, us] default: eu externalDocs: - url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/ + url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization + description: What is Advanced Personalization. security: - appId: [] apiKey: [] @@ -91,7 +92,7 @@ tags: User profiles contain the affinities each user has for the different facets in your index. externalDocs: - url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/ + url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles description: User profiles. x-tagGroups: - name: Advanced Personalization diff --git a/specs/analytics/common/parameters.yml b/specs/analytics/common/parameters.yml index 382073fec90..90617ce5210 100644 --- a/specs/analytics/common/parameters.yml +++ b/specs/analytics/common/parameters.yml @@ -107,7 +107,7 @@ Tags: You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. - For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments). example: 'device:mobile%20phone' schema: type: string diff --git a/specs/analytics/paths/click/getAddToCartRate.yml b/specs/analytics/paths/click/getAddToCartRate.yml index 47fef563886..14d589f1cae 100644 --- a/specs/analytics/paths/click/getAddToCartRate.yml +++ b/specs/analytics/paths/click/getAddToCartRate.yml @@ -17,7 +17,7 @@ get: **There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null. - - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/paths/click/getAverageClickPosition.yml b/specs/analytics/paths/click/getAverageClickPosition.yml index bd3cf3c5121..8ce6c1480df 100644 --- a/specs/analytics/paths/click/getAverageClickPosition.yml +++ b/specs/analytics/paths/click/getAverageClickPosition.yml @@ -12,7 +12,7 @@ get: For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. - An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. + An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries. The average is `null` until Algolia receives at least one click event. parameters: - $ref: '../../../common/parameters.yml#/Index' diff --git a/specs/analytics/paths/click/getClickPositions.yml b/specs/analytics/paths/click/getClickPositions.yml index a4a4eab00fc..b5eb192257f 100644 --- a/specs/analytics/paths/click/getClickPositions.yml +++ b/specs/analytics/paths/click/getClickPositions.yml @@ -10,7 +10,7 @@ get: This lets you check how many clicks the first, second, or tenth search results receive. - An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. + An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/paths/click/getClickThroughRate.yml b/specs/analytics/paths/click/getClickThroughRate.yml index 9de85ef4118..cb887997113 100644 --- a/specs/analytics/paths/click/getClickThroughRate.yml +++ b/specs/analytics/paths/click/getClickThroughRate.yml @@ -13,7 +13,7 @@ get: **There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CTR is null. - - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/paths/click/getConversionRate.yml b/specs/analytics/paths/click/getConversionRate.yml index 29f3d0c4208..2837e0a1e37 100644 --- a/specs/analytics/paths/click/getConversionRate.yml +++ b/specs/analytics/paths/click/getConversionRate.yml @@ -13,7 +13,7 @@ get: **There's a difference between a 0 and null CR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CR is null. - - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/paths/click/getPurchaseRate.yml b/specs/analytics/paths/click/getPurchaseRate.yml index 4e3971b95af..6cc06ddba15 100644 --- a/specs/analytics/paths/click/getPurchaseRate.yml +++ b/specs/analytics/paths/click/getPurchaseRate.yml @@ -17,7 +17,7 @@ get: **There's a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the purchase rate is null. - - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../../common/parameters.yml#/StartDate' diff --git a/specs/analytics/paths/search/getTopHits.yml b/specs/analytics/paths/search/getTopHits.yml index f6c56f4b49c..99f145f05e2 100644 --- a/specs/analytics/paths/search/getTopHits.yml +++ b/specs/analytics/paths/search/getTopHits.yml @@ -29,7 +29,7 @@ get: **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../common/parameters.yml#/Search' diff --git a/specs/analytics/paths/search/getTopSearches.yml b/specs/analytics/paths/search/getTopSearches.yml index 3d2b5b163c7..4d6a7c15743 100644 --- a/specs/analytics/paths/search/getTopSearches.yml +++ b/specs/analytics/paths/search/getTopSearches.yml @@ -29,7 +29,7 @@ get: **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. + - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received. parameters: - $ref: '../../../common/parameters.yml#/Index' - $ref: '../../common/parameters.yml#/ClickAnalytics' diff --git a/specs/analytics/paths/search/getUsersCount.yml b/specs/analytics/paths/search/getUsersCount.yml index 97db703a05d..3ce65bf6c87 100644 --- a/specs/analytics/paths/search/getUsersCount.yml +++ b/specs/analytics/paths/search/getUsersCount.yml @@ -15,7 +15,7 @@ get: - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. - The analyzed period includes the last eight days including the current day. externalDocs: - url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken/ + url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken description: Distinguish users for analytics. parameters: - $ref: '../../../common/parameters.yml#/Index' diff --git a/specs/analytics/spec.yml b/specs/analytics/spec.yml index a699b121b69..abaac95eca9 100644 --- a/specs/analytics/spec.yml +++ b/specs/analytics/spec.yml @@ -1,6 +1,6 @@ openapi: 3.0.2 externalDocs: - url: https://www.algolia.com/doc/guides/search-analytics/overview/ + url: https://www.algolia.com/doc/guides/search-analytics/overview description: Search analytics. info: title: Analytics API @@ -63,7 +63,7 @@ info: To ensure you have relevant analytics data, however, the series of keystrokes is aggregated to keep only the latest (final) user query. This is called "prefix" aggregation. - For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). + For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation). See the analytics implementation overview for more information about query aggregation. version: 2.0.0 diff --git a/specs/common/parameters.yml b/specs/common/parameters.yml index 14e5509d659..7f5dfa19fe2 100644 --- a/specs/common/parameters.yml +++ b/specs/common/parameters.yml @@ -133,7 +133,7 @@ hitsPerPage: description: | Maximum number of hits per page. - Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). + Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. @@ -151,7 +151,7 @@ page: description: | Requested page of the API response. - Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). + Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. diff --git a/specs/common/schemas/IndexSettings.yml b/specs/common/schemas/IndexSettings.yml index 5601126cef4..4bf86051e40 100644 --- a/specs/common/schemas/IndexSettings.yml +++ b/specs/common/schemas/IndexSettings.yml @@ -19,7 +19,7 @@ baseIndexSettings: - afterDistinct(category) - afterDistinct(searchable(publisher)) description: | - Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). + Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. @@ -47,7 +47,7 @@ baseIndexSettings: type: string example: [virtual(prod_products_price_asc), dev_products_replica] description: | - Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). + Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. @@ -59,7 +59,7 @@ baseIndexSettings: - `virtual("REPLICA")`. Create a virtual replica, - Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). + Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort). default: [] x-categories: - Ranking @@ -82,7 +82,7 @@ baseIndexSettings: description: | Attributes that can't be retrieved at query time. - This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), + This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive. default: [] @@ -97,7 +97,7 @@ baseIndexSettings: - 1X2BCD description: | Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). - This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. + This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words. default: [] x-categories: - Typos @@ -133,7 +133,7 @@ baseIndexSettings: de: - name description: | - Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). + Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, @@ -158,10 +158,10 @@ baseIndexSettings: Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** - If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), + If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. - For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). + For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations). default: [] x-categories: - Languages @@ -242,7 +242,7 @@ baseIndexSettings: To make matches in two attributes rank equally, include them in a comma-separated string, such as `"title,alternate_title"`. Attributes with the same priority are always unordered. - For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). + For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** @@ -258,7 +258,7 @@ baseIndexSettings: customNormalization: description: | Characters and their normalized replacements. - This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/). + This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization). type: object example: default: @@ -305,7 +305,7 @@ baseIndexSettings: - desc(popularity) - asc(price) description: | - Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). + Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. @@ -322,7 +322,7 @@ baseIndexSettings: Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, - [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, + [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision) of your first attributes, or the other attributes will never be applied. default: [] x-categories: @@ -341,9 +341,9 @@ indexSettingsAsSearchParams: description: | Determines the order in which Algolia returns your results. - By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). + By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. - If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), + If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** @@ -355,7 +355,7 @@ indexSettingsAsSearchParams: Before you modify the default setting, you should test your changes in the dashboard, - and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). + and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing). default: - typo - geo @@ -531,7 +531,7 @@ attributesToHighlight: Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI - For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/). + For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js). x-categories: - Highlighting and Snippeting @@ -609,10 +609,10 @@ disableTypoToleranceOnAttributes: example: - sku description: | - Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). + Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). + - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. @@ -630,7 +630,7 @@ enablePersonalization: enableReRanking: type: boolean description: | - Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) + Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. default: true x-categories: @@ -702,7 +702,7 @@ minWordSizefor2Typos: reRankingApplyFilter: description: | - Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters. + Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) to records that match these filters. oneOf: - type: array items: @@ -744,10 +744,10 @@ queryLanguages: This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** - If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), + If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. - For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). + For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations). default: [] x-categories: - Languages @@ -766,7 +766,7 @@ queryType: Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. - For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). + For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching). default: prefixLast x-categories: - Query strategy @@ -810,7 +810,7 @@ removeWordsIfNoResults: - `allOptional`. Treat all words as optional. - For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). + For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results). default: none x-categories: - Query strategy @@ -857,7 +857,7 @@ distinct: description: | Number of members of a group of records to include in the search results. - - Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/). + - Don't use `distinct > 1` for records that might be [promoted by rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits). The number of hits won't be correct and faceting won't work as expected. - With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups. For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned. @@ -870,9 +870,9 @@ distinct: typoTolerance: description: | - Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. + Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied. - If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. + If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) are also active. oneOf: - type: boolean default: true @@ -1265,7 +1265,7 @@ sortFacetValuesBy: - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). - For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/). + For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js). default: count x-categories: - Faceting diff --git a/specs/common/schemas/SearchParams.yml b/specs/common/schemas/SearchParams.yml index c539e80ec7a..843f0b8f286 100644 --- a/specs/common/schemas/SearchParams.yml +++ b/specs/common/schemas/SearchParams.yml @@ -136,7 +136,7 @@ analyticsTags: type: array items: type: string - description: Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + description: Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments). default: [] aroundRadius: @@ -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/guides/sending-events/getting-started). default: false x-categories: - Analytics @@ -286,7 +286,7 @@ filters: Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. - For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). + For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering). example: '(category:Book OR category:Ebook) AND _tags:published' x-categories: - Filtering @@ -412,7 +412,7 @@ optionalFilters: - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). + - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes. example: ['category:Book', 'author:John Doe'] @@ -533,7 +533,7 @@ userToken: Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. - For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). + For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). example: test-user-123 x-categories: - Personalization diff --git a/specs/common/schemas/SearchResponse.yml b/specs/common/schemas/SearchResponse.yml index 725f486a4d2..123b1832c02 100644 --- a/specs/common/schemas/SearchResponse.yml +++ b/specs/common/schemas/SearchResponse.yml @@ -128,7 +128,7 @@ baseSearchResponse: title: redirect type: object description: | - [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only. + [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects), this this parameter is for internal use only. properties: index: type: array @@ -148,7 +148,7 @@ baseSearchResponse: $ref: './IndexSettings.yml#/userData' queryID: type: string - description: Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/). + description: Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics). example: 'a00dbc80a8d13c4565a442e7e2dca80a' _automaticInsights: type: boolean diff --git a/specs/composition/spec.yml b/specs/composition/spec.yml index ca4dd76d4f6..3a21781bdb7 100644 --- a/specs/composition/spec.yml +++ b/specs/composition/spec.yml @@ -8,7 +8,7 @@ info: Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem) ## Base URLs diff --git a/specs/crawler/common/parameters.yml b/specs/crawler/common/parameters.yml index 9b438861290..4ef51428b2e 100644 --- a/specs/crawler/common/parameters.yml +++ b/specs/crawler/common/parameters.yml @@ -100,7 +100,7 @@ urlsCrawledGroupStatus: description: | Crawled URL status. - For more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/). + For more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status). enum: - DONE - SKIPPED @@ -111,7 +111,7 @@ urlsCrawledGroupCategory: description: | Step where the status information was generated. - For more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/). + For more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status). enum: - fetch - extraction diff --git a/specs/crawler/common/schemas/action.yml b/specs/crawler/common/schemas/action.yml index 00206d39246..45c4d4addac 100644 --- a/specs/crawler/common/schemas/action.yml +++ b/specs/crawler/common/schemas/action.yml @@ -83,7 +83,7 @@ Action: description: | How often to perform a complete crawl for this action. - For mopre information, consult the [`schedule` parameter documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule/). + For mopre information, consult the [`schedule` parameter documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule). selectorsToMatch: type: array description: | @@ -116,7 +116,7 @@ ActionSchedule: fileTypes: type: string description: | - For more information, see [Extract data from non-HTML documents](https://www.algolia.com/doc/tools/crawler/extracting-data/non-html-documents/). + For more information, see [Extract data from non-HTML documents](https://www.algolia.com/doc/tools/crawler/extracting-data/non-html-documents). enum: - doc - email diff --git a/specs/crawler/common/schemas/configuration.yml b/specs/crawler/common/schemas/configuration.yml index 2380a7fc6d5..89a6860bdb8 100644 --- a/specs/crawler/common/schemas/configuration.yml +++ b/specs/crawler/common/schemas/configuration.yml @@ -47,7 +47,7 @@ Configuration: maxItems: 10 items: type: string - description: For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data/). + description: For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data). example: testCSV extraUrls: type: array @@ -113,7 +113,7 @@ Configuration: These index settings are only applied during the first crawl of an index. Any subsequent changes won't be applied to the index. - Instead, make changes to your index settings in the [Algolia dashboard](https://dashboard.algolia.com/explorer/configuration/). + Instead, make changes to your index settings in the [Algolia dashboard](https://dashboard.algolia.com/explorer/configuration). additionalProperties: $ref: '../../../common/schemas/IndexSettings.yml#/indexSettings' x-additionalPropertiesName: indexName @@ -123,7 +123,7 @@ Configuration: description: | Function for extracting URLs from links on crawled pages. - For more information, see the [`linkExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/link-extractor/). + For more information, see the [`linkExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/link-extractor). properties: __type: $ref: './action.yml#/configurationRecordExtractorType' @@ -566,9 +566,9 @@ schedule: Schedule for running the crawl. Instead of manually starting a crawl each time, you can set up a schedule for automatic crawls. - [Use the visual UI](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration-visual/) or add the `schedule` parameter to [your configuration](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/). + [Use the visual UI](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration-visual) or add the `schedule` parameter to [your configuration](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration). - `schedule` uses [Later.js syntax](https://bunkat.github.io/later/) to specify when to crawl your site. + `schedule` uses [Later.js syntax](https://bunkat.github.io/later) to specify when to crawl your site. Here are some key things to keep in mind when using `Later.js` syntax with the Crawler: - The interval between two scheduled crawls must be at least 24 hours. diff --git a/specs/ingestion/helpers/chunkedPush.yml b/specs/ingestion/helpers/chunkedPush.yml index eb9173a413f..ad2e2e607b8 100644 --- a/specs/ingestion/helpers/chunkedPush.yml +++ b/specs/ingestion/helpers/chunkedPush.yml @@ -12,7 +12,7 @@ method: operationId: chunkedPush summary: Replace all records in an index description: | - Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `push` requests by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/). + Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `push` requests by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push). parameters: - in: query name: indexName diff --git a/specs/ingestion/paths/push.yml b/specs/ingestion/paths/push.yml index 1e2d65a1a9c..537ab78fc3a 100644 --- a/specs/ingestion/paths/push.yml +++ b/specs/ingestion/paths/push.yml @@ -6,7 +6,7 @@ post: Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. - If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. + If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned. diff --git a/specs/ingestion/paths/tasks/v2/pushTask.yml b/specs/ingestion/paths/tasks/v2/pushTask.yml index 1dd73ef8c8f..a0e5da2cd39 100644 --- a/specs/ingestion/paths/tasks/v2/pushTask.yml +++ b/specs/ingestion/paths/tasks/v2/pushTask.yml @@ -11,7 +11,7 @@ post: This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`. operationId: pushTask externalDocs: - url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/ + url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data description: Pre-indexing data transformation. x-acl: - addObject diff --git a/specs/insights/common/schemas/EventAttributes.yml b/specs/insights/common/schemas/EventAttributes.yml index 2e6c3e91d6a..7a420c0b897 100644 --- a/specs/insights/common/schemas/EventAttributes.yml +++ b/specs/insights/common/schemas/EventAttributes.yml @@ -24,7 +24,7 @@ userToken: Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. - For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). + For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). example: test-user-1 authenticatedUserToken: @@ -38,7 +38,7 @@ authenticatedUserToken: When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. - For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). + For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). example: c6a52c02-d0c7-4b53-8ce3-2b8fd202f3f9 timestamp: diff --git a/specs/insights/paths/pushEvents.yml b/specs/insights/paths/pushEvents.yml index fc186591422..3f1a9a0bbfe 100644 --- a/specs/insights/paths/pushEvents.yml +++ b/specs/insights/paths/pushEvents.yml @@ -243,7 +243,7 @@ post: description: Check that you're using the correct URL. value: status: 404 - message: Path not supported by Insights REST API. Please have a look at [https://www.algolia.com/doc/rest-api/insights/](https://www.algolia.com/doc/rest-api/insights/) for the list of valid commands. + message: Path not supported by Insights REST API. Please have a look at [https://www.algolia.com/doc/rest-api/insights/](https://www.algolia.com/doc/rest-api/insights) for the list of valid commands. '405': description: Method Not Allowed. content: diff --git a/specs/insights/spec.yml b/specs/insights/spec.yml index bae55c400aa..4674e5af99f 100644 --- a/specs/insights/spec.yml +++ b/specs/insights/spec.yml @@ -10,7 +10,7 @@ info: ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/). + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem). ## Base URLs @@ -54,7 +54,7 @@ info: The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. version: 1.0.0 externalDocs: - url: https://www.algolia.com/doc/guides/sending-events/getting-started/ + url: https://www.algolia.com/doc/guides/sending-events/getting-started description: Events components: securitySchemes: diff --git a/specs/personalization/spec.yml b/specs/personalization/spec.yml index d8e88f1e5a4..0990f2f7cfa 100644 --- a/specs/personalization/spec.yml +++ b/specs/personalization/spec.yml @@ -46,7 +46,7 @@ info: - `x-ratelimit-limit`: The number of requests allowed every second. - `x-ratelimit-remaining`: The number of requests remaining in the current second period. - - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of + - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of the next time period. ## Version @@ -54,7 +54,7 @@ info: The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL. version: 1.0.0 externalDocs: - url: https://www.algolia.com/doc/guides/personalization/what-is-personalization/ + url: https://www.algolia.com/doc/guides/personalization/what-is-personalization description: Algolia Personalization. components: securitySchemes: diff --git a/specs/query-suggestions/common/schemas/Configuration.yml b/specs/query-suggestions/common/schemas/Configuration.yml index cfb2b043001..ae3b78386c4 100644 --- a/specs/query-suggestions/common/schemas/Configuration.yml +++ b/specs/query-suggestions/common/schemas/Configuration.yml @@ -108,7 +108,7 @@ AnalyticsTags: title: analyticsTags description: | Analytics tags for filtering the popular searches. - For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments). default: null oneOf: - type: array diff --git a/specs/query-suggestions/spec.yml b/specs/query-suggestions/spec.yml index 747a617af91..87bb6be5e33 100644 --- a/specs/query-suggestions/spec.yml +++ b/specs/query-suggestions/spec.yml @@ -4,7 +4,7 @@ info: description: | The Query Suggestions API lets you manage your Query Suggestions configurations. Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. - In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js/) to guide users and speed up their search. + In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js) to guide users and speed up their search. ## Base URLs diff --git a/specs/recommend/spec.yml b/specs/recommend/spec.yml index e5c918d289d..68cf39a38f9 100644 --- a/specs/recommend/spec.yml +++ b/specs/recommend/spec.yml @@ -7,9 +7,9 @@ info: ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. - The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). + The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla). - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem) ## Base URLs @@ -96,15 +96,15 @@ security: tags: - name: recommendations x-displayName: Recommendations - description: Retrieve recommendations from a pre-trained AI model. You can train models in the [Algolia dashboard](https://dashboard.algolia.com/recommend/). + description: Retrieve recommendations from a pre-trained AI model. You can train models in the [Algolia dashboard](https://dashboard.algolia.com/recommend). externalDocs: - url: https://www.algolia.com/doc/guides/algolia-recommend/overview/ + url: https://www.algolia.com/doc/guides/algolia-recommend/overview description: Algolia Recommend. - name: rules x-displayName: Rules description: Curate your recommendations with rules, which are _if_-_then_ statements. externalDocs: - url: https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/ + url: https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules description: Recommend Rules. x-tagGroups: - name: Recommend diff --git a/specs/search/helpers/partialUpdateObjectsWithTransformation.yml b/specs/search/helpers/partialUpdateObjectsWithTransformation.yml index 544f7ebeeee..eac22717a29 100644 --- a/specs/search/helpers/partialUpdateObjectsWithTransformation.yml +++ b/specs/search/helpers/partialUpdateObjectsWithTransformation.yml @@ -10,9 +10,9 @@ method: tags: - Records operationId: partialUpdateObjectsWithTransformation - summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) + summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push) description: | - Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. + Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. parameters: - in: query name: indexName diff --git a/specs/search/helpers/replaceAllObjectsWithTransformation.yml b/specs/search/helpers/replaceAllObjectsWithTransformation.yml index 5bcaee7546d..ea99f18f8bd 100644 --- a/specs/search/helpers/replaceAllObjectsWithTransformation.yml +++ b/specs/search/helpers/replaceAllObjectsWithTransformation.yml @@ -12,7 +12,7 @@ method: operationId: replaceAllObjectsWithTransformation summary: Replace all records in an index description: | - Replace all records from your index with a new set of records by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/). + Replace all records from your index with a new set of records by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push). This method lets you replace all records in your index without downtime. It performs these operations: 1. Copy settings, synonyms, and rules from your original index to a temporary index. diff --git a/specs/search/helpers/saveObjectsWithTransformation.yml b/specs/search/helpers/saveObjectsWithTransformation.yml index db8d7f7de79..2f0977b0f82 100644 --- a/specs/search/helpers/saveObjectsWithTransformation.yml +++ b/specs/search/helpers/saveObjectsWithTransformation.yml @@ -10,9 +10,9 @@ method: tags: - Records operationId: saveObjectsWithTransformation - summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) + summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push) description: | - Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. + Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. parameters: - in: query name: indexName diff --git a/specs/search/paths/dictionaries/common/parameters.yml b/specs/search/paths/dictionaries/common/parameters.yml index 1db552e7f70..cfb5ea4b618 100644 --- a/specs/search/paths/dictionaries/common/parameters.yml +++ b/specs/search/paths/dictionaries/common/parameters.yml @@ -14,7 +14,7 @@ dictionaryType: standardEntries: type: object description: | - Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values. + Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values. additionalProperties: false properties: plurals: diff --git a/specs/search/paths/dictionaries/getDictionaryLanguages.yml b/specs/search/paths/dictionaries/getDictionaryLanguages.yml index 5b56777d8fc..f9ab414bf19 100644 --- a/specs/search/paths/dictionaries/getDictionaryLanguages.yml +++ b/specs/search/paths/dictionaries/getDictionaryLanguages.yml @@ -8,7 +8,7 @@ get: Lists supported languages with their supported dictionary types and number of custom entries. summary: List available languages externalDocs: - url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/ + url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages description: Supported languages. responses: '200': diff --git a/specs/search/paths/keys/common/schemas.yml b/specs/search/paths/keys/common/schemas.yml index 12d42e97d2f..7b4581b674d 100644 --- a/specs/search/paths/keys/common/schemas.yml +++ b/specs/search/paths/keys/common/schemas.yml @@ -46,7 +46,7 @@ apiKey: maxQueriesPerIPPerHour: type: integer description: | - Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour. + Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit. diff --git a/specs/search/paths/manage_indices/operationIndex.yml b/specs/search/paths/manage_indices/operationIndex.yml index ff2ed69af3a..db7f0d93bd2 100644 --- a/specs/search/paths/manage_indices/operationIndex.yml +++ b/specs/search/paths/manage_indices/operationIndex.yml @@ -19,7 +19,7 @@ post: - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) + - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** @@ -27,7 +27,7 @@ post: - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - 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/). + - 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). parameters: diff --git a/specs/search/paths/multiclusters/searchUserIds.yml b/specs/search/paths/multiclusters/searchUserIds.yml index 91f7bc6205b..17afc0f5f47 100644 --- a/specs/search/paths/multiclusters/searchUserIds.yml +++ b/specs/search/paths/multiclusters/searchUserIds.yml @@ -25,7 +25,6 @@ post: properties: query: type: string - description: Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users. clusterName: $ref: '../../common/schemas/Cluster.yml#/clusterName' page: diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index 584871f7a06..b6f65e3700e 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -73,9 +73,9 @@ delete: - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. - For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). + For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas). externalDocs: - url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/delete-indices/ + url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/delete-indices description: Delete indices. parameters: - $ref: '../../../common/parameters.yml#/IndexName' diff --git a/specs/search/paths/synonyms/common/schemas.yml b/specs/search/paths/synonyms/common/schemas.yml index 8595d099400..0d5276c0dd4 100644 --- a/specs/search/paths/synonyms/common/schemas.yml +++ b/specs/search/paths/synonyms/common/schemas.yml @@ -23,11 +23,11 @@ synonymHit: example: ['vehicle', 'auto'] input: type: string - description: Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)). + description: Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms)). example: 'car' word: type: string - description: Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)). + description: Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections)). example: 'car' corrections: type: array @@ -38,13 +38,13 @@ synonymHit: placeholder: type: string description: | - [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records. + [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records. example: '' replacements: type: array items: type: string - description: Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/). + description: Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders). example: ['street', 'st'] required: - objectID diff --git a/specs/search/spec.yml b/specs/search/spec.yml index 1f81f7fb139..296a1b52632 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -7,9 +7,9 @@ info: ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. - The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). + The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla). - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem) ## Base URLs @@ -120,7 +120,7 @@ tags: API requests must be authenticated with an API key. API keys can have permissions (access control lists, ACL) and restrictions. externalDocs: - url: https://www.algolia.com/doc/guides/security/api-keys/ + url: https://www.algolia.com/doc/guides/security/api-keys description: API keys. - name: Clusters @@ -138,7 +138,7 @@ tags: Dictionaries are application-wide. externalDocs: - url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/ + url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp description: Natural languages. - name: Indices description: | @@ -147,7 +147,7 @@ tags: Indices are copies of your data that are stored on Algolia's servers. They're optimal data structures for fast search and are made up of records and settings. externalDocs: - url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/ + url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices description: Manage your indices. - name: Records description: | @@ -158,7 +158,7 @@ tags: 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). externalDocs: - url: https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/ + url: https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data description: Prepare your records. - name: Rules description: | @@ -169,7 +169,7 @@ tags: Consequences are changes to the search results, such as changing the order of search results or boosting a facet. This can be useful for tuning specific queries or for merchandising. externalDocs: - url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/ + url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview description: Index Rules. - name: Search description: Search one or more indices for matching records or facet values. @@ -179,12 +179,12 @@ tags: Synonyms are terms that the search engine should consider equal. externalDocs: - url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/ + url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms description: Synonyms. - name: Vaults description: Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest. externalDocs: - url: https://www.algolia.com/doc/guides/security/algolia-vault/ + url: https://www.algolia.com/doc/guides/security/algolia-vault description: Algolia Vault. - name: _model_index_settings x-displayName: Index settings