Skip to content

Commit bbe5f57

Browse files
algolia-botClaraMuller
algolia-bot
and
ClaraMuller
committed
fix(specs): apply the right category tags to composition query parameter (#5339) (generated) [skip ci]
Co-authored-by: Clara Muller <[email protected]>
1 parent b4fd73b commit bbe5f57

File tree

39 files changed

+147
-113
lines changed

39 files changed

+147
-113
lines changed

‎docs/bundled/composition-full.json‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,7 +1292,11 @@
12921292
},
12931293
"getRankingInfo": {
12941294
"type": "boolean",
1295-
"description": "Whether the run response should include detailed ranking information."
1295+
"description": "Whether the run response should include detailed ranking information.",
1296+
"default": false,
1297+
"x-categories": [
1298+
"Advanced"
1299+
]
12961300
},
12971301
"relevancyStrictness": {
12981302
"type": "integer",
@@ -1646,7 +1650,10 @@
16461650
"enableRules": {
16471651
"type": "boolean",
16481652
"description": "Whether to enable composition rules.",
1649-
"default": true
1653+
"default": true,
1654+
"x-categories": [
1655+
"Rules"
1656+
]
16501657
},
16511658
"ruleContexts": {
16521659
"type": "array",
@@ -1757,7 +1764,7 @@
17571764
"description": "A list of extenrally injected objectID groups into from an external source.\n",
17581765
"default": {},
17591766
"x-categories": [
1760-
"Advanced"
1767+
"Retail Media Network"
17611768
]
17621769
},
17631770
"params": {

‎docs/bundled/composition-full.yml‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ paths:
312312
--header 'content-type: application/json' \
313313
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
314314
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
315-
--data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
315+
--data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
316316
/1/compositions/{compositionID}/facets/{facetName}/query:
317317
post:
318318
tags:
@@ -411,7 +411,7 @@ paths:
411411
--header 'content-type: application/json' \
412412
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
413413
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
414-
--data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
414+
--data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
415415
/1/compositions:
416416
get:
417417
tags:
@@ -1535,6 +1535,9 @@ components:
15351535
getRankingInfo:
15361536
type: boolean
15371537
description: Whether the run response should include detailed ranking information.
1538+
default: false
1539+
x-categories:
1540+
- Advanced
15381541
relevancyStrictness:
15391542
type: integer
15401543
example: 90
@@ -1964,6 +1967,8 @@ components:
19641967
type: boolean
19651968
description: Whether to enable composition rules.
19661969
default: true
1970+
x-categories:
1971+
- Rules
19671972
ruleContexts:
19681973
type: array
19691974
items:
@@ -2079,7 +2084,7 @@ components:
20792084
source.
20802085
default: {}
20812086
x-categories:
2082-
- Advanced
2087+
- Retail Media Network
20832088
params:
20842089
title: Run composition parameters as object
20852090
type: object

‎docs/bundled/composition.json‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,11 @@
259259
},
260260
"getRankingInfo": {
261261
"type": "boolean",
262-
"description": "Whether the run response should include detailed ranking information."
262+
"description": "Whether the run response should include detailed ranking information.",
263+
"default": false,
264+
"x-categories": [
265+
"Advanced"
266+
]
263267
},
264268
"relevancyStrictness": {
265269
"type": "integer",
@@ -613,7 +617,10 @@
613617
"enableRules": {
614618
"type": "boolean",
615619
"description": "Whether to enable composition rules.",
616-
"default": true
620+
"default": true,
621+
"x-categories": [
622+
"Rules"
623+
]
617624
},
618625
"ruleContexts": {
619626
"type": "array",
@@ -724,7 +731,7 @@
724731
"description": "A list of extenrally injected objectID groups into from an external source.\n",
725732
"default": {},
726733
"x-categories": [
727-
"Advanced"
734+
"Retail Media Network"
728735
]
729736
},
730737
"params": {

‎docs/bundled/composition.yml‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ paths:
457457
--header 'content-type: application/json' \
458458
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
459459
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
460-
--data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
460+
--data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
461461
/1/compositions/{compositionID}/facets/{facetName}/query:
462462
post:
463463
tags:
@@ -803,7 +803,7 @@ paths:
803803
--header 'content-type: application/json' \
804804
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
805805
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
806-
--data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
806+
--data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
807807
components:
808808
securitySchemes:
809809
appId:
@@ -891,6 +891,9 @@ components:
891891
getRankingInfo:
892892
type: boolean
893893
description: Whether the run response should include detailed ranking information.
894+
default: false
895+
x-categories:
896+
- Advanced
894897
relevancyStrictness:
895898
type: integer
896899
example: 90
@@ -1320,6 +1323,8 @@ components:
13201323
type: boolean
13211324
description: Whether to enable composition rules.
13221325
default: true
1326+
x-categories:
1327+
- Rules
13231328
ruleContexts:
13241329
type: array
13251330
items:
@@ -1435,7 +1440,7 @@ components:
14351440
source.
14361441
default: {}
14371442
x-categories:
1438-
- Advanced
1443+
- Retail Media Network
14391444
params:
14401445
title: Run composition parameters as object
14411446
type: object

0 commit comments

Comments
 (0)