Skip to content

Commit 48b629c

Browse files
committed
comment out unknown parameters
1 parent d309260 commit 48b629c

File tree

1 file changed

+73
-44
lines changed

1 file changed

+73
-44
lines changed

specs/recommend/common/schemas/IndexSettings.yml

Lines changed: 73 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,36 @@ indexSettingsAsSearchParams:
338338
- custom
339339
x-categories:
340340
- Ranking
341-
341+
# customRanking:
342+
# type: array
343+
# items:
344+
# type: string
345+
# example:
346+
# - desc(popularity)
347+
# - asc(price)
348+
# description: |
349+
# Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).
350+
# Attribute names are case-sensitive.
351+
352+
# The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.
353+
354+
# Records with missing values for your selected custom ranking attributes are always sorted last.
355+
# Boolean attributes are sorted based on their alphabetical order.
356+
357+
# **Modifiers**
358+
359+
# - `asc("ATTRIBUTE")`.
360+
# Sort the index by the values of an attribute, in ascending order.
361+
362+
# - `desc("ATTRIBUTE")`.
363+
# Sort the index by the values of an attribute, in descending order.
364+
365+
# If you use two or more custom ranking attributes,
366+
# [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,
367+
# or the other attributes will never be applied.
368+
# default: []
369+
# x-categories:
370+
# - Ranking
342371
relevancyStrictness:
343372
type: integer
344373
example: 90
@@ -463,18 +492,18 @@ indexSettingsAsSearchParams:
463492
$ref: '#/ignorePlurals'
464493
removeStopWords:
465494
$ref: '#/removeStopWords'
466-
keepDiacriticsOnCharacters:
467-
type: string
468-
example: øé
469-
description: |
470-
Characters for which diacritics should be preserved.
471-
472-
By default, Algolia removes diacritics from letters.
473-
For example, `é` becomes `e`. If this causes issues in your search,
474-
you can specify characters that should keep their diacritics.
475-
default: ''
476-
x-categories:
477-
- Languages
495+
# keepDiacriticsOnCharacters:
496+
# type: string
497+
# example: øé
498+
# description: |
499+
# Characters for which diacritics should be preserved.
500+
501+
# By default, Algolia removes diacritics from letters.
502+
# For example, `é` becomes `e`. If this causes issues in your search,
503+
# you can specify characters that should keep their diacritics.
504+
# default: ''
505+
# x-categories:
506+
# - Languages
478507
queryLanguages:
479508
type: array
480509
items:
@@ -524,10 +553,10 @@ indexSettingsAsSearchParams:
524553
$ref: '#/queryType'
525554
removeWordsIfNoResults:
526555
$ref: '#/removeWordsIfNoResults'
527-
mode:
528-
$ref: '#/mode'
529-
semanticSearch:
530-
$ref: '#/semanticSearch'
556+
# mode:
557+
# $ref: '#/mode'
558+
# semanticSearch:
559+
# $ref: '#/semanticSearch'
531560
advancedSyntax:
532561
type: boolean
533562
description: |
@@ -783,18 +812,18 @@ queryType:
783812
x-categories:
784813
- Query strategy
785814

786-
mode:
787-
type: string
788-
enum:
789-
- neuralSearch
790-
- keywordSearch
791-
description: |
792-
Search mode the index will use to query for results.
815+
# mode:
816+
# type: string
817+
# enum:
818+
# - neuralSearch
819+
# - keywordSearch
820+
# description: |
821+
# Search mode the index will use to query for results.
793822

794-
This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
795-
default: keywordSearch
796-
x-categories:
797-
- Query strategy
823+
# This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
824+
# default: keywordSearch
825+
# x-categories:
826+
# - Query strategy
798827

799828
removeWordsIfNoResults:
800829
type: string
@@ -1051,22 +1080,22 @@ sortRemainingBy:
10511080
type: string
10521081
enum: [count, alpha, hidden]
10531082

1054-
semanticSearch:
1055-
type: object
1056-
description: |
1057-
Settings for the semantic search part of NeuralSearch.
1058-
Only used when `mode` is `neuralSearch`.
1059-
properties:
1060-
eventSources:
1061-
oneOf:
1062-
- type: array
1063-
description: |
1064-
Indices from which to collect click and conversion events.
1065-
1066-
If null, the current index and all its replicas are used.
1067-
items:
1068-
type: string
1069-
- type: 'null'
1083+
# semanticSearch:
1084+
# type: object
1085+
# description: |
1086+
# Settings for the semantic search part of NeuralSearch.
1087+
# Only used when `mode` is `neuralSearch`.
1088+
# properties:
1089+
# eventSources:
1090+
# oneOf:
1091+
# - type: array
1092+
# description: |
1093+
# Indices from which to collect click and conversion events.
1094+
1095+
# If null, the current index and all its replicas are used.
1096+
# items:
1097+
# type: string
1098+
# - type: 'null'
10701099

10711100
supportedLanguage:
10721101
type: string

0 commit comments

Comments
 (0)