You are here

Home » API reference » Search API 8

search_api.index.schema.yml in Search API 8

config/schema/search_api.index.schema.yml

File

config/schema/search_api.index.schema.yml
View source 
  1. search_api.index.*:

  2.   type: config_entity

  3.   label : 'Search index'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'ID'

  8.     name:

  9.       type: label

  10.       label: 'Name'

  11.     description:

  12.       type: text

  13.       label: 'Description'

  14.     read_only:

  15.       type: boolean

  16.       label: 'Read-only'

  17.     field_settings:

  18.       type: sequence

  19.       label: 'Indexed fields'

  20.       orderby: key

  21.       sequence:

  22.         type: mapping

  23.         label: field

  24.         mapping:

  25.           label:

  26.             type: string

  27.             label: 'A label for the field'

  28.           datasource_id:

  29.             type: string

  30.             label: 'The datasource ID of the field'

  31.           property_path:

  32.             type: string

  33.             label: 'The property path of the field'

  34.           type:

  35.             type: string

  36.             label: 'The data type of the field'

  37.           boost:

  38.             type: float

  39.             label: 'The boost of the field'

  40.           configuration:

  41.             type: search_api.property_configuration.[%parent.property_path]

  42.           indexed_locked:

  43.             type: boolean

  44.             label: 'Whether the field is locked or can be removed'

  45.           type_locked:

  46.             type: boolean

  47.             label: 'Whether the field''s data type is locked or can be changed'

  48.           hidden:

  49.             type: boolean

  50.             label: 'Whether the field should appear in the UI'

  51.           dependencies:

  52.             type: config_dependencies

  53.             label: 'The field''s dependencies'

  54.     datasource_settings:

  55.       type: sequence

  56.       label: 'Datasource settings'

  57.       orderby: key

  58.       sequence:

  59.         type: plugin.plugin_configuration.search_api_datasource.[%key]

  60.         label: 'The configuration for a single datasource'

  61.     processor_settings:

  62.       type: sequence

  63.       label: 'Processor settings'

  64.       orderby: key

  65.       sequence:

  66.         type: plugin.plugin_configuration.search_api_processor.[%key]

  67.         label: 'The configuration for a single processor'

  68.     tracker_settings:

  69.       type: sequence

  70.       label: 'Tracker settings'

  71.       orderby: key

  72.       sequence:

  73.         type: plugin.plugin_configuration.search_api_tracker.[%key]

  74.         label: 'The configuration for the tracker'

  75.     options:

  76.       type: mapping

  77.       label: 'Options'

  78.       mapping:

  79.         cron_limit:

  80.           type: integer

  81.           label: 'Cron batch size'

  82.         index_directly:

  83.           type: boolean

  84.           label: 'Index items immediately'

  85.     server:

  86.       type: string

  87.       label: 'Server ID'

  88.     status:

  89.       type: boolean

  90.       label: 'Status'

  91.     langcode:

  92.       type: string

  93.       label: 'Language code'

  94.     dependencies:

  95.       type: config_dependencies

  96.       label: 'Dependencies'