You are here

Home » API reference » Search API Federated Solr 8

search_api_federated_solr.schema.yml in Search API Federated Solr 8

Same filename and directory in other branches
  1. 8.3 config/schema/search_api_federated_solr.schema.yml
  2. 8.2 config/schema/search_api_federated_solr.schema.yml
  3. 4.x config/schema/search_api_federated_solr.schema.yml
config/schema/search_api_federated_solr.schema.yml

File

config/schema/search_api_federated_solr.schema.yml
View source 
  1. # Schema for configuration files of the Search API Federated Solr module.

  2. 

  3. search_api_federated_solr.search_app.settings:

  4.   type: config_object

  5.   label: 'Search API Federated Solr settings'

  6.   mapping:

  7.     path:

  8.       type: string

  9.       label: 'The path for the search app.'

  10.     facet:

  11.       type: mapping

  12.       mapping:

  13.         site_name:

  14.           type: mapping

  15.           mapping:

  16.             set_default:

  17.               type: boolean

  18.               label: 'When true, only search results from this site will be shown.'

  19.     index:

  20.       type: mapping

  21.       mapping:

  22.         id:

  23.           type: string

  24.           label: 'Defines which search_api index and server the search app should use.'

  25.         has_site_name_property:

  26.           type: boolean

  27.           label: 'Has site name flag.'

  28.         server_url:

  29.           type: string

  30.           label: 'The server url for the search app.'

  31.         username:

  32.           type: string

  33.           label: 'Basic Auth username.'

  34.         password:

  35.           type: string

  36.           label: 'Basic Auth password.'

  37.     content:

  38.       type: mapping

  39.       mapping:

  40.         no_results:

  41.           type: string

  42.           label: 'This text is shown when a query returns no results.'

  43.         search_prompt:

  44.           type: string

  45.           label: 'This text is shown when no query term has been entered.'

  46.     results:

  47.       type: mapping

  48.       mapping:

  49.         rows:

  50.           type: integer

  51.           label: 'The max number of results to render per search results page.'

  52.     pagination:

  53.       type: mapping

  54.       mapping:

  55.         buttons:

  56.           type: integer

  57.           label: 'The max number of numbered pagination buttons to show at a given time.'