Update the site-level search configuration

Partial update of the included content fields, synonyms, stop words, typo tolerance, or ranking rules. Any change triggers a fire-and-forget full reindex of the site, because the index shape or relevance contract has changed. The 60s in-memory config cache is invalidated so the next content event indexes against the new shape.

Required permissions
search.config.update
PUT/search/config
Base URLhttps://api.lynkow.com/v1

Request body
required

  • synonyms
    object

    Synonym groups for query expansion: each key maps to an array of equivalent terms (max 50 per group)

  • stopWords
    array<string>

    Max 500 characters. Array of strings

  • rankingRules
    array<enum>

    1-6 characters. Array of strings

  • typoTolerance
    object

    Typo-tolerance settings for fuzzy matching: enable flag, min word sizes for 1/2 typos, and attribute/word exclusions

    • enabled
      boolean
      required
    • disableOnWords
      array<string>
    • disableOnAttributes
      array<string>
    • minWordSizeForTypos
      object
      required
      • oneTypo
        number
        required
      • twoTypos
        number
        required
  • includedFields
    array<enum>

    Min 1 character. Array of strings

Feedback

Was this page helpful?