You are here

Home » API reference » Search API Federated Solr 8.3

search_api_federated_solr.schema.yml in Search API Federated Solr 8.3

Same filename and directory in other branches
  1. 8 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.     page_title:

  11.       type: string

  12.       label: 'Search results page title.'

  13.     facet:

  14.       type: mapping

  15.       mapping:

  16.         site_name:

  17.           type: mapping

  18.           mapping:

  19.             set_default:

  20.               type: boolean

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

  22.             is_hidden:

  23.               type: boolean

  24.               label: 'When true, this facet option is hidden in the UI.'

  25.             allowed_sites:

  26.               type: sequence

  27.               label: 'Sites that may be searched from this instance.'

  28.               sequence:

  29.                 type: string

  30.             site_list:

  31.               type: sequence

  32.               label: 'Sites within the current network.'

  33.               sequence:

  34.                 type: string

  35.         federated_type:

  36.           type: mapping

  37.           mapping:

  38.             is_hidden:

  39.               type: boolean

  40.               label: 'When true, this facet option is hidden in the UI.'

  41.         federated_terms:

  42.           type: mapping

  43.           mapping:

  44.             is_hidden:

  45.               type: boolean

  46.               label: 'When true, this facet option is hidden in the UI.'

  47.     filter:

  48.       type: mapping

  49.       mapping:

  50.         federated_date:

  51.           type: mapping

  52.           mapping:

  53.             is_hidden:

  54.               type: boolean

  55.               label: 'When true, this filter option is hidden in the UI.'

  56.     index:

  57.       type: mapping

  58.       mapping:

  59.         id:

  60.           type: string

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

  62.         has_federated_date_property:

  63.           type: boolean

  64.           label: 'Has federated date flag.'

  65.         has_federated_terms_property:

  66.           type: boolean

  67.           label: 'Has federated terms flag.'

  68.         has_federated_type_property:

  69.           type: boolean

  70.           label: 'Has federated type flag.'

  71.         has_site_name_property:

  72.           type: boolean

  73.           label: 'Has site name flag.'

  74.         username:

  75.           type: string

  76.           label: 'Basic Auth username.'

  77.         password:

  78.           type: string

  79.           label: 'Basic Auth password.'

  80.         query_fields:

  81.           type: sequence

  82.           label: 'Default search fields for queries.'

  83.           sequence:

  84.             type: string

  85.         validate_query_fields:

  86.           type: boolean

  87.           label: 'Flag to ensure default search fields are validated against schema for this site.'

  88.     content:

  89.       type: mapping

  90.       mapping:

  91.         no_results:

  92.           type: string

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

  94.         search_prompt:

  95.           type: string

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

  97.         show_empty_search_results:

  98.           type: integer

  99.           label: 'Flag to render search page as a listing page with all results rendering when no search term is entered.'

  100.     results:

  101.       type: mapping

  102.       mapping:

  103.         rows:

  104.           type: integer

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

  106.     pagination:

  107.       type: mapping

  108.       mapping:

  109.         buttons:

  110.           type: integer

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

  112.     autocomplete:

  113.       type: mapping

  114.       mapping:

  115.         isEnabled:

  116.           type: integer

  117.           label: 'When true, autocomplete is enabled for the search app.'

  118.         appendWildcard:

  119.           type: integer

  120.           label: 'When checked, the query will have a wildcard appended.'

  121.         suggestionRows:

  122.           type: string

  123.           label: 'The number of results to return from the autocomplete request.'

  124.         numChars:

  125.           type: string

  126.           label: 'The number of characters, after which the autocomplete request should be made.'

  127.         mode:

  128.           type: string

  129.           label: 'The type of results returned by the autocomplete request: results or terms.'

  130.         result:

  131.           type: mapping

  132.           mapping:

  133.             titleText:

  134.               type: string

  135.               label: 'The title text for the autocomplete results.'

  136.             hideDirectionsText:

  137.               type: integer

  138.               label: 'When true, the keyboard directions text will be hidden from autocomplete dropdown.'

  139.         proxy:

  140.           type: mapping

  141.           mapping:

  142.             isDisabled:

  143.               type: integer

  144.               label: 'Flag to disable use of Drupal as a Solr proxy for autocomplete query requests.'

  145.         direct:

  146.           type: mapping

  147.           mapping:

  148.             url:

  149.               type: string

  150.               label: 'URL of the autocomplete direct endpoint (defaults to selected index solr server select handler).'

  151.         username:

  152.           type: string

  153.           label: 'Username to be used for autocomplete direct requests basic auth.'

  154.         password:

  155.           type: string

  156.           label: 'Password to be used for autocomplete direct request basic auth.'

  157.         use_search_app_creds:

  158.           type: integer

  159.           label: 'Flag to indicate whether or not we are using basic auth credentials added to search app.'

  160.     proxy:

  161.       type: mapping

  162.       mapping:

  163.         isDisabled:

  164.           type: integer

  165.           label: 'Flag to disable use of Drupal as a Solr proxy for search query requests.'

  166.         debug:

  167.           type: boolean

  168.           label: 'Flag to determine whether or not the proxy response should include debug info.'

  169. 

  170. block.settings.federated_search_page_form_block:

  171.   type: block_settings

  172.   label: 'Federated Search Page Form block'

  173.   mapping:

  174.     autocomplete:

  175.       type: mapping

  176.       mapping:

  177.         isEnabled:

  178.           type: integer

  179.           label: 'Enable autocomplete for the search results page search form'

  180.         proxyIsDisabled:

  181.           type: integer

  182.           label: 'Disable proxy for autocomplete queries'

  183.         directUrl:

  184.           type: string

  185.           label: 'URL of the autocomplete direct endpoint (defaults to selected index solr server select handler).'

  186.         appendWildcard:

  187.           type: integer

  188.           label: 'When checked, the query will have a wildcard appended.'

  189.         suggestionRows:

  190.           type: string

  191.           label: 'The number of results to return from the autocomplete request.'

  192.         numChars:

  193.           type: string

  194.           label: 'The number of characters, after which the autocomplete request should be made.'

  195.         mode:

  196.           type: string

  197.           label: 'The type of results returned by the autocomplete request: results or terms.'

  198.         result:

  199.           type: mapping

  200.           mapping:

  201.             titleText:

  202.               type: string

  203.               label: 'The title text for the autocomplete results.'

  204.             hideDirectionsText:

  205.               type: integer

  206.               label: 'When true, the keyboard directions text will be hidden from autocomplete dropdown.'

  207.         username:

  208.           type: string

  209.           label: 'Username to be used for autocomplete direct requests basic auth.'

  210.         password:

  211.           type: string

  212.           label: 'Password to be used for autocomplete direct request basic auth.'

  213.         use_search_app_creds:

  214.           type: integer

  215.           label: 'Flag to indicate whether or not we are using basic auth credentials added to search app.'