You are here

search_api_federated_solr.schema.yml in Search API Federated Solr 8.2

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. search_api_federated_solr.search_app.settings:
  3. type: config_object
  4. label: 'Search API Federated Solr settings'
  5. mapping:
  6. path:
  7. type: string
  8. label: 'The path for the search app.'
  9. page_title:
  10. type: string
  11. label: 'Search results page title.'
  12. facet:
  13. type: mapping
  14. mapping:
  15. site_name:
  16. type: mapping
  17. mapping:
  18. set_default:
  19. type: boolean
  20. label: 'When true, only search results from this site will be shown.'
  21. is_hidden:
  22. type: boolean
  23. label: 'When true, this facet option is hidden in the UI.'
  24. allowed_sites:
  25. type: sequence
  26. label: 'Sites that may be searched from this instance.'
  27. sequence:
  28. type: string
  29. site_list:
  30. type: sequence
  31. label: 'Sites within the current network.'
  32. sequence:
  33. type: string
  34. federated_type:
  35. type: mapping
  36. mapping:
  37. is_hidden:
  38. type: boolean
  39. label: 'When true, this facet option is hidden in the UI.'
  40. federated_terms:
  41. type: mapping
  42. mapping:
  43. is_hidden:
  44. type: boolean
  45. label: 'When true, this facet option is hidden in the UI.'
  46. filter:
  47. type: mapping
  48. mapping:
  49. federated_date:
  50. type: mapping
  51. mapping:
  52. is_hidden:
  53. type: boolean
  54. label: 'When true, this filter option is hidden in the UI.'
  55. index:
  56. type: mapping
  57. mapping:
  58. id:
  59. type: string
  60. label: 'Defines which search_api index and server the search app should use.'
  61. has_federated_date_property:
  62. type: boolean
  63. label: 'Has federated date flag.'
  64. has_federated_terms_property:
  65. type: boolean
  66. label: 'Has federated terms flag.'
  67. has_federated_type_property:
  68. type: boolean
  69. label: 'Has federated type flag.'
  70. has_site_name_property:
  71. type: boolean
  72. label: 'Has site name flag.'
  73. username:
  74. type: string
  75. label: 'Basic Auth username.'
  76. password:
  77. type: string
  78. label: 'Basic Auth password.'
  79. query_fields:
  80. type: sequence
  81. label: 'Default search fields for queries.'
  82. sequence:
  83. type: string
  84. validate_query_fields:
  85. type: boolean
  86. label: 'Flag to ensure default search fields are validated against schema for this site.'
  87. content:
  88. type: mapping
  89. mapping:
  90. no_results:
  91. type: string
  92. label: 'This text is shown when a query returns no results.'
  93. search_prompt:
  94. type: string
  95. label: 'This text is shown when no query term has been entered.'
  96. show_empty_search_results:
  97. type: integer
  98. label: 'Flag to render search page as a listing page with all results rendering when no search term is entered.'
  99. results:
  100. type: mapping
  101. mapping:
  102. rows:
  103. type: integer
  104. label: 'The max number of results to render per search results page.'
  105. pagination:
  106. type: mapping
  107. mapping:
  108. buttons:
  109. type: integer
  110. label: 'The max number of numbered pagination buttons to show at a given time.'
  111. autocomplete:
  112. type: mapping
  113. mapping:
  114. isEnabled:
  115. type: integer
  116. label: 'When true, autocomplete is enabled for the search app.'
  117. appendWildcard:
  118. type: integer
  119. label: 'When checked, the query will have a wildcard appended.'
  120. suggestionRows:
  121. type: string
  122. label: 'The number of results to return from the autocomplete request.'
  123. numChars:
  124. type: string
  125. label: 'The number of characters, after which the autocomplete request should be made.'
  126. mode:
  127. type: string
  128. label: 'The type of results returned by the autocomplete request: results or terms.'
  129. result:
  130. type: mapping
  131. mapping:
  132. titleText:
  133. type: string
  134. label: 'The title text for the autocomplete results.'
  135. hideDirectionsText:
  136. type: integer
  137. label: 'When true, the keyboard directions text will be hidden from autocomplete dropdown.'
  138. proxy:
  139. type: mapping
  140. mapping:
  141. isDisabled:
  142. type: integer
  143. label: 'Flag to disable use of Drupal as a Solr proxy for autocomplete query requests.'
  144. direct:
  145. type: mapping
  146. mapping:
  147. url:
  148. type: string
  149. label: 'URL of the autocomplete direct endpoint (defaults to selected index solr server select handler).'
  150. username:
  151. type: string
  152. label: 'Username to be used for autocomplete direct requests basic auth.'
  153. password:
  154. type: string
  155. label: 'Password to be used for autocomplete direct request basic auth.'
  156. use_search_app_creds:
  157. type: integer
  158. label: 'Flag to indicate whether or not we are using basic auth credentials added to search app.'
  159. proxy:
  160. type: mapping
  161. mapping:
  162. isDisabled:
  163. type: integer
  164. label: 'Flag to disable use of Drupal as a Solr proxy for search query requests.'
  165. debug:
  166. type: boolean
  167. label: 'Flag to determine whether or not the proxy response should include debug info.'