You are here

Home » API reference » Elasticsearch Connector 8.2

elasticsearch_connector.backend.schema.yml in Elasticsearch Connector 8.2

Same filename and directory in other branches
  1. 8.7 config/schema/elasticsearch_connector.backend.schema.yml
  2. 8 config/schema/elasticsearch_connector.backend.schema.yml
  3. 8.5 config/schema/elasticsearch_connector.backend.schema.yml
  4. 8.6 config/schema/elasticsearch_connector.backend.schema.yml
config/schema/elasticsearch_connector.backend.schema.yml

File

config/schema/elasticsearch_connector.backend.schema.yml
View source 
  1. elasticsearch_connector.backend.plugin.elasticsearch:

  2.   type: mapping

  3.   label: 'Search API Elasticsearch settings'

  4.   mapping:

  5.     cluster_settings:

  6.       type: mapping

  7.       label: 'Elasticsearch settings'

  8.       mapping:

  9.         cluster:

  10.           type: string

  11.           label: 'The cluster that handles the connection'

  12.     scheme:

  13.       type: string

  14.       label: 'The HTTP protocol to use for sending queries'

  15.     host:

  16.       type: string

  17.       label: 'The host name or IP of the Elasticsearch server'

  18.     port:

  19.       type: string

  20.       label: 'The port of the Elasticsearch server'

  21.     path:

  22.       type: string

  23.       label: 'The path that identifies the Elasticsearch instance to use on the server'

  24.     http_user:

  25.       type: string

  26.       label: 'Username for basic HTTP authentication'

  27.     http_pass:

  28.       type: string

  29.       label: 'Password for basic HTTP authentication'

  30.     excerpt:

  31.       type: boolean

  32.       label: 'Return an excerpt for all results'

  33.     retrieve_data:

  34.       type: boolean

  35.       label: 'Retrieve result data from Elasticsearch'

  36.     highlight_data:

  37.       type: boolean

  38.       label: 'Highlight retrieved data'

  39.     http_method:

  40.       type: string

  41.       label: 'The HTTP method to use for sending queries'

  42.     autocorrect_spell:

  43.       type: boolean

  44.       label: 'Use spellcheck for autocomplete suggestions'

  45.     autocorrect_suggest_words:

  46.       type: boolean

  47.       label: 'Suggest additional words'