@graphcommerce/algolia-products 10.0.0-canary.66 → 10.0.0-canary.68

package/algolia-spec.yaml

@@ -115,6 +115,7 @@ info:
     
     The current version of the Search API is version 1, as indicated by the `/1/` in each endpoint's URL.
 
+
   version: 1.0.0
 servers:
   - url: https://{appId}.algolia.net
@@ -153,6 +154,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: |
@@ -174,10 +176,12 @@ 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.
   - name: Indices
@@ -189,10 +193,12 @@ 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.
   - name: Records
@@ -208,10 +214,12 @@ 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.
   - name: Rules
@@ -227,10 +235,12 @@ 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.
   - name: Search
@@ -244,12 +254,14 @@ tags:
       url: >-
         https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/
 
+
       description: |
         Related guide: 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: |
@@ -278,6 +290,7 @@ paths:
         
         If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
 
+
       parameters:
         - $ref: '#/components/parameters/IndexName'
       requestBody:
@@ -325,11 +338,13 @@ paths:
         
         Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
 
+
       requestBody:
         required: true
         description: >-
           Muli-search request body. Results are returned in the same order as the requests.
 
+
         content:
           application/json:
             schema:
@@ -387,6 +402,7 @@ paths:
           You can adjust this with the `sortFacetValueBy` parameter.
         - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.
 
+
       parameters:
         - $ref: '#/components/parameters/IndexName'
         - name: facetName
@@ -396,6 +412,7 @@ paths:
             
             This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
 
+
           in: path
           required: true
           schema:
@@ -545,6 +562,7 @@ paths:
         
         To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
 
+
       parameters:
         - $ref: '#/components/parameters/IndexName'
         - $ref: '#/components/parameters/ObjectIDRule'
@@ -703,6 +721,7 @@ paths:
       description: >-
         Retrieves the languages for which standard dictionary entries are turned off.
 
+
       responses:
         '200':
           description: OK
@@ -735,11 +754,13 @@ paths:
       description: >
         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/
 
+
         description: Supported languages.
       responses:
         '200':
@@ -778,6 +799,7 @@ components:
         
         The required ACL to make a request is listed in each endpoint's reference.
 
+
   schemas:
     attributeToUpdate:
       x-keep-model: true
@@ -856,6 +878,7 @@ components:
         
         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
@@ -878,6 +901,7 @@ components:
         
         `facet:\-value`.
 
+
       x-categories:
         - Filtering
       type: object
@@ -901,6 +925,7 @@ components:
         
         - Optional filters don't work with numeric attributes.
 
+
       example:
         - category:Book
         - author:John Doe
@@ -927,6 +952,7 @@ components:
         
         The same combination rules apply as for `facetFilters`.
 
+
       example:
         - - inStock = 1
           - deliveryDate < 1441755506
@@ -952,6 +978,7 @@ components:
         
         The same combination and escaping rules apply as for `facetFilters`.
 
+
       example:
         - - Book
           - Movie
@@ -981,6 +1008,7 @@ components:
         
         This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
 
+
       example: 40.71,-74.01
       x-categories:
         - Geo-Search
@@ -995,6 +1023,7 @@ components:
       description: >-
         Return all records with a valid `_geoloc` attribute. Don't filter by distance.
 
+
       enum:
         - all
     aroundRadius:
@@ -1008,6 +1037,7 @@ components:
         
         The search radius is small if there are many hits close to the central coordinates.
 
+
       oneOf:
         - type: integer
           minimum: 1
@@ -1024,18 +1054,21 @@ components:
         description: >-
           Range object with lower and upper values in meters to define custom ranges.
 
+
         properties:
           from:
             type: integer
             description: >-
               Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
 
+
             example: 20
           value:
             type: integer
             description: >-
               Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
 
+
     aroundPrecision:
       description: >
         Precision of a coordinate-based search in meters to group results with similar distances.
@@ -1043,6 +1076,7 @@ components:
         
         The Geo ranking criterion considers all matches within the same range of distances to be equal.
 
+
       oneOf:
         - type: integer
           default: 10
@@ -1054,6 +1088,7 @@ components:
             
             as are records between 100 and 199 meters.
 
+
         - $ref: '#/components/schemas/aroundPrecisionFromValue'
       x-categories:
         - Geo-Search
@@ -1078,6 +1113,7 @@ components:
         
         For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
 
+
       example:
         - - 47.3165
           - 4.9665
@@ -1115,6 +1151,7 @@ components:
         
         This parameter is ignored if you also specify `insideBoundingBox`.
 
+
       example:
         - - 47.3165
           - 4.9665
@@ -1212,6 +1249,7 @@ components:
         
         For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
 
+
       example: test-user-123
       x-categories:
         - Personalization
@@ -1241,6 +1279,7 @@ components:
             
             Combine it with `filters` to narrow down the list of results.
 
+
           example: comedy drama crime Macy Buscemi
           x-categories:
             - Search
@@ -1266,6 +1305,7 @@ components:
             
             For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
 
+
           x-categories:
             - Filtering
         restrictSearchableAttributes:
@@ -1292,6 +1332,7 @@ components:
             
             For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
 
+
           default: []
           x-categories:
             - Faceting
@@ -1307,6 +1348,7 @@ components:
             
             as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
 
+
           x-categories:
             - Faceting
         page:
@@ -1336,6 +1378,7 @@ components:
           description: >-
             Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
 
+
           minimum: 1
           x-categories:
             - Geo-Search
@@ -1357,6 +1400,7 @@ components:
             
             - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
 
+
           x-categories:
             - Languages
         ruleContexts:
@@ -1369,6 +1413,7 @@ components:
             
             [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
 
+
           example:
             - mobile
           x-categories:
@@ -1383,6 +1428,7 @@ components:
             
             For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
 
+
           minimum: 0
           maximum: 100
           x-categories:
@@ -1394,6 +1440,7 @@ components:
           description: >-
             Whether the search response should include detailed ranking information.
 
+
           x-categories:
             - Advanced
         synonyms:
@@ -1409,6 +1456,7 @@ components:
             
             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/).
 
+
           x-categories:
             - Analytics
         analytics:
@@ -1423,6 +1471,7 @@ components:
           description: >-
             Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
 
+
           x-categories:
             - Analytics
         percentileComputation:
@@ -1430,6 +1479,7 @@ components:
           description: >-
             Whether to include this search when calculating processing-time percentiles.
 
+
           x-categories:
             - Advanced
         enableABTest:
@@ -1469,12 +1519,14 @@ components:
         
         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
           description: >-
             Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.
 
+
         - $ref: '#/components/schemas/typoToleranceEnum'
       x-categories:
         - Typos
@@ -1504,6 +1556,7 @@ components:
             
             If false, singulars, plurals, and other declensions won't be considered equivalent.
 
+
           default: false
       x-categories:
         - Languages
@@ -1519,6 +1572,7 @@ components:
         
         You should only use this feature for the languages used in your index.
 
+
       example:
         - ca
         - es
@@ -1527,6 +1581,7 @@ components:
           description: >-
             ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.
 
+
           items:
             $ref: '#/components/schemas/supportedLanguage'
         - type: boolean
@@ -1536,6 +1591,7 @@ components:
             
             If false, stop words are not removed.
 
+
       x-categories:
         - Languages
     queryType:
@@ -1559,6 +1615,7 @@ components:
         
         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/).
 
+
       x-categories:
         - Query strategy
     removeWordsIfNoResults:
@@ -1591,6 +1648,7 @@ components:
         
         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/).
 
+
       x-categories:
         - Query strategy
     mode:
@@ -1604,6 +1662,7 @@ components:
         
         This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
 
+
       x-categories:
         - Query strategy
     semanticSearch:
@@ -1632,6 +1691,7 @@ components:
       description: >-
         List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
 
+
       x-categories:
         - Query strategy
     optionalWords:
@@ -1662,6 +1722,7 @@ components:
         
         For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
 
+
       oneOf:
         - type: string
         - type: 'null'
@@ -1689,6 +1750,7 @@ components:
           Only exact matches will be highlighted,
           partial and prefix matches won't.
 
+
       x-categories:
         - Query strategy
     alternativesAsExact:
@@ -1721,12 +1783,14 @@ components:
         
         The `distinct` setting is ignored if `attributeForDistinct` is not set.
 
+
       example: 1
       oneOf:
         - type: boolean
           description: >-
             Whether deduplication is turned on. If true, only one member of a group is shown in the search results.
 
+
         - type: integer
           description: >
             Number of members of a group of records to include in the search results.
@@ -1738,6 +1802,7 @@ components:
               For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.
               Likewise, the `nbHits` response attribute contains the number of returned groups.
 
+
           minimum: 0
           maximum: 4
           default: 0
@@ -1750,6 +1815,7 @@ components:
         
         This setting lets you always show specific facets or facet values at the top of the list.
 
+
       type: array
       items:
         type: string
@@ -1775,6 +1841,7 @@ components:
         - `hidden`.
           Don't show facet values that aren't explicitly positioned.
 
+
       type: string
       enum:
         - count
@@ -1872,6 +1939,7 @@ components:
         
         without changing your frontend code.
 
+
       type: object
       additionalProperties: false
       properties:
@@ -1887,6 +1955,7 @@ components:
       description: >
         Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
 
+
       oneOf:
         - type: array
           items:
@@ -1921,6 +1990,7 @@ components:
             
             - The `objectID` attribute is always included.
 
+
           x-categories:
             - Attributes
         ranking:
@@ -1954,6 +2024,7 @@ components:
             
             and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
 
+
           x-categories:
             - Ranking
         relevancyStrictness:
@@ -1967,6 +2038,7 @@ components:
             
             Use this setting to strike a balance between the relevance and number of returned results.
 
+
           x-categories:
             - Ranking
         attributesToHighlight:
@@ -1996,6 +2068,7 @@ components:
             
             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
         attributesToSnippet:
@@ -2021,6 +2094,7 @@ components:
             
             where `NUMBER` is the number of words to be extracted.
 
+
           x-categories:
             - Highlighting and Snippeting
         highlightPreTag:
@@ -2028,6 +2102,7 @@ components:
           description: >-
             HTML tag to insert before the highlighted parts in all highlighted results and snippets.
 
+
           x-categories:
             - Highlighting and Snippeting
         highlightPostTag:
@@ -2035,6 +2110,7 @@ components:
           description: >-
             HTML tag to insert after the highlighted parts in all highlighted results and snippets.
 
+
           x-categories:
             - Highlighting and Snippeting
         snippetEllipsisText:
@@ -2049,6 +2125,7 @@ components:
             
             By default, all items are highlighted and snippeted.
 
+
           x-categories:
             - Highlighting and Snippeting
         hitsPerPage:
@@ -2058,6 +2135,7 @@ components:
           description: >-
             Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
 
+
           x-categories:
             - Typos
         minWordSizefor2Typos:
@@ -2065,6 +2143,7 @@ components:
           description: >-
             Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
 
+
           x-categories:
             - Typos
         typoTolerance:
@@ -2100,6 +2179,7 @@ components:
             
             Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
 
+
           x-categories:
             - Typos
         ignorePlurals:
@@ -2133,6 +2213,7 @@ components:
             
             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/).
 
+
           x-categories:
             - Languages
         decompoundQuery:
@@ -2149,6 +2230,7 @@ components:
             
             For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
 
+
           x-categories:
             - Languages
         enableRules:
@@ -2177,6 +2259,7 @@ components:
             
             Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
 
+
           x-categories:
             - Query strategy
         optionalWords:
@@ -2201,6 +2284,7 @@ components:
             
             This reduces the impact of individual attributes with a lot of content on ranking.
 
+
           x-categories:
             - Query strategy
         exactOnSingleWordQuery:
@@ -2232,6 +2316,7 @@ components:
             - `multiWordsSynonym`.
               Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
 
+
           x-categories:
             - Query strategy
         advancedSyntaxFeatures:
@@ -2273,6 +2358,7 @@ components:
             
             but all occurrences of "house" are replaced by "home" in the highlighted response.
 
+
           x-categories:
             - Highlighting and Snippeting
         minProximity:
@@ -2290,6 +2376,7 @@ components:
             
             For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
 
+
           x-categories:
             - Advanced
         responseFields:
@@ -2321,6 +2408,7 @@ components:
             
             Before restricting the response size, check the impact on your search experience.
 
+
           x-categories:
             - Advanced
         maxValuesPerFacet:
@@ -2346,6 +2434,7 @@ components:
             
             For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
 
+
           x-categories:
             - Faceting
         attributeCriteriaComputedByMinProximity:
@@ -2360,6 +2449,7 @@ components:
             
             Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
 
+
           x-categories:
             - Advanced
         renderingContent:
@@ -2372,6 +2462,7 @@ components:
             
             This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
 
+
           x-categories:
             - Filtering
         reRankingApplyFilter:
@@ -2383,6 +2474,7 @@ components:
       description: >-
         Each parameter value, including the `query` must not be larger than 512 bytes.
 
+
       allOf:
         - $ref: '#/components/schemas/baseSearchParams'
         - $ref: '#/components/schemas/indexSettingsAsSearchParams'
@@ -2441,12 +2533,14 @@ components:
           description: >-
             A/B test ID. This is only included in the response for indices that are part of an A/B test.
 
+
         abTestVariantID:
           type: integer
           minimum: 1
           description: >-
             Variant ID. This is only included in the response for indices that are part of an A/B test.
 
+
         aroundLatLng:
           type: string
           description: Computed geographical location.
@@ -2461,6 +2555,7 @@ components:
           description: >-
             Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
 
+
           properties:
             facetsCount:
               type: boolean
@@ -2468,6 +2563,7 @@ components:
               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-).
 
+
             facetValues:
               type: boolean
               title: facetValues
@@ -2478,18 +2574,21 @@ components:
               description: >-
                 Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
 
+
             rulesMatch:
               type: boolean
               title: rulesMatch
               description: >-
                 Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
 
+
             typo:
               type: boolean
               title: typo
               description: >-
                 Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
 
+
         appliedRules:
           description: Rules applied to the query.
           title: appliedRules
@@ -2501,6 +2600,7 @@ components:
           description: >-
             See the `facetsCount` field of the `exhaustive` object in the response.
 
+
           deprecated: true
         exhaustiveNbHits:
           type: boolean
@@ -2552,6 +2652,7 @@ components:
           description: >-
             Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
 
+
           example: indexNameAlt
         message:
           type: string
@@ -2565,6 +2666,7 @@ components:
           description: >-
             Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
 
+
           example: george clo
         processingTimeMS:
           $ref: '#/components/schemas/processingTimeMS'
@@ -2573,17 +2675,20 @@ components:
           description: >-
             Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
 
+
         queryAfterRemoval:
           type: string
           description: >-
             Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
 
+
         redirect:
           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.
 
+
           properties:
             index:
               type: array
@@ -2606,6 +2711,7 @@ components:
           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
@@ -2741,6 +2847,7 @@ components:
           description: >-
             Distance between the matched location and the search location (in meters).
 
+
     personalization:
       type: object
       properties:
@@ -2768,12 +2875,14 @@ components:
           description: >-
             Position of the first matched word in the best matching attribute of the record.
 
+
         geoDistance:
           type: integer
           minimum: 0
           description: >-
             Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
 
+
         geoPrecision:
           type: integer
           minimum: 1
@@ -2799,11 +2908,13 @@ components:
           description: >-
             Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
 
+
         userScore:
           type: integer
           description: >-
             Overall ranking of the record, expressed as a single integer. This attribute is internal.
 
+
         words:
           type: integer
           minimum: 1
@@ -2827,6 +2938,7 @@ components:
         
         A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
 
+
       x-is-generic: true
       additionalProperties: true
       required:
@@ -2854,6 +2966,7 @@ components:
             
             Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
 
+
           items:
             $ref: '#/components/schemas/hit'
         query:
@@ -2885,6 +2998,7 @@ components:
         
         - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
 
+
     searchForHitsOptions:
       x-is-SearchForHitsOptions: true
       type: object
@@ -2908,6 +3022,7 @@ components:
       description: >-
         Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
 
+
       maximum: 100
       x-categories:
         - Advanced
@@ -2920,6 +3035,7 @@ components:
         
         - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
 
+
     searchForFacetsOptions:
       type: object
       properties:
@@ -2962,6 +3078,7 @@ components:
         
         - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
 
+
     searchForFacetValuesResponse:
       type: object
       additionalProperties: false
@@ -2993,6 +3110,7 @@ components:
                 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-).
 
+
                 type: integer
         exhaustiveFacetsCount:
           type: boolean
@@ -3001,6 +3119,7 @@ components:
             
             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-).
 
+
         processingTimeMS:
           $ref: '#/components/schemas/processingTimeMS'
     searchResult:
@@ -3021,6 +3140,7 @@ components:
             
             The last page of the response does not return a `cursor` attribute.
 
+
           example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN
     browseParamsObject:
       allOf:
@@ -3062,6 +3182,7 @@ components:
         
         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`.
 
+
     deletedAt:
       type: string
       example: '2023-06-27T14:42:38.831Z'
@@ -3212,6 +3333,7 @@ components:
               This ensures accurate facet counts.
               You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
 
+
           x-categories:
             - Faceting
         replicas:
@@ -3243,6 +3365,7 @@ components:
               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/).
 
+
           x-categories:
             - Ranking
         paginationLimitedTo:
@@ -3256,6 +3379,7 @@ components:
             
             For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
 
+
           maximum: 20000
         unretrievableAttributes:
           type: array
@@ -3273,6 +3397,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Attributes
         disableTypoToleranceOnWords:
@@ -3287,6 +3412,7 @@ components:
             
             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.
 
+
           x-categories:
             - Typos
         attributesToTransliterate:
@@ -3300,6 +3426,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           type: array
           items:
             type: string
@@ -3319,6 +3446,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Languages
         decompoundedAttributes:
@@ -3349,6 +3477,7 @@ components:
             
             For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
 
+
           x-categories:
             - Languages
         indexLanguages:
@@ -3371,6 +3500,7 @@ components:
             
             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/).
 
+
           x-categories:
             - Languages
         disablePrefixOnAttributes:
@@ -3384,6 +3514,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Query strategy
         allowCompressionOfIntegerArray:
@@ -3393,6 +3524,7 @@ components:
             
             If true, the compressed arrays may be reordered.
 
+
           x-categories:
             - Performance
         numericAttributesForFiltering:
@@ -3419,6 +3551,7 @@ components:
             - `equalOnly("ATTRIBUTE")`.
               Support only filtering based on equality comparisons `=` and `!=`.
 
+
           example:
             - equalOnly(quantity)
             - popularity
@@ -3443,6 +3576,7 @@ components:
             
             For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
 
+
           x-categories:
             - Typos
         searchableAttributes:
@@ -3480,6 +3614,7 @@ components:
             
             Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
 
+
           x-categories:
             - Attributes
         userData:
@@ -3490,6 +3625,7 @@ components:
             
             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
           additionalProperties:
             type: object
@@ -3515,6 +3651,7 @@ components:
             
             This applies faceting _after_ deduplication, which will result in accurate facet counts.
 
+
           example: url
           type: string
         maxFacetHits:
@@ -3566,6 +3703,7 @@ components:
             
             or the other attributes will never be applied.
 
+
           x-categories:
             - Ranking
     indexSettings:
@@ -3582,6 +3720,7 @@ components:
           description: >
             Replica indices only: the name of the primary index for this replica.
 
+
     settingsResponse:
       allOf:
         - $ref: '#/components/schemas/indexSettings'
@@ -3623,12 +3762,14 @@ components:
           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/)).
 
+
           example: car
         corrections:
           type: array
@@ -3643,6 +3784,7 @@ components:
           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.
 
+
           example: <Street>
         replacements:
           type: array
@@ -3651,6 +3793,7 @@ components:
           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
@@ -3688,6 +3831,7 @@ components:
       description: >-
         Timestamp when the object was created, in milliseconds since the Unix epoch.
 
+
     baseGetApiKeyResponse:
       type: object
       additionalProperties: false
@@ -3732,6 +3876,7 @@ components:
             
             For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
 
+
           example:
             - search
             - addObject
@@ -3758,6 +3903,7 @@ components:
             
             - `*_products_*` matches all indices containing "_products_".
 
+
           example:
             - dev_*
             - prod_en_products
@@ -3778,6 +3924,7 @@ components:
             
             By default, there's no limit.
 
+
         queryParameters:
           type: string
           description: >
@@ -3791,6 +3938,7 @@ components:
             
             Creating an API key fails if the request is made from an IP address outside the restricted range.
 
+
           example: typoTolerance=strict&restrictSources=192.168.1.0/24
         referers:
           type: array
@@ -3814,6 +3962,7 @@ components:
             
             For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
 
+
           example:
             - '*algolia.com*'
           items:
@@ -3871,6 +4020,7 @@ components:
         
         A rule context must only contain alphanumeric characters.
 
+
       example: mobile
     condition:
       type: object
@@ -3888,6 +4038,7 @@ components:
             
             For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as "comedy".
 
+
           example: '{facet:genre}'
         anchoring:
           $ref: '#/components/schemas/anchoring'
@@ -3908,6 +4059,7 @@ components:
             
             You can't combine multiple filters with `OR` and you can't use numeric filters.
 
+
           example: genre:comedy
     editType:
       description: Type of edit.
@@ -3928,6 +4080,7 @@ components:
           description: >-
             Text to be added in place of the deleted text inside the query string.
 
+
           type: string
     consequenceQueryObject:
       type: object
@@ -3952,6 +4105,7 @@ components:
         
         If `consequenceQuery` is an object, it describes incremental edits made to the query.
 
+
       oneOf:
         - $ref: '#/components/schemas/consequenceQueryObject'
         - type: string
@@ -3969,6 +4123,7 @@ components:
             
             For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
 
+
         score:
           type: integer
           description: Filter scores to give different weights to individual filters.
@@ -3982,6 +4137,7 @@ components:
             
             If false, multiple occurences are combined with the logical `AND` operation.
 
+
       required:
         - facet
     automaticFacetFilters:
@@ -3995,6 +4151,7 @@ components:
         
         you can filter the results to show the top-ranked comedy movies.
 
+
       oneOf:
         - type: array
           items:
@@ -4010,6 +4167,7 @@ components:
         
         You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
 
+
       additionalProperties: false
       properties:
         query:
@@ -4030,6 +4188,7 @@ components:
       description: >-
         Position in the search results where you want to show the promoted records.
 
+
       example: 0
     promoteObjectIDs:
       title: objectIDs
@@ -4082,6 +4241,7 @@ components:
         
         For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
 
+
       additionalProperties: false
       properties:
         params:
@@ -4095,6 +4255,7 @@ components:
             
             You can promote up to 300 records, either individually, or as groups of up to 100 records each.
 
+
           items:
             $ref: '#/components/schemas/promote'
         filterPromotes:
@@ -4109,6 +4270,7 @@ components:
             
             the "red" record won't be shown.
 
+
         hide:
           type: array
           maxItems: 50
@@ -4130,6 +4292,7 @@ components:
             
             This object isn't interpreted by the API and is limited to 1&nbsp;kB of minified JSON.
 
+
           example:
             settingID: f2a7b51e3503acc6a39b3784ffb84300
             pluginVersion: 1.6.0
@@ -4167,6 +4330,7 @@ components:
             
             For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
 
+
           items:
             $ref: '#/components/schemas/condition'
         consequence:
@@ -4176,6 +4340,7 @@ components:
           description: >-
             Description of the rule's purpose to help you distinguish between different rules.
 
+
           example: Display a promotional banner
         enabled:
           type: boolean
@@ -4208,6 +4373,7 @@ components:
         
         For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
 
+
     parameters_hitsPerPage:
       type: integer
       minimum: 1
@@ -4226,6 +4392,7 @@ components:
         
         For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
 
+
     dictionaryType:
       type: string
       enum:
@@ -4252,6 +4419,7 @@ components:
       description: >-
         Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
 
+
     dictionaryEntry:
       type: object
       description: Dictionary entry.
@@ -4270,6 +4438,7 @@ components:
           description: >-
             Matching dictionary word for `stopwords` and `compounds` dictionaries.
 
+
           example: the
         words:
           type: array
@@ -4284,6 +4453,7 @@ components:
           description: >-
             Invividual components of a compound word in the `compounds` dictionary.
 
+
           example:
             - kopf
             - schmerz
@@ -4329,6 +4499,7 @@ components:
       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.
 
+
       additionalProperties: false
       properties:
         plurals:
@@ -4344,6 +4515,7 @@ components:
           description: >-
             Dictionary type. If `null`, this dictionary type isn't supported for the language.
 
+
           properties:
             nbCustomEntries:
               description: Number of custom dictionary entries.
@@ -4439,6 +4611,7 @@ components:
       description: >-
         Task status, `published` if the task is completed, `notPublished` otherwise.
 
+
     GetTaskResponse:
       title: getTaskResponse
       type: object
@@ -4474,6 +4647,7 @@ components:
           description: >-
             Index creation date. An empty string means that the index has no records.
 
+
           example: '2022-09-19T16:36:44.471Z'
         updatedAt:
           $ref: '#/components/schemas/updatedAt'
@@ -4500,16 +4674,19 @@ components:
           description: >-
             Number of pending indexing operations. This value is deprecated and should not be used.
 
+
         pendingTask:
           type: boolean
           description: >-
             A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
 
+
         primary:
           type: string
           description: >-
             Only present if the index is a replica. Contains the name of the related primary index.
 
+
           example: T02
         replicas:
           type: array
@@ -4518,6 +4695,7 @@ components:
           description: >-
             Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
 
+
           example:
             - T02_push
             - T2replica
@@ -4526,6 +4704,7 @@ components:
           description: >-
             Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
 
+
           x-categories:
             - Ranking
       required:
@@ -4576,12 +4755,14 @@ components:
             
             and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
 
+
         validUntil:
           type: integer
           format: int64
           description: >-
             Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
 
+
         restrictIndices:
           type: array
           items:
@@ -4601,6 +4782,7 @@ components:
             
             - `*_products_*` matches all indices containing "_products_".
 
+
         restrictSources:
           type: string
           description: >
@@ -4611,6 +4793,7 @@ components:
             
             Use this to protect against API key leaking and reuse.
 
+
           example: 192.168.1.0/24
         userToken:
           type: string
@@ -4622,6 +4805,7 @@ components:
             
             To avoid this, add a user token to each generated API key.
 
+
     replaceAllObjectsResponse:
       type: object
       additionalProperties: false
@@ -4630,6 +4814,7 @@ components:
           description: >-
             The response of the `operationIndex` request for the `copy` operation.
 
+
           $ref: '#/components/schemas/updatedAtResponse'
         batchResponses:
           type: array
@@ -4640,6 +4825,7 @@ components:
           description: >-
             The response of the `operationIndex` request for the `move` operation.
 
+
           $ref: '#/components/schemas/updatedAtResponse'
       required:
         - copyOperationResponse
@@ -4725,12 +4911,14 @@ components:
             
             When used for a source discover or source validate run, it will include the sampled data of the source.
 
+
           items:
             type: object
         events:
           description: >-
             in case of error, observability events will be added to the response.
 
+
           type: array
           items:
             $ref: '#/components/schemas/Event'
@@ -4738,6 +4926,7 @@ components:
           description: >-
             a message describing the outcome of the operation that has been ran (push, discover or validate) run.
 
+
           type: string
         createdAt:
           $ref: '#/components/schemas/CreatedAt'
@@ -4751,6 +4940,7 @@ components:
           description: >-
             The response of the `operationIndex` request for the `copy` operation.
 
+
           $ref: '#/components/schemas/updatedAtResponse'
         watchResponses:
           type: array
@@ -4761,6 +4951,7 @@ components:
           description: >-
             The response of the `operationIndex` request for the `move` operation.
 
+
           $ref: '#/components/schemas/updatedAtResponse'
       required:
         - copyOperationResponse
@@ -4783,6 +4974,7 @@ components:
           description: >-
             A string to append or remove for the `Add`, `Remove`, and `AddUnique` operations.
 
+
         - type: integer
           description: A number to add, remove, or append, depending on the operation.
     builtInOperation:
@@ -4851,6 +5043,7 @@ components:
       description: >-
         Whether to replace all synonyms in the index with the ones sent with this request.
 
+
     KeyString:
       in: path
       name: key
@@ -4966,6 +5159,7 @@ components:
             description: >-
               Response, taskID, unique object identifier, and an update timestamp.
 
+
             additionalProperties: false
             type: object
             properties: