@algolia/n8n-nodes-algolia 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,7 +30,7 @@
30
30
  {
31
31
  "name": "crawlers",
32
32
  "x-displayName": "Manage",
33
- "description": "A crawler is an object with a name and a [configuration](#tag/config).\nUse these endpoints to create, rename, and delete crawlers.\n"
33
+ "description": "A crawler is an object with a name and a configuration.\nUse these endpoints to create, rename, and delete crawlers.\n"
34
34
  },
35
35
  {
36
36
  "name": "domains",
@@ -49,9 +49,7 @@
49
49
  "operationId": "listCrawlers",
50
50
  "summary": "List crawlers",
51
51
  "description": "Lists all your crawlers.",
52
- "tags": [
53
- "crawlers"
54
- ],
52
+ "tags": ["crawlers"],
55
53
  "parameters": [
56
54
  {
57
55
  "$ref": "#/components/parameters/ItemsPerPage"
@@ -95,9 +93,7 @@
95
93
  "operationId": "createCrawler",
96
94
  "summary": "Create a crawler",
97
95
  "description": "Creates a new crawler with the provided configuration.",
98
- "tags": [
99
- "crawlers"
100
- ],
96
+ "tags": ["crawlers"],
101
97
  "requestBody": {
102
98
  "content": {
103
99
  "application/json": {
@@ -112,10 +108,7 @@
112
108
  "$ref": "#/components/schemas/Configuration"
113
109
  }
114
110
  },
115
- "required": [
116
- "name",
117
- "config"
118
- ]
111
+ "required": ["name", "config"]
119
112
  }
120
113
  }
121
114
  }
@@ -133,9 +126,7 @@
133
126
  "$ref": "#/components/schemas/CrawlerID"
134
127
  }
135
128
  },
136
- "required": [
137
- "id"
138
- ]
129
+ "required": ["id"]
139
130
  }
140
131
  }
141
132
  }
@@ -157,9 +148,7 @@
157
148
  "operationId": "getCrawler",
158
149
  "summary": "Retrieve crawler details",
159
150
  "description": "Retrieves details about the specified crawler, optionally with its configuration.\n",
160
- "tags": [
161
- "crawlers"
162
- ],
151
+ "tags": ["crawlers"],
163
152
  "parameters": [
164
153
  {
165
154
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -197,11 +186,13 @@
197
186
  },
198
187
  "patch": {
199
188
  "operationId": "patchCrawler",
200
- "summary": "Change crawler name",
201
- "description": "Change the crawler's name.\n\nWhile you _could_ use this endpoint to replace the crawler configuration,\nyou should [update it](#tag/config/operation/patchConfig) instead since configuration changes made here aren't [versioned](#tag/config/operation/listConfigVersions).\n\nIf you replace the configuration, you must provide the full configuration,\nincluding any settings you want to keep.\n",
202
- "tags": [
203
- "crawlers"
204
- ],
189
+ "summary": "Replace crawler configuration",
190
+ "description": "Replaces the crawler configuration with a new one.\n\nIf you only want to change the crawler's name, you can use this operation.\nFor other configuration changes, use the \"Update configuration\" endpoint instead instead,\nbecause changes made here aren't versioned.\n\nWhen replacing the configuration, you must provide the full configuration,\nincluding any settings you want to keep.\n",
191
+ "externalDocs": {
192
+ "url": "https://www.algolia.com/doc/rest-api/crawler/patch-config",
193
+ "description": "Update configuration."
194
+ },
195
+ "tags": ["crawlers"],
205
196
  "parameters": [
206
197
  {
207
198
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -244,9 +235,7 @@
244
235
  "operationId": "deleteCrawler",
245
236
  "summary": "Delete a crawler",
246
237
  "description": "Delete the specified crawler.",
247
- "tags": [
248
- "crawlers"
249
- ],
238
+ "tags": ["crawlers"],
250
239
  "parameters": [
251
240
  {
252
241
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -273,9 +262,7 @@
273
262
  "operationId": "runCrawler",
274
263
  "summary": "Unpause a crawler",
275
264
  "description": "Unpauses the specified crawler.\nPreviously ongoing crawls will be resumed.\nOtherwise, the crawler waits for its next scheduled run.\n",
276
- "tags": [
277
- "actions"
278
- ],
265
+ "tags": ["actions"],
279
266
  "parameters": [
280
267
  {
281
268
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -302,9 +289,7 @@
302
289
  "operationId": "pauseCrawler",
303
290
  "summary": "Pause a crawler",
304
291
  "description": "Pauses the specified crawler.",
305
- "tags": [
306
- "actions"
307
- ],
292
+ "tags": ["actions"],
308
293
  "parameters": [
309
294
  {
310
295
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -331,9 +316,7 @@
331
316
  "operationId": "startReindex",
332
317
  "summary": "Start a crawl",
333
318
  "description": "Starts or resumes a crawl.",
334
- "tags": [
335
- "actions"
336
- ],
319
+ "tags": ["actions"],
337
320
  "parameters": [
338
321
  {
339
322
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -360,9 +343,7 @@
360
343
  "operationId": "testUrl",
361
344
  "summary": "Test crawl a URL",
362
345
  "description": "Tests a URL with the crawler's configuration and shows the extracted records.\n\nYou can test configuration changes by overriding specific parts before updating the full configuration.\n",
363
- "tags": [
364
- "actions"
365
- ],
346
+ "tags": ["actions"],
366
347
  "parameters": [
367
348
  {
368
349
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -384,9 +365,7 @@
384
365
  "$ref": "#/components/schemas/PartialConfig"
385
366
  }
386
367
  },
387
- "required": [
388
- "url"
389
- ]
368
+ "required": ["url"]
390
369
  }
391
370
  }
392
371
  }
@@ -528,13 +507,7 @@
528
507
  "example": {}
529
508
  }
530
509
  },
531
- "required": [
532
- "startDate",
533
- "endDate",
534
- "logs",
535
- "records",
536
- "links"
537
- ]
510
+ "required": ["startDate", "endDate", "logs", "records", "links"]
538
511
  }
539
512
  }
540
513
  }
@@ -556,9 +529,7 @@
556
529
  "operationId": "crawlUrls",
557
530
  "summary": "Crawl URLs",
558
531
  "description": "Crawls the specified URLs, extracts records from them, and adds them to the index.\nIf a crawl is currently running (the crawler's `reindexing` property is `true`),\nthe records are added to a temporary index.\n\nThis operation is rate-limited to 500 requests every 24 hours.\n",
559
- "tags": [
560
- "actions"
561
- ],
532
+ "tags": ["actions"],
562
533
  "parameters": [
563
534
  {
564
535
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -577,18 +548,14 @@
577
548
  "items": {
578
549
  "type": "string"
579
550
  },
580
- "example": [
581
- "https://www.algolia.com/products/crawler/"
582
- ]
551
+ "example": ["https://www.algolia.com/products/crawler/"]
583
552
  },
584
553
  "save": {
585
554
  "type": "boolean",
586
555
  "description": "Whether the specified URLs should be added to the `extraURLs` property of the crawler configuration.\nIf unspecified, the URLs are added to the `extraUrls` field only if they haven't been indexed during the last reindex.\n"
587
556
  }
588
557
  },
589
- "required": [
590
- "urls"
591
- ]
558
+ "required": ["urls"]
592
559
  }
593
560
  }
594
561
  }
@@ -614,9 +581,7 @@
614
581
  "operationId": "getStats",
615
582
  "summary": "Retrieve crawler stats",
616
583
  "description": "Retrieves information about the number of crawled, skipped, and failed URLs.",
617
- "tags": [
618
- "crawlers"
619
- ],
584
+ "tags": ["crawlers"],
620
585
  "parameters": [
621
586
  {
622
587
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -644,10 +609,7 @@
644
609
  }
645
610
  }
646
611
  },
647
- "required": [
648
- "count",
649
- "data"
650
- ]
612
+ "required": ["count", "data"]
651
613
  }
652
614
  }
653
615
  }
@@ -666,9 +628,7 @@
666
628
  "operationId": "patchConfig",
667
629
  "summary": "Update crawler configuration",
668
630
  "description": "Updates the configuration of the specified crawler.\nEvery time you update the configuration, a new version is created.\n",
669
- "tags": [
670
- "config"
671
- ],
631
+ "tags": ["config"],
672
632
  "parameters": [
673
633
  {
674
634
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -703,10 +663,8 @@
703
663
  "get": {
704
664
  "operationId": "listConfigVersions",
705
665
  "summary": "List configuration versions",
706
- "description": "Lists previous versions of the specified crawler's configuration, including who authored the change.\nEvery time you update a crawler's [configuration](#tag/config/operation/patchConfig),\na new version is added.\n",
707
- "tags": [
708
- "config"
709
- ],
666
+ "description": "Lists previous versions of the specified crawler's configuration, including who authored the change.\nEvery time you update a crawler's configuration, a new version is added.\n",
667
+ "tags": ["config"],
710
668
  "parameters": [
711
669
  {
712
670
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -740,9 +698,7 @@
740
698
  "operationId": "getConfigVersion",
741
699
  "summary": "Retrieve a configuration version",
742
700
  "description": "Retrieves the specified version of the crawler configuration.\n\nYou can use this to restore a previous version of the configuration.\n",
743
- "tags": [
744
- "config"
745
- ],
701
+ "tags": ["config"],
746
702
  "parameters": [
747
703
  {
748
704
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -773,12 +729,7 @@
773
729
  "$ref": "#/components/schemas/authorId"
774
730
  }
775
731
  },
776
- "required": [
777
- "version",
778
- "config",
779
- "createdAt",
780
- "authorId"
781
- ]
732
+ "required": ["version", "config", "createdAt", "authorId"]
782
733
  }
783
734
  }
784
735
  }
@@ -794,9 +745,7 @@
794
745
  "operationId": "getTaskStatus",
795
746
  "summary": "Retrieve task status",
796
747
  "description": "Retrieves the status of the specified tasks, whether they're pending or completed.",
797
- "tags": [
798
- "tasks"
799
- ],
748
+ "tags": ["tasks"],
800
749
  "parameters": [
801
750
  {
802
751
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -819,9 +768,7 @@
819
768
  "description": "Whether the task is pending."
820
769
  }
821
770
  },
822
- "required": [
823
- "pending"
824
- ]
771
+ "required": ["pending"]
825
772
  }
826
773
  }
827
774
  }
@@ -840,9 +787,7 @@
840
787
  "operationId": "cancelBlockingAction",
841
788
  "summary": "Cancel a blocking task",
842
789
  "description": "Cancels a blocking task.\n\nTasks that ran into an error will block your crawler's schedule.\nTo unblock the crawler, cancel the blocking task.\n",
843
- "tags": [
844
- "tasks"
845
- ],
790
+ "tags": ["tasks"],
846
791
  "parameters": [
847
792
  {
848
793
  "$ref": "#/components/parameters/CrawlerIdParameter"
@@ -872,9 +817,7 @@
872
817
  "operationId": "listDomains",
873
818
  "summary": "List registered domains",
874
819
  "description": "Lists registered domains.\n\nCrawlers will only run if the URLs match any of the registered domains.\n",
875
- "tags": [
876
- "domains"
877
- ],
820
+ "tags": ["domains"],
878
821
  "parameters": [
879
822
  {
880
823
  "$ref": "#/components/parameters/ItemsPerPage"
@@ -1013,18 +956,8 @@
1013
956
  },
1014
957
  "fileTypes": {
1015
958
  "type": "string",
1016
- "description": "For more information, see [Extract data from non-HTML documents](https://www.algolia.com/doc/tools/crawler/extracting-data/non-html-documents/).\n",
1017
- "enum": [
1018
- "doc",
1019
- "email",
1020
- "html",
1021
- "odp",
1022
- "ods",
1023
- "odt",
1024
- "pdf",
1025
- "ppt",
1026
- "xls"
1027
- ]
959
+ "description": "For more information, see [Extract data from non-HTML documents](https://www.algolia.com/doc/tools/crawler/extracting-data/non-html-documents).\n",
960
+ "enum": ["doc", "email", "html", "odp", "ods", "odt", "pdf", "ppt", "xls"]
1028
961
  },
1029
962
  "hostnameAliases": {
1030
963
  "type": "object",
@@ -1059,9 +992,7 @@
1059
992
  },
1060
993
  "configurationRecordExtractorType": {
1061
994
  "type": "string",
1062
- "enum": [
1063
- "function"
1064
- ]
995
+ "enum": ["function"]
1065
996
  },
1066
997
  "Action": {
1067
998
  "type": "object",
@@ -1089,13 +1020,8 @@
1089
1020
  "items": {
1090
1021
  "$ref": "#/components/schemas/fileTypes"
1091
1022
  },
1092
- "default": [
1093
- "html"
1094
- ],
1095
- "example": [
1096
- "html",
1097
- "pdf"
1098
- ]
1023
+ "default": ["html"],
1024
+ "example": ["html", "pdf"]
1099
1025
  },
1100
1026
  "hostnameAliases": {
1101
1027
  "$ref": "#/components/schemas/hostnameAliases"
@@ -1138,7 +1064,7 @@
1138
1064
  },
1139
1065
  "schedule": {
1140
1066
  "type": "string",
1141
- "description": "How often to perform a complete crawl for this action.\n\nFor mopre information, consult the [`schedule` parameter documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule/).\n"
1067
+ "description": "How often to perform a complete crawl for this action.\n\nFor mopre information, consult the [`schedule` parameter documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule).\n"
1142
1068
  },
1143
1069
  "selectorsToMatch": {
1144
1070
  "type": "array",
@@ -1148,16 +1074,10 @@
1148
1074
  "type": "string",
1149
1075
  "description": "Prefix a selector with `!` to ignore matching pages. \n"
1150
1076
  },
1151
- "example": [
1152
- ".products",
1153
- "!.featured"
1154
- ]
1077
+ "example": [".products", "!.featured"]
1155
1078
  }
1156
1079
  },
1157
- "required": [
1158
- "indexName",
1159
- "recordExtractor"
1160
- ]
1080
+ "required": ["indexName", "recordExtractor"]
1161
1081
  },
1162
1082
  "ignoreCanonicalTo": {
1163
1083
  "oneOf": [
@@ -1256,18 +1176,14 @@
1256
1176
  },
1257
1177
  "description": "An object with custom data.\n\nYou can store up to 32kB as custom data.\n",
1258
1178
  "default": {},
1259
- "x-categories": [
1260
- "Advanced"
1261
- ]
1179
+ "x-categories": ["Advanced"]
1262
1180
  },
1263
1181
  "maxFacetHits": {
1264
1182
  "type": "integer",
1265
1183
  "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).",
1266
1184
  "maximum": 100,
1267
1185
  "default": 10,
1268
- "x-categories": [
1269
- "Advanced"
1270
- ]
1186
+ "x-categories": ["Advanced"]
1271
1187
  },
1272
1188
  "baseIndexSettings": {
1273
1189
  "type": "object",
@@ -1285,26 +1201,19 @@
1285
1201
  "afterDistinct(category)",
1286
1202
  "afterDistinct(searchable(publisher))"
1287
1203
  ],
1288
- "description": "Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).\n\nFacets are attributes that let you categorize search results.\nThey can be used for filtering search results.\nBy default, no attribute is used for faceting.\nAttribute names are case-sensitive.\n\n**Modifiers**\n\n- `filterOnly(\"ATTRIBUTE\")`.\n Allows the attribute to be used as a filter but doesn't evaluate the facet values.\n\n- `searchable(\"ATTRIBUTE\")`.\n Allows searching for facet values.\n\n- `afterDistinct(\"ATTRIBUTE\")`.\n Evaluates the facet count _after_ deduplication with `distinct`.\n This ensures accurate facet counts.\n You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.\n",
1204
+ "description": "Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting).\n\nFacets are attributes that let you categorize search results.\nThey can be used for filtering search results.\nBy default, no attribute is used for faceting.\nAttribute names are case-sensitive.\n\n**Modifiers**\n\n- `filterOnly(\"ATTRIBUTE\")`.\n Allows the attribute to be used as a filter but doesn't evaluate the facet values.\n\n- `searchable(\"ATTRIBUTE\")`.\n Allows searching for facet values.\n\n- `afterDistinct(\"ATTRIBUTE\")`.\n Evaluates the facet count _after_ deduplication with `distinct`.\n This ensures accurate facet counts.\n You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.\n",
1289
1205
  "default": [],
1290
- "x-categories": [
1291
- "Faceting"
1292
- ]
1206
+ "x-categories": ["Faceting"]
1293
1207
  },
1294
1208
  "replicas": {
1295
1209
  "type": "array",
1296
1210
  "items": {
1297
1211
  "type": "string"
1298
1212
  },
1299
- "example": [
1300
- "virtual(prod_products_price_asc)",
1301
- "dev_products_replica"
1302
- ],
1303
- "description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).\n\nReplicas are copies of a primary index with the same records but different settings, synonyms, or rules.\nIf you want to offer a different ranking or sorting of your search results, you'll use replica indices.\nAll index operations on a primary index are automatically forwarded to its replicas.\nTo add a replica index, you must provide the complete set of replicas to this parameter.\nIf you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.\n\n**Modifier**\n\n- `virtual(\"REPLICA\")`.\n Create a virtual replica,\n 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/).\n",
1213
+ "example": ["virtual(prod_products_price_asc)", "dev_products_replica"],
1214
+ "description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas).\n\nReplicas are copies of a primary index with the same records but different settings, synonyms, or rules.\nIf you want to offer a different ranking or sorting of your search results, you'll use replica indices.\nAll index operations on a primary index are automatically forwarded to its replicas.\nTo add a replica index, you must provide the complete set of replicas to this parameter.\nIf you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.\n\n**Modifier**\n\n- `virtual(\"REPLICA\")`.\n Create a virtual replica,\n 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).\n",
1304
1215
  "default": [],
1305
- "x-categories": [
1306
- "Ranking"
1307
- ]
1216
+ "x-categories": ["Ranking"]
1308
1217
  },
1309
1218
  "paginationLimitedTo": {
1310
1219
  "type": "integer",
@@ -1318,29 +1227,20 @@
1318
1227
  "items": {
1319
1228
  "type": "string"
1320
1229
  },
1321
- "example": [
1322
- "total_sales"
1323
- ],
1324
- "description": "Attributes that can't be retrieved at query time.\n\nThis 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/),\nbut don't want to include it in the search results.\nAttribute names are case-sensitive.\n",
1230
+ "example": ["total_sales"],
1231
+ "description": "Attributes that can't be retrieved at query time.\n\nThis 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),\nbut don't want to include it in the search results.\nAttribute names are case-sensitive.\n",
1325
1232
  "default": [],
1326
- "x-categories": [
1327
- "Attributes"
1328
- ]
1233
+ "x-categories": ["Attributes"]
1329
1234
  },
1330
1235
  "disableTypoToleranceOnWords": {
1331
1236
  "type": "array",
1332
1237
  "items": {
1333
1238
  "type": "string"
1334
1239
  },
1335
- "example": [
1336
- "wheel",
1337
- "1X2BCD"
1338
- ],
1339
- "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).\nThis 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.\n",
1240
+ "example": ["wheel", "1X2BCD"],
1241
+ "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).\nThis 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.\n",
1340
1242
  "default": [],
1341
- "x-categories": [
1342
- "Typos"
1343
- ]
1243
+ "x-categories": ["Typos"]
1344
1244
  },
1345
1245
  "attributesToTransliterate": {
1346
1246
  "description": "Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).\n\nTransliteration supports searching in any of the Japanese writing systems.\nTo support transliteration, you must set the indexing language to Japanese.\nAttribute names are case-sensitive.\n",
@@ -1348,76 +1248,53 @@
1348
1248
  "items": {
1349
1249
  "type": "string"
1350
1250
  },
1351
- "example": [
1352
- "name",
1353
- "description"
1354
- ],
1355
- "x-categories": [
1356
- "Languages"
1357
- ]
1251
+ "example": ["name", "description"],
1252
+ "x-categories": ["Languages"]
1358
1253
  },
1359
1254
  "camelCaseAttributes": {
1360
1255
  "type": "array",
1361
1256
  "items": {
1362
1257
  "type": "string"
1363
1258
  },
1364
- "example": [
1365
- "description"
1366
- ],
1259
+ "example": ["description"],
1367
1260
  "description": "Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.\nAttribute names are case-sensitive.\n",
1368
1261
  "default": [],
1369
- "x-categories": [
1370
- "Languages"
1371
- ]
1262
+ "x-categories": ["Languages"]
1372
1263
  },
1373
1264
  "decompoundedAttributes": {
1374
1265
  "type": "object",
1375
1266
  "example": {
1376
- "de": [
1377
- "name"
1378
- ]
1267
+ "de": ["name"]
1379
1268
  },
1380
- "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).\nAttribute names are case-sensitive.\n\nCompound words are formed by combining two or more individual words,\nand are particularly prevalent in Germanic languages—for example, \"firefighter\".\nWith decompounding, the individual components are indexed separately.\n\nYou can specify different lists for different languages.\nDecompounding is supported for these languages:\nDutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",
1269
+ "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).\nAttribute names are case-sensitive.\n\nCompound words are formed by combining two or more individual words,\nand are particularly prevalent in Germanic languages—for example, \"firefighter\".\nWith decompounding, the individual components are indexed separately.\n\nYou can specify different lists for different languages.\nDecompounding is supported for these languages:\nDutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",
1381
1270
  "default": {},
1382
- "x-categories": [
1383
- "Languages"
1384
- ]
1271
+ "x-categories": ["Languages"]
1385
1272
  },
1386
1273
  "indexLanguages": {
1387
1274
  "type": "array",
1388
1275
  "items": {
1389
1276
  "$ref": "#/components/schemas/supportedLanguage"
1390
1277
  },
1391
- "example": [
1392
- "ja"
1393
- ],
1394
- "description": "Languages for language-specific processing steps, such as word detection and dictionary settings.\n\n**You should always specify an indexing language.**\nIf 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/),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor 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/).\n",
1278
+ "example": ["ja"],
1279
+ "description": "Languages for language-specific processing steps, such as word detection and dictionary settings.\n\n**You should always specify an indexing language.**\nIf 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),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor 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).\n",
1395
1280
  "default": [],
1396
- "x-categories": [
1397
- "Languages"
1398
- ]
1281
+ "x-categories": ["Languages"]
1399
1282
  },
1400
1283
  "disablePrefixOnAttributes": {
1401
1284
  "type": "array",
1402
1285
  "items": {
1403
1286
  "type": "string"
1404
1287
  },
1405
- "example": [
1406
- "sku"
1407
- ],
1288
+ "example": ["sku"],
1408
1289
  "description": "Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).\nAttribute names are case-sensitive.\n",
1409
1290
  "default": [],
1410
- "x-categories": [
1411
- "Query strategy"
1412
- ]
1291
+ "x-categories": ["Query strategy"]
1413
1292
  },
1414
1293
  "allowCompressionOfIntegerArray": {
1415
1294
  "type": "boolean",
1416
1295
  "description": "Whether arrays with exclusively non-negative integers should be compressed for better performance.\nIf true, the compressed arrays may be reordered.\n",
1417
1296
  "default": false,
1418
- "x-categories": [
1419
- "Performance"
1420
- ]
1297
+ "x-categories": ["Performance"]
1421
1298
  },
1422
1299
  "numericAttributesForFiltering": {
1423
1300
  "type": "array",
@@ -1425,46 +1302,32 @@
1425
1302
  "type": "string"
1426
1303
  },
1427
1304
  "description": "Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).\nAttribute names are case-sensitive.\n\nBy default, all numeric attributes are available as numerical filters.\nFor faster indexing, reduce the number of numeric attributes.\n\nTo turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.\n\n**Modifier**\n\n- `equalOnly(\"ATTRIBUTE\")`.\n Support only filtering based on equality comparisons `=` and `!=`.\n",
1428
- "example": [
1429
- "equalOnly(quantity)",
1430
- "popularity"
1431
- ],
1305
+ "example": ["equalOnly(quantity)", "popularity"],
1432
1306
  "default": [],
1433
- "x-categories": [
1434
- "Performance"
1435
- ]
1307
+ "x-categories": ["Performance"]
1436
1308
  },
1437
1309
  "separatorsToIndex": {
1438
1310
  "type": "string",
1439
1311
  "example": "+#",
1440
1312
  "description": "Control which non-alphanumeric characters are indexed.\n\nBy default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`).\nTo include such characters, define them with `separatorsToIndex`.\n\nSeparators are all non-letter characters except spaces and currency characters, such as $€£¥.\n\nWith `separatorsToIndex`, Algolia treats separator characters as separate words.\nFor example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.\n",
1441
1313
  "default": "",
1442
- "x-categories": [
1443
- "Typos"
1444
- ]
1314
+ "x-categories": ["Typos"]
1445
1315
  },
1446
1316
  "searchableAttributes": {
1447
1317
  "type": "array",
1448
1318
  "items": {
1449
1319
  "type": "string"
1450
1320
  },
1451
- "example": [
1452
- "title,alternative_title",
1453
- "author",
1454
- "unordered(text)",
1455
- "emails.personal"
1456
- ],
1457
- "description": "Attributes used for searching. Attribute names are case-sensitive.\n\nBy default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off.\nWith a non-empty list, Algolia only returns results with matches in the selected attributes.\nIn addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first.\nTo make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`.\nAttributes with the same priority are always unordered.\n\nFor more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).\n\n**Modifier**\n\n- `unordered(\"ATTRIBUTE\")`.\n Ignore the position of a match within the attribute.\n\nWithout a modifier, matches at the beginning of an attribute rank higher than matches at the end.\n",
1321
+ "example": ["title,alternative_title", "author", "unordered(text)", "emails.personal"],
1322
+ "description": "Attributes used for searching. Attribute names are case-sensitive.\n\nBy default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off.\nWith a non-empty list, Algolia only returns results with matches in the selected attributes.\nIn addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first.\nTo make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`.\nAttributes with the same priority are always unordered.\n\nFor more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes).\n\n**Modifier**\n\n- `unordered(\"ATTRIBUTE\")`.\n Ignore the position of a match within the attribute.\n\nWithout a modifier, matches at the beginning of an attribute rank higher than matches at the end.\n",
1458
1323
  "default": [],
1459
- "x-categories": [
1460
- "Attributes"
1461
- ]
1324
+ "x-categories": ["Attributes"]
1462
1325
  },
1463
1326
  "userData": {
1464
1327
  "$ref": "#/components/schemas/userData"
1465
1328
  },
1466
1329
  "customNormalization": {
1467
- "description": "Characters and their normalized replacements.\nThis overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).\n",
1330
+ "description": "Characters and their normalized replacements.\nThis overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization).\n",
1468
1331
  "type": "object",
1469
1332
  "example": {
1470
1333
  "default": {
@@ -1478,9 +1341,7 @@
1478
1341
  "type": "string"
1479
1342
  }
1480
1343
  },
1481
- "x-categories": [
1482
- "Languages"
1483
- ]
1344
+ "x-categories": ["Languages"]
1484
1345
  },
1485
1346
  "attributeForDistinct": {
1486
1347
  "description": "Attribute that should be used to establish groups of results.\nAttribute names are case-sensitive.\n\nAll records with the same value for this attribute are considered a group.\nYou can combine `attributeForDistinct` with the `distinct` search parameter to control\nhow many items per group are included in the search results.\n\nIf you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting.\nThis applies faceting _after_ deduplication, which will result in accurate facet counts.\n",
@@ -1495,24 +1356,17 @@
1495
1356
  "example": "øé",
1496
1357
  "description": "Characters for which diacritics should be preserved.\n\nBy default, Algolia removes diacritics from letters.\nFor example, `é` becomes `e`. If this causes issues in your search,\nyou can specify characters that should keep their diacritics.\n",
1497
1358
  "default": "",
1498
- "x-categories": [
1499
- "Languages"
1500
- ]
1359
+ "x-categories": ["Languages"]
1501
1360
  },
1502
1361
  "customRanking": {
1503
1362
  "type": "array",
1504
1363
  "items": {
1505
1364
  "type": "string"
1506
1365
  },
1507
- "example": [
1508
- "desc(popularity)",
1509
- "asc(price)"
1510
- ],
1511
- "description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).\nAttribute names are case-sensitive.\n\nThe custom ranking attributes decide which items are shown first if the other ranking criteria are equal.\n\nRecords with missing values for your selected custom ranking attributes are always sorted last.\nBoolean attributes are sorted based on their alphabetical order.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nIf you use two or more custom ranking attributes,\n[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,\nor the other attributes will never be applied.\n",
1366
+ "example": ["desc(popularity)", "asc(price)"],
1367
+ "description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking).\nAttribute names are case-sensitive.\n\nThe custom ranking attributes decide which items are shown first if the other ranking criteria are equal.\n\nRecords with missing values for your selected custom ranking attributes are always sorted last.\nBoolean attributes are sorted based on their alphabetical order.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nIf you use two or more custom ranking attributes,\n[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,\nor the other attributes will never be applied.\n",
1512
1368
  "default": [],
1513
- "x-categories": [
1514
- "Ranking"
1515
- ]
1369
+ "x-categories": ["Ranking"]
1516
1370
  }
1517
1371
  }
1518
1372
  },
@@ -1521,90 +1375,60 @@
1521
1375
  "items": {
1522
1376
  "type": "string"
1523
1377
  },
1524
- "example": [
1525
- "author",
1526
- "title",
1527
- "content"
1528
- ],
1378
+ "example": ["author", "title", "content"],
1529
1379
  "description": "Attributes to include in the API response\nTo reduce the size of your response, you can retrieve only some of the attributes.\nAttribute names are case-sensitive\n- `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings.\n- To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`.\n- The `objectID` attribute is always included.\n",
1530
- "default": [
1531
- "*"
1532
- ],
1533
- "x-categories": [
1534
- "Attributes"
1535
- ]
1380
+ "default": ["*"],
1381
+ "x-categories": ["Attributes"]
1536
1382
  },
1537
1383
  "relevancyStrictness": {
1538
1384
  "type": "integer",
1539
1385
  "example": 90,
1540
1386
  "description": "Relevancy threshold below which less relevant results aren't included in the results\nYou can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).\nUse this setting to strike a balance between the relevance and number of returned results.\n",
1541
1387
  "default": 100,
1542
- "x-categories": [
1543
- "Ranking"
1544
- ]
1388
+ "x-categories": ["Ranking"]
1545
1389
  },
1546
1390
  "attributesToHighlight": {
1547
1391
  "type": "array",
1548
1392
  "items": {
1549
1393
  "type": "string"
1550
1394
  },
1551
- "example": [
1552
- "author",
1553
- "title",
1554
- "conten",
1555
- "content"
1556
- ],
1557
- "description": "Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).\n",
1558
- "x-categories": [
1559
- "Highlighting and Snippeting"
1560
- ]
1395
+ "example": ["author", "title", "conten", "content"],
1396
+ "description": "Attributes to highlight\nBy default, all searchable attributes are highlighted.\nUse `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.\nAttribute names are case-sensitive\nWith highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.\nYou can use this to visually highlight matching parts of a search query in your UI\nFor more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).\n",
1397
+ "x-categories": ["Highlighting and Snippeting"]
1561
1398
  },
1562
1399
  "attributesToSnippet": {
1563
1400
  "type": "array",
1564
1401
  "items": {
1565
1402
  "type": "string"
1566
1403
  },
1567
- "example": [
1568
- "content:80",
1569
- "description"
1570
- ],
1404
+ "example": ["content:80", "description"],
1571
1405
  "description": "Attributes for which to enable snippets.\nAttribute names are case-sensitive\nSnippets provide additional context to matched words.\nIf you enable snippets, they include 10 words, including the matched word.\nThe matched word will also be wrapped by HTML tags for highlighting.\nYou can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`,\nwhere `NUMBER` is the number of words to be extracted.\n",
1572
1406
  "default": [],
1573
- "x-categories": [
1574
- "Highlighting and Snippeting"
1575
- ]
1407
+ "x-categories": ["Highlighting and Snippeting"]
1576
1408
  },
1577
1409
  "highlightPreTag": {
1578
1410
  "type": "string",
1579
1411
  "description": "HTML tag to insert before the highlighted parts in all highlighted results and snippets.",
1580
1412
  "default": "<em>",
1581
- "x-categories": [
1582
- "Highlighting and Snippeting"
1583
- ]
1413
+ "x-categories": ["Highlighting and Snippeting"]
1584
1414
  },
1585
1415
  "highlightPostTag": {
1586
1416
  "type": "string",
1587
1417
  "description": "HTML tag to insert after the highlighted parts in all highlighted results and snippets.",
1588
1418
  "default": "</em>",
1589
- "x-categories": [
1590
- "Highlighting and Snippeting"
1591
- ]
1419
+ "x-categories": ["Highlighting and Snippeting"]
1592
1420
  },
1593
1421
  "snippetEllipsisText": {
1594
1422
  "type": "string",
1595
1423
  "description": "String used as an ellipsis indicator when a snippet is truncated.",
1596
1424
  "default": "…",
1597
- "x-categories": [
1598
- "Highlighting and Snippeting"
1599
- ]
1425
+ "x-categories": ["Highlighting and Snippeting"]
1600
1426
  },
1601
1427
  "restrictHighlightAndSnippetArrays": {
1602
1428
  "type": "boolean",
1603
1429
  "description": "Whether to restrict highlighting and snippeting to items that at least partially matched the search query.\nBy default, all items are highlighted and snippeted.\n",
1604
1430
  "default": false,
1605
- "x-categories": [
1606
- "Highlighting and Snippeting"
1607
- ]
1431
+ "x-categories": ["Highlighting and Snippeting"]
1608
1432
  },
1609
1433
  "hitsPerPage": {
1610
1434
  "type": "integer",
@@ -1612,39 +1436,28 @@
1612
1436
  "default": 20,
1613
1437
  "minimum": 1,
1614
1438
  "maximum": 1000,
1615
- "x-categories": [
1616
- "Pagination"
1617
- ]
1439
+ "x-categories": ["Pagination"]
1618
1440
  },
1619
1441
  "minWordSizefor1Typo": {
1620
1442
  "type": "integer",
1621
1443
  "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).",
1622
1444
  "default": 4,
1623
- "x-categories": [
1624
- "Typos"
1625
- ]
1445
+ "x-categories": ["Typos"]
1626
1446
  },
1627
1447
  "minWordSizefor2Typos": {
1628
1448
  "type": "integer",
1629
1449
  "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).",
1630
1450
  "default": 8,
1631
- "x-categories": [
1632
- "Typos"
1633
- ]
1451
+ "x-categories": ["Typos"]
1634
1452
  },
1635
1453
  "typoToleranceEnum": {
1636
1454
  "type": "string",
1637
1455
  "title": "typo tolerance",
1638
1456
  "description": "- `min`. Return matches with the lowest number of typos.\n For example, if you have matches without typos, only include those.\n But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).\n- `strict`. Return matches with the two lowest numbers of typos.\n With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.\n",
1639
- "enum": [
1640
- "min",
1641
- "strict",
1642
- "true",
1643
- "false"
1644
- ]
1457
+ "enum": ["min", "strict", "true", "false"]
1645
1458
  },
1646
1459
  "typoTolerance": {
1647
- "description": "Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.\n\nIf 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.\n",
1460
+ "description": "Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied.\n\nIf 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.\n",
1648
1461
  "oneOf": [
1649
1462
  {
1650
1463
  "type": "boolean",
@@ -1655,45 +1468,31 @@
1655
1468
  "$ref": "#/components/schemas/typoToleranceEnum"
1656
1469
  }
1657
1470
  ],
1658
- "x-categories": [
1659
- "Typos"
1660
- ]
1471
+ "x-categories": ["Typos"]
1661
1472
  },
1662
1473
  "allowTyposOnNumericTokens": {
1663
1474
  "type": "boolean",
1664
1475
  "description": "Whether to allow typos on numbers in the search query\nTurn off this setting to reduce the number of irrelevant matches\nwhen searching in large sets of similar numbers.\n",
1665
1476
  "default": true,
1666
- "x-categories": [
1667
- "Typos"
1668
- ]
1477
+ "x-categories": ["Typos"]
1669
1478
  },
1670
1479
  "disableTypoToleranceOnAttributes": {
1671
1480
  "type": "array",
1672
1481
  "items": {
1673
1482
  "type": "string"
1674
1483
  },
1675
- "example": [
1676
- "sku"
1677
- ],
1678
- "description": "Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).\nAttribute names are case-sensitive\nReturning only exact matches can help when\n- [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/).\n- Reducing the number of matches when you have too many.\n This can happen with attributes that are long blocks of text, such as product descriptions\nConsider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.\n",
1484
+ "example": ["sku"],
1485
+ "description": "Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).\nAttribute names are case-sensitive\nReturning only exact matches can help when\n- [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).\n- Reducing the number of matches when you have too many.\n This can happen with attributes that are long blocks of text, such as product descriptions\nConsider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.\n",
1679
1486
  "default": [],
1680
- "x-categories": [
1681
- "Typos"
1682
- ]
1487
+ "x-categories": ["Typos"]
1683
1488
  },
1684
1489
  "booleanString": {
1685
1490
  "type": "string",
1686
- "enum": [
1687
- "true",
1688
- "false"
1689
- ]
1491
+ "enum": ["true", "false"]
1690
1492
  },
1691
1493
  "ignorePlurals": {
1692
1494
  "description": "Treat singular, plurals, and other forms of declensions as equivalent.\nYou should only use this feature for the languages used in your index.\n",
1693
- "example": [
1694
- "ca",
1695
- "es"
1696
- ],
1495
+ "example": ["ca", "es"],
1697
1496
  "oneOf": [
1698
1497
  {
1699
1498
  "type": "array",
@@ -1711,16 +1510,11 @@
1711
1510
  "default": false
1712
1511
  }
1713
1512
  ],
1714
- "x-categories": [
1715
- "Languages"
1716
- ]
1513
+ "x-categories": ["Languages"]
1717
1514
  },
1718
1515
  "removeStopWords": {
1719
1516
  "description": "Removes stop words from the search query.\n\nStop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own.\nIn English, \"the\", \"a\", or \"and\" are stop words.\n\nYou should only use this feature for the languages used in your index.\n",
1720
- "example": [
1721
- "ca",
1722
- "es"
1723
- ],
1517
+ "example": ["ca", "es"],
1724
1518
  "oneOf": [
1725
1519
  {
1726
1520
  "type": "array",
@@ -1735,87 +1529,57 @@
1735
1529
  "description": "If true, stop words are removed for all languages you included in `queryLanguages`, or for all supported languages, if `queryLanguages` is empty.\nIf false, stop words are not removed.\n"
1736
1530
  }
1737
1531
  ],
1738
- "x-categories": [
1739
- "Languages"
1740
- ]
1532
+ "x-categories": ["Languages"]
1741
1533
  },
1742
1534
  "queryLanguages": {
1743
1535
  "type": "array",
1744
1536
  "items": {
1745
1537
  "$ref": "#/components/schemas/supportedLanguage"
1746
1538
  },
1747
- "example": [
1748
- "es"
1749
- ],
1750
- "description": "Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries \nThis setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings.\nThis 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.\nTo support this, you must place the CJK language **first** \n**You should always specify a query language.**\nIf 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/),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor 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/).\n",
1539
+ "example": ["es"],
1540
+ "description": "Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries \nThis setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings.\nThis 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.\nTo support this, you must place the CJK language **first** \n**You should always specify a query language.**\nIf 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),\nor the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.\nThis can lead to unexpected search results.\nFor 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).\n",
1751
1541
  "default": [],
1752
- "x-categories": [
1753
- "Languages"
1754
- ]
1542
+ "x-categories": ["Languages"]
1755
1543
  },
1756
1544
  "decompoundQuery": {
1757
1545
  "type": "boolean",
1758
1546
  "description": "Whether to split compound words in the query into their building blocks\nFor more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words).\nWord segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.\nDecompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark).\nFor example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).\n",
1759
1547
  "default": true,
1760
- "x-categories": [
1761
- "Languages"
1762
- ]
1548
+ "x-categories": ["Languages"]
1763
1549
  },
1764
1550
  "enableRules": {
1765
1551
  "type": "boolean",
1766
1552
  "description": "Whether to enable rules.",
1767
1553
  "default": true,
1768
- "x-categories": [
1769
- "Rules"
1770
- ]
1554
+ "x-categories": ["Rules"]
1771
1555
  },
1772
1556
  "enablePersonalization": {
1773
1557
  "type": "boolean",
1774
1558
  "description": "Whether to enable Personalization.",
1775
1559
  "default": false,
1776
- "x-categories": [
1777
- "Personalization"
1778
- ]
1560
+ "x-categories": ["Personalization"]
1779
1561
  },
1780
1562
  "queryType": {
1781
1563
  "type": "string",
1782
- "enum": [
1783
- "prefixLast",
1784
- "prefixAll",
1785
- "prefixNone"
1786
- ],
1787
- "description": "Determines if and how query words are interpreted as prefixes.\n\nBy default, only the last query word is treated as a prefix (`prefixLast`).\nTo turn off prefix search, use `prefixNone`.\nAvoid `prefixAll`, which treats all query words as prefixes.\nThis might lead to counterintuitive results and makes your search slower.\n\nFor more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).\n",
1564
+ "enum": ["prefixLast", "prefixAll", "prefixNone"],
1565
+ "description": "Determines if and how query words are interpreted as prefixes.\n\nBy default, only the last query word is treated as a prefix (`prefixLast`).\nTo turn off prefix search, use `prefixNone`.\nAvoid `prefixAll`, which treats all query words as prefixes.\nThis might lead to counterintuitive results and makes your search slower.\n\nFor more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching).\n",
1788
1566
  "default": "prefixLast",
1789
- "x-categories": [
1790
- "Query strategy"
1791
- ]
1567
+ "x-categories": ["Query strategy"]
1792
1568
  },
1793
1569
  "removeWordsIfNoResults": {
1794
1570
  "type": "string",
1795
- "enum": [
1796
- "none",
1797
- "lastWords",
1798
- "firstWords",
1799
- "allOptional"
1800
- ],
1571
+ "enum": ["none", "lastWords", "firstWords", "allOptional"],
1801
1572
  "example": "firstWords",
1802
- "description": "Strategy for removing words from the query when it doesn't return any results.\nThis helps to avoid returning empty search results.\n\n- `none`.\n No words are removed when a query doesn't return results.\n\n- `lastWords`.\n Treat the last (then second to last, then third to last) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `firstWords`.\n Treat the first (then second, then third) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `allOptional`.\n Treat all words as optional.\n\nFor 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/).\n",
1573
+ "description": "Strategy for removing words from the query when it doesn't return any results.\nThis helps to avoid returning empty search results.\n\n- `none`.\n No words are removed when a query doesn't return results.\n\n- `lastWords`.\n Treat the last (then second to last, then third to last) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `firstWords`.\n Treat the first (then second, then third) word as optional,\n until there are results or at most 5 words have been removed.\n\n- `allOptional`.\n Treat all words as optional.\n\nFor 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).\n",
1803
1574
  "default": "none",
1804
- "x-categories": [
1805
- "Query strategy"
1806
- ]
1575
+ "x-categories": ["Query strategy"]
1807
1576
  },
1808
1577
  "mode": {
1809
1578
  "type": "string",
1810
- "enum": [
1811
- "neuralSearch",
1812
- "keywordSearch"
1813
- ],
1579
+ "enum": ["neuralSearch", "keywordSearch"],
1814
1580
  "description": "Search mode the index will use to query for results.\n\nThis setting only applies to indices, for which Algolia enabled NeuralSearch for you.\n",
1815
1581
  "default": "keywordSearch",
1816
- "x-categories": [
1817
- "Query strategy"
1818
- ]
1582
+ "x-categories": ["Query strategy"]
1819
1583
  },
1820
1584
  "semanticSearch": {
1821
1585
  "type": "object",
@@ -1841,24 +1605,17 @@
1841
1605
  "type": "boolean",
1842
1606
  "description": "Whether to support phrase matching and excluding words from search queries\nUse the `advancedSyntaxFeatures` parameter to control which feature is supported.\n",
1843
1607
  "default": false,
1844
- "x-categories": [
1845
- "Query strategy"
1846
- ]
1608
+ "x-categories": ["Query strategy"]
1847
1609
  },
1848
1610
  "optionalWordsArray": {
1849
1611
  "type": "array",
1850
1612
  "items": {
1851
1613
  "type": "string"
1852
1614
  },
1853
- "example": [
1854
- "blue",
1855
- "iphone case"
1856
- ],
1615
+ "example": ["blue", "iphone case"],
1857
1616
  "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).",
1858
1617
  "default": [],
1859
- "x-categories": [
1860
- "Query strategy"
1861
- ]
1618
+ "x-categories": ["Query strategy"]
1862
1619
  },
1863
1620
  "optionalWords": {
1864
1621
  "description": "Words that should be considered optional when found in the query.\n\nBy default, records must match all words in the search query to be included in the search results.\nAdding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.\nFor example, if the search query is \"action video\" and \"video\" is an optional word,\nthe search engine runs two queries. One for \"action video\" and one for \"action\".\nRecords that match all words are ranked higher.\n\nFor a search query with 4 or more words **and** all its words are optional,\nthe number of matched words required for a record to be included in the search results increases for every 1,000 records:\n\n- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:\n results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.\n- If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).\n For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.\n\nFor 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).\n",
@@ -1879,39 +1636,22 @@
1879
1636
  "items": {
1880
1637
  "type": "string"
1881
1638
  },
1882
- "example": [
1883
- "description"
1884
- ],
1639
+ "example": ["description"],
1885
1640
  "description": "Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).\nAttribute names are case-sensitive\nThis can be useful for attributes with long values, where the likelihood of an exact match is high,\nsuch as product descriptions.\nTurning off the Exact ranking criterion for these attributes favors exact matching on other attributes.\nThis reduces the impact of individual attributes with a lot of content on ranking.\n",
1886
1641
  "default": [],
1887
- "x-categories": [
1888
- "Query strategy"
1889
- ]
1642
+ "x-categories": ["Query strategy"]
1890
1643
  },
1891
1644
  "exactOnSingleWordQuery": {
1892
1645
  "type": "string",
1893
- "enum": [
1894
- "attribute",
1895
- "none",
1896
- "word"
1897
- ],
1646
+ "enum": ["attribute", "none", "word"],
1898
1647
  "description": "Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.\n\n- `attribute`.\n The Exact ranking criterion is 1 if the query word and attribute value are the same.\n For example, a search for \"road\" will match the value \"road\", but not \"road trip\".\n\n- `none`.\n The Exact ranking criterion is ignored on single-word searches.\n\n- `word`.\n The Exact ranking criterion is 1 if the query word is found in the attribute value.\n The query word must have at least 3 characters and must not be a stop word.\n Only exact matches will be highlighted,\n partial and prefix matches won't.\n",
1899
1648
  "default": "attribute",
1900
- "x-categories": [
1901
- "Query strategy"
1902
- ]
1649
+ "x-categories": ["Query strategy"]
1903
1650
  },
1904
1651
  "alternativesAsExact": {
1905
1652
  "type": "string",
1906
- "enum": [
1907
- "ignorePlurals",
1908
- "singleWordSynonym",
1909
- "multiWordsSynonym",
1910
- "ignoreConjugations"
1911
- ],
1912
- "x-categories": [
1913
- "Query strategy"
1914
- ]
1653
+ "enum": ["ignorePlurals", "singleWordSynonym", "multiWordsSynonym", "ignoreConjugations"],
1654
+ "x-categories": ["Query strategy"]
1915
1655
  },
1916
1656
  "IndexSettings_alternativesAsExact": {
1917
1657
  "type": "array",
@@ -1919,23 +1659,13 @@
1919
1659
  "$ref": "#/components/schemas/alternativesAsExact"
1920
1660
  },
1921
1661
  "description": "Determine which plurals and synonyms should be considered an exact matches\nBy default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching.\nFor example\n- \"swimsuit\" and \"swimsuits\" are treated the same\n- \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms))\n- `ignorePlurals`.\n Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches\n- `singleWordSynonym`.\n Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches\n- `multiWordsSynonym`.\n Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.\n",
1922
- "default": [
1923
- "ignorePlurals",
1924
- "singleWordSynonym"
1925
- ],
1926
- "x-categories": [
1927
- "Query strategy"
1928
- ]
1662
+ "default": ["ignorePlurals", "singleWordSynonym"],
1663
+ "x-categories": ["Query strategy"]
1929
1664
  },
1930
1665
  "advancedSyntaxFeatures": {
1931
1666
  "type": "string",
1932
- "enum": [
1933
- "exactPhrase",
1934
- "excludeWords"
1935
- ],
1936
- "x-categories": [
1937
- "Query strategy"
1938
- ]
1667
+ "enum": ["exactPhrase", "excludeWords"],
1668
+ "x-categories": ["Query strategy"]
1939
1669
  },
1940
1670
  "IndexSettings_advancedSyntaxFeatures": {
1941
1671
  "type": "array",
@@ -1943,13 +1673,8 @@
1943
1673
  "$ref": "#/components/schemas/advancedSyntaxFeatures"
1944
1674
  },
1945
1675
  "description": "Advanced search syntax features you want to support\n- `exactPhrase`.\n Phrases in quotes must match exactly.\n For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\"\n- `excludeWords`.\n Query words prefixed with a `-` must not occur in a record.\n For example, `search -engine` matches records that contain \"search\" but not \"engine\"\nThis setting only has an effect if `advancedSyntax` is true.\n",
1946
- "default": [
1947
- "exactPhrase",
1948
- "excludeWords"
1949
- ],
1950
- "x-categories": [
1951
- "Query strategy"
1952
- ]
1676
+ "default": ["exactPhrase", "excludeWords"],
1677
+ "x-categories": ["Query strategy"]
1953
1678
  },
1954
1679
  "distinct": {
1955
1680
  "description": "Determines how many records of a group are included in the search results.\n\nRecords with the same value for the `attributeForDistinct` attribute are considered a group.\nThe `distinct` setting controls how many members of the group are returned.\nThis is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).\n\nThe `distinct` setting is ignored if `attributeForDistinct` is not set.\n",
@@ -1961,23 +1686,19 @@
1961
1686
  },
1962
1687
  {
1963
1688
  "type": "integer",
1964
- "description": "Number of members of a group of records to include in the search results.\n\n- 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/).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",
1689
+ "description": "Number of members of a group of records to include in the search results.\n\n- 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).\n The number of hits won't be correct and faceting won't work as expected.\n- With `distinct > 1`, the `hitsPerPage` parameter controls the number of returned groups.\n For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.\n Likewise, the `nbHits` response attribute contains the number of returned groups.\n",
1965
1690
  "minimum": 0,
1966
1691
  "maximum": 4,
1967
1692
  "default": 0
1968
1693
  }
1969
1694
  ],
1970
- "x-categories": [
1971
- "Advanced"
1972
- ]
1695
+ "x-categories": ["Advanced"]
1973
1696
  },
1974
1697
  "replaceSynonymsInHighlight": {
1975
1698
  "type": "boolean",
1976
1699
  "description": "Whether to replace a highlighted word with the matched synonym\nBy default, the original words are highlighted even if a synonym matches.\nFor example, with `home` as a synonym for `house` and a search for `home`,\nrecords matching either \"home\" or \"house\" are included in the search results,\nand either \"home\" or \"house\" are highlighted\nWith `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,\nbut all occurrences of \"house\" are replaced by \"home\" in the highlighted response.\n",
1977
1700
  "default": false,
1978
- "x-categories": [
1979
- "Highlighting and Snippeting"
1980
- ]
1701
+ "x-categories": ["Highlighting and Snippeting"]
1981
1702
  },
1982
1703
  "minProximity": {
1983
1704
  "type": "integer",
@@ -1985,9 +1706,7 @@
1985
1706
  "maximum": 7,
1986
1707
  "description": "Minimum proximity score for two matching words\nThis adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)\nby equally scoring matches that are farther apart\nFor example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.\n",
1987
1708
  "default": 1,
1988
- "x-categories": [
1989
- "Advanced"
1990
- ]
1709
+ "x-categories": ["Advanced"]
1991
1710
  },
1992
1711
  "responseFields": {
1993
1712
  "type": "array",
@@ -1995,37 +1714,27 @@
1995
1714
  "type": "string"
1996
1715
  },
1997
1716
  "description": "Properties to include in the API response of search and browse requests\nBy default, all response properties are included.\nTo reduce the response size, you can select which properties should be included\nAn empty list may lead to an empty API response (except properties you can't exclude)\nYou can't exclude these properties:\n`message`, `warning`, `cursor`, `abTestVariantID`,\nor any property added by setting `getRankingInfo` to true\nYour search depends on the `hits` field. If you omit this field, searches won't return any results.\nYour UI might also depend on other properties, for example, for pagination.\nBefore restricting the response size, check the impact on your search experience.\n",
1998
- "default": [
1999
- "*"
2000
- ],
2001
- "x-categories": [
2002
- "Advanced"
2003
- ]
1717
+ "default": ["*"],
1718
+ "x-categories": ["Advanced"]
2004
1719
  },
2005
1720
  "maxValuesPerFacet": {
2006
1721
  "type": "integer",
2007
1722
  "description": "Maximum number of facet values to return for each facet.",
2008
1723
  "default": 100,
2009
1724
  "maximum": 1000,
2010
- "x-categories": [
2011
- "Faceting"
2012
- ]
1725
+ "x-categories": ["Faceting"]
2013
1726
  },
2014
1727
  "sortFacetValuesBy": {
2015
1728
  "type": "string",
2016
- "description": "Order in which to retrieve facet values\n- `count`.\n Facet values are retrieved by decreasing count.\n The count is the number of matching records containing this facet value\n- `alpha`.\n Retrieve facet values alphabetically\nThis setting doesn't influence how facet values are displayed in your UI (see `renderingContent`).\nFor more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).\n",
1729
+ "description": "Order in which to retrieve facet values\n- `count`.\n Facet values are retrieved by decreasing count.\n The count is the number of matching records containing this facet value\n- `alpha`.\n Retrieve facet values alphabetically\nThis setting doesn't influence how facet values are displayed in your UI (see `renderingContent`).\nFor more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).\n",
2017
1730
  "default": "count",
2018
- "x-categories": [
2019
- "Faceting"
2020
- ]
1731
+ "x-categories": ["Faceting"]
2021
1732
  },
2022
1733
  "attributeCriteriaComputedByMinProximity": {
2023
1734
  "type": "boolean",
2024
1735
  "description": "Whether the best matching attribute should be determined by minimum proximity\nThis setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.\nIf true, the best matching attribute is selected based on the minimum proximity of multiple matches.\nOtherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.\n",
2025
1736
  "default": false,
2026
- "x-categories": [
2027
- "Advanced"
2028
- ]
1737
+ "x-categories": ["Advanced"]
2029
1738
  },
2030
1739
  "order": {
2031
1740
  "description": "Explicit order of facets or facet values.\n\nThis setting lets you always show specific facets or facet values at the top of the list.\n",
@@ -2047,11 +1756,7 @@
2047
1756
  "sortRemainingBy": {
2048
1757
  "description": "Order of facet values that aren't explicitly positioned with the `order` setting.\n\n- `count`.\n Order remaining facet values by decreasing count.\n The count is the number of matching records containing this facet value.\n\n- `alpha`.\n Sort facet values alphabetically.\n\n- `hidden`.\n Don't show facet values that aren't explicitly positioned.\n",
2049
1758
  "type": "string",
2050
- "enum": [
2051
- "count",
2052
- "alpha",
2053
- "hidden"
2054
- ]
1759
+ "enum": ["count", "alpha", "hidden"]
2055
1760
  },
2056
1761
  "hide": {
2057
1762
  "description": "Hide facet values.",
@@ -2187,20 +1892,16 @@
2187
1892
  "$ref": "#/components/schemas/widgets"
2188
1893
  }
2189
1894
  },
2190
- "x-categories": [
2191
- "Advanced"
2192
- ]
1895
+ "x-categories": ["Advanced"]
2193
1896
  },
2194
1897
  "enableReRanking": {
2195
1898
  "type": "boolean",
2196
- "description": "Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)\nThis setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.\n",
1899
+ "description": "Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking)\nThis setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.\n",
2197
1900
  "default": true,
2198
- "x-categories": [
2199
- "Filtering"
2200
- ]
1901
+ "x-categories": ["Filtering"]
2201
1902
  },
2202
1903
  "reRankingApplyFilter": {
2203
- "description": "Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.\n",
1904
+ "description": "Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) to records that match these filters.\n",
2204
1905
  "oneOf": [
2205
1906
  {
2206
1907
  "type": "array",
@@ -2210,9 +1911,7 @@
2210
1911
  },
2211
1912
  {
2212
1913
  "type": "string",
2213
- "x-categories": [
2214
- "Filtering"
2215
- ]
1914
+ "x-categories": ["Filtering"]
2216
1915
  }
2217
1916
  ]
2218
1917
  },
@@ -2228,7 +1927,7 @@
2228
1927
  "items": {
2229
1928
  "type": "string"
2230
1929
  },
2231
- "description": "Determines the order in which Algolia returns your results.\n\nBy default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).\nThe tie-breaking algorithm sequentially applies each criterion in the order they're specified.\nIf 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/),\nyou put the sorting attribute at the top of the list.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nBefore you modify the default setting,\nyou should test your changes in the dashboard,\nand by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).\n",
1930
+ "description": "Determines the order in which Algolia returns your results.\n\nBy default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria).\nThe tie-breaking algorithm sequentially applies each criterion in the order they're specified.\nIf 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),\nyou put the sorting attribute at the top of the list.\n\n**Modifiers**\n\n- `asc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in ascending order.\n- `desc(\"ATTRIBUTE\")`.\n Sort the index by the values of an attribute, in descending order.\n\nBefore you modify the default setting,\nyou should test your changes in the dashboard,\nand by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).\n",
2232
1931
  "default": [
2233
1932
  "typo",
2234
1933
  "geo",
@@ -2239,9 +1938,7 @@
2239
1938
  "exact",
2240
1939
  "custom"
2241
1940
  ],
2242
- "x-categories": [
2243
- "Ranking"
2244
- ]
1941
+ "x-categories": ["Ranking"]
2245
1942
  },
2246
1943
  "relevancyStrictness": {
2247
1944
  "$ref": "#/components/schemas/relevancyStrictness"
@@ -2439,9 +2136,7 @@
2439
2136
  "$ref": "#/components/schemas/loginRequestOptions"
2440
2137
  }
2441
2138
  },
2442
- "required": [
2443
- "url"
2444
- ],
2139
+ "required": ["url"],
2445
2140
  "example": {
2446
2141
  "url": "https://example.com/secure/login-with-post",
2447
2142
  "requestOptions": {
@@ -2496,11 +2191,7 @@
2496
2191
  "$ref": "#/components/schemas/waitTime"
2497
2192
  }
2498
2193
  },
2499
- "required": [
2500
- "url",
2501
- "username",
2502
- "password"
2503
- ],
2194
+ "required": ["url", "username", "password"],
2504
2195
  "example": {
2505
2196
  "url": "https://example.com/secure/login-page",
2506
2197
  "username": "my-id",
@@ -2510,9 +2201,7 @@
2510
2201
  "grantType": {
2511
2202
  "type": "string",
2512
2203
  "description": "OAuth 2.0 grant type.",
2513
- "enum": [
2514
- "client_credentials"
2515
- ]
2204
+ "enum": ["client_credentials"]
2516
2205
  },
2517
2206
  "extraParameters": {
2518
2207
  "type": "object",
@@ -2551,12 +2240,7 @@
2551
2240
  "$ref": "#/components/schemas/extraParameters"
2552
2241
  }
2553
2242
  },
2554
- "required": [
2555
- "url",
2556
- "grantType",
2557
- "clientId",
2558
- "clientSecret"
2559
- ]
2243
+ "required": ["url", "grantType", "clientId", "clientSecret"]
2560
2244
  },
2561
2245
  "oauthRequest": {
2562
2246
  "title": "OAuth 2.0",
@@ -2567,9 +2251,7 @@
2567
2251
  "$ref": "#/components/schemas/accessTokenRequest"
2568
2252
  }
2569
2253
  },
2570
- "required": [
2571
- "accessTokenRequest"
2572
- ],
2254
+ "required": ["accessTokenRequest"],
2573
2255
  "example": {
2574
2256
  "accessTokenRequest": {
2575
2257
  "url": "https://example.com/oauth2/token",
@@ -2609,9 +2291,7 @@
2609
2291
  "items": {
2610
2292
  "type": "string",
2611
2293
  "description": "URL or URL pattern to render.",
2612
- "example": [
2613
- "http://www.mysite.com/dynamic-pages/**"
2614
- ]
2294
+ "example": ["http://www.mysite.com/dynamic-pages/**"]
2615
2295
  }
2616
2296
  },
2617
2297
  {
@@ -2630,9 +2310,7 @@
2630
2310
  "items": {
2631
2311
  "type": "string"
2632
2312
  },
2633
- "example": [
2634
- "http://www.mysite.com/dynamic-pages/**"
2635
- ]
2313
+ "example": ["http://www.mysite.com/dynamic-pages/**"]
2636
2314
  },
2637
2315
  "adBlock": {
2638
2316
  "type": "boolean",
@@ -2643,10 +2321,7 @@
2643
2321
  "$ref": "#/components/schemas/waitTime"
2644
2322
  }
2645
2323
  },
2646
- "required": [
2647
- "enabled",
2648
- "patterns"
2649
- ]
2324
+ "required": ["enabled", "patterns"]
2650
2325
  }
2651
2326
  ]
2652
2327
  },
@@ -2701,17 +2376,13 @@
2701
2376
  },
2702
2377
  "schedule": {
2703
2378
  "type": "string",
2704
- "description": "Schedule for running the crawl.\n\nInstead of manually starting a crawl each time, you can set up a schedule for automatic crawls.\n[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/).\n\n`schedule` uses [Later.js syntax](https://bunkat.github.io/later/) to specify when to crawl your site.\nHere are some key things to keep in mind when using `Later.js` syntax with the Crawler:\n\n- The interval between two scheduled crawls must be at least 24 hours.\n- To crawl daily, use \"every 1 day\" instead of \"everyday\" or \"every day\".\n- If you don't specify a time, the crawl can happen any time during the scheduled day.\n- Specify times for the UTC (GMT+0) timezone\n- Include minutes when specifying a time. For example, \"at 3:00 pm\" instead of \"at 3pm\".\n- Use \"at 12:00 am\" to specify midnight, not \"at 00:00 am\".\n",
2379
+ "description": "Schedule for running the crawl.\n\nInstead of manually starting a crawl each time, you can set up a schedule for automatic crawls.\n[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).\n\n`schedule` uses [Later.js syntax](https://bunkat.github.io/later) to specify when to crawl your site.\nHere are some key things to keep in mind when using `Later.js` syntax with the Crawler:\n\n- The interval between two scheduled crawls must be at least 24 hours.\n- To crawl daily, use \"every 1 day\" instead of \"everyday\" or \"every day\".\n- If you don't specify a time, the crawl can happen any time during the scheduled day.\n- Specify times for the UTC (GMT+0) timezone\n- Include minutes when specifying a time. For example, \"at 3:00 pm\" instead of \"at 3pm\".\n- Use \"at 12:00 am\" to specify midnight, not \"at 00:00 am\".\n",
2705
2380
  "example": "every weekday at 12:00 pm"
2706
2381
  },
2707
2382
  "Configuration": {
2708
2383
  "type": "object",
2709
2384
  "description": "Crawler configuration.",
2710
- "required": [
2711
- "applicationId",
2712
- "rateLimit",
2713
- "actions"
2714
- ],
2385
+ "required": ["applicationId", "rateLimit", "actions"],
2715
2386
  "properties": {
2716
2387
  "actions": {
2717
2388
  "type": "array",
@@ -2749,7 +2420,7 @@
2749
2420
  "maxItems": 10,
2750
2421
  "items": {
2751
2422
  "type": "string",
2752
- "description": "For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data/).",
2423
+ "description": "For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data).",
2753
2424
  "example": "testCSV"
2754
2425
  }
2755
2426
  },
@@ -2781,10 +2452,7 @@
2781
2452
  "type": "array",
2782
2453
  "description": "Query parameters to ignore while crawling.\n\nAll URLs with the matching query parameters are treated as identical.\nThis prevents indexing URLs that just differ by their query parameters.\n",
2783
2454
  "maxItems": 9999,
2784
- "example": [
2785
- "ref",
2786
- "utm_*"
2787
- ],
2455
+ "example": ["ref", "utm_*"],
2788
2456
  "items": {
2789
2457
  "type": "string",
2790
2458
  "description": "Use wildcards to match multiple query parameters."
@@ -2802,7 +2470,7 @@
2802
2470
  },
2803
2471
  "initialIndexSettings": {
2804
2472
  "type": "object",
2805
- "description": "Crawler index settings.\n\nThese index settings are only applied during the first crawl of an index.\n\nAny subsequent changes won't be applied to the index.\nInstead, make changes to your index settings in the [Algolia dashboard](https://dashboard.algolia.com/explorer/configuration/).\n",
2473
+ "description": "Crawler index settings.\n\nThese index settings are only applied during the first crawl of an index.\n\nAny subsequent changes won't be applied to the index.\nInstead, make changes to your index settings in the [Algolia dashboard](https://dashboard.algolia.com/explorer/configuration).\n",
2806
2474
  "additionalProperties": {
2807
2475
  "$ref": "#/components/schemas/indexSettings",
2808
2476
  "x-additionalPropertiesName": "indexName"
@@ -2811,7 +2479,7 @@
2811
2479
  "linkExtractor": {
2812
2480
  "title": "linkExtractor",
2813
2481
  "type": "object",
2814
- "description": "Function for extracting URLs from links on crawled pages.\n\nFor more information, see the [`linkExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/link-extractor/).\n",
2482
+ "description": "Function for extracting URLs from links on crawled pages.\n\nFor more information, see the [`linkExtractor` documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/link-extractor).\n",
2815
2483
  "properties": {
2816
2484
  "__type": {
2817
2485
  "$ref": "#/components/schemas/configurationRecordExtractorType"
@@ -2915,7 +2583,7 @@
2915
2583
  },
2916
2584
  "blocked": {
2917
2585
  "type": "boolean",
2918
- "description": "Whether this crawler is currently blocked.\n\nIf `true`, you can unblock it from the [Crawler page](https://dashboard.algolia.com/crawler) in the Algolia dashboard\nor by [cancelling the blocking task](#tag/tasks/operation/cancelBlockingAction).\n"
2586
+ "description": "Whether this crawler is currently blocked.\n\nIf `true`, you can unblock it from the [Crawler page](https://dashboard.algolia.com/crawler) in the Algolia dashboard\nor by [cancelling the blocking task](https://www.algolia.com/doc/rest-api/crawler/cancel-blocking-action).\n"
2919
2587
  },
2920
2588
  "blockingError": {
2921
2589
  "type": "string",
@@ -3016,22 +2684,13 @@
3016
2684
  },
3017
2685
  "urlsCrawledGroupStatus": {
3018
2686
  "type": "string",
3019
- "description": "Crawled URL status.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/).\n",
3020
- "enum": [
3021
- "DONE",
3022
- "SKIPPED",
3023
- "FAILED"
3024
- ]
2687
+ "description": "Crawled URL status.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status).\n",
2688
+ "enum": ["DONE", "SKIPPED", "FAILED"]
3025
2689
  },
3026
2690
  "urlsCrawledGroupCategory": {
3027
2691
  "type": "string",
3028
- "description": "Step where the status information was generated.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status/).\n",
3029
- "enum": [
3030
- "fetch",
3031
- "extraction",
3032
- "indexing",
3033
- "success"
3034
- ]
2692
+ "description": "Step where the status information was generated.\n\nFor more information, see [Troubleshooting by crawl status](https://www.algolia.com/doc/tools/crawler/troubleshooting/crawl-status).\n",
2693
+ "enum": ["fetch", "extraction", "indexing", "success"]
3035
2694
  },
3036
2695
  "UrlsCrawledGroup": {
3037
2696
  "type": "object",
@@ -3099,11 +2758,7 @@
3099
2758
  "$ref": "#/components/schemas/authorId"
3100
2759
  }
3101
2760
  },
3102
- "required": [
3103
- "version",
3104
- "createdAt",
3105
- "authorId"
3106
- ]
2761
+ "required": ["version", "createdAt", "authorId"]
3107
2762
  }
3108
2763
  }
3109
2764
  }
@@ -3243,9 +2898,7 @@
3243
2898
  "type": "integer"
3244
2899
  }
3245
2900
  },
3246
- "required": [
3247
- "message"
3248
- ],
2901
+ "required": ["message"],
3249
2902
  "example": {
3250
2903
  "message": "url is not defined",
3251
2904
  "line": 5
@@ -3258,9 +2911,7 @@
3258
2911
  }
3259
2912
  }
3260
2913
  },
3261
- "required": [
3262
- "error"
3263
- ]
2914
+ "required": ["error"]
3264
2915
  }
3265
2916
  }
3266
2917
  }
@@ -3283,9 +2934,7 @@
3283
2934
  "$ref": "#/components/schemas/TaskID"
3284
2935
  }
3285
2936
  },
3286
- "required": [
3287
- "taskId"
3288
- ]
2937
+ "required": ["taskId"]
3289
2938
  }
3290
2939
  }
3291
2940
  }
@@ -3327,9 +2976,7 @@
3327
2976
  "type": "integer"
3328
2977
  }
3329
2978
  },
3330
- "required": [
3331
- "message"
3332
- ],
2979
+ "required": ["message"],
3333
2980
  "example": {
3334
2981
  "message": "url is not defined",
3335
2982
  "line": 5
@@ -3342,13 +2989,11 @@
3342
2989
  }
3343
2990
  }
3344
2991
  },
3345
- "required": [
3346
- "error"
3347
- ]
2992
+ "required": ["error"]
3348
2993
  }
3349
2994
  }
3350
2995
  }
3351
2996
  }
3352
2997
  }
3353
2998
  }
3354
- }
2999
+ }