search_api.views.schema.yml 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. views.query.search_api_query:
  2. type: views_query
  3. label: 'Search API query'
  4. mapping:
  5. bypass_access:
  6. type: boolean
  7. label: If the underlying search index has access checks enabled, this option allows you to disable them for this view.
  8. skip_access:
  9. type: boolean
  10. label: Do not execute additional access checks for all items in the search results.
  11. views.row.search_api:
  12. type: views_row
  13. label: 'Search API rendered item'
  14. mapping:
  15. view_modes:
  16. type: sequence
  17. label: View modes for each datasource
  18. sequence:
  19. type: sequence
  20. label: A list of all the bundles and their configured view mode
  21. sequence:
  22. type: string
  23. label: View mode for the specific bundle
  24. views.cache.search_api_time:
  25. type: views_cache
  26. label: 'Time-based caching (Search API)'
  27. mapping:
  28. options:
  29. type: mapping
  30. label: 'Cache options'
  31. mapping:
  32. results_lifespan:
  33. type: integer
  34. label: 'The length of time raw query results should be cached.'
  35. results_lifespan_custom:
  36. type: integer
  37. label: 'Length of time in seconds raw query results should be cached.'
  38. output_lifespan:
  39. type: integer
  40. label: 'The length of time rendered HTML output should be cached.'
  41. output_lifespan_custom:
  42. type: integer
  43. label: 'Length of time in seconds rendered HTML output should be cached.'
  44. views.cache.search_api_tag:
  45. type: views_cache
  46. label: 'Tag-based caching (Search API)'
  47. mapping:
  48. options:
  49. type: mapping
  50. label: 'Cache options'
  51. views.argument.search_api:
  52. type: views.argument.numeric
  53. label: 'Search API'
  54. views.argument.search_api_fulltext:
  55. type: views.argument.search_api
  56. label: 'Search API more like this'
  57. mapping:
  58. parse_mode:
  59. type: string
  60. label: 'Parse mode'
  61. conjunction:
  62. type: string
  63. label: 'Conjunction'
  64. fields:
  65. type: sequence
  66. label: 'Fields'
  67. sequence:
  68. type: string
  69. label: 'Field'
  70. views.argument.search_api_more_like_this:
  71. type: views_argument
  72. label: 'Search API more like this'
  73. mapping:
  74. fields:
  75. type: sequence
  76. label: 'Fields'
  77. sequence:
  78. type: string
  79. label: 'Field'
  80. views.argument.search_api_term:
  81. type: views.argument.search_api
  82. label: 'Search API taxonomy term'
  83. views.field.search_api:
  84. type: views_field
  85. label: 'Search API standard'
  86. mapping:
  87. link_to_item:
  88. type: boolean
  89. label: 'Link to item'
  90. use_highlighting:
  91. type: boolean
  92. label: 'Use highlighted field data'
  93. multi_type:
  94. type: string
  95. label: 'Handling of multiple values'
  96. multi_separator:
  97. type: string
  98. label: 'Separator for multiple values'
  99. views.field.search_api_boolean:
  100. type: views.field.boolean
  101. label: 'Search API boolean'
  102. mapping:
  103. link_to_item:
  104. type: boolean
  105. label: 'Link to item'
  106. use_highlighting:
  107. type: boolean
  108. label: 'Use highlighted field data'
  109. multi_type:
  110. type: string
  111. label: 'Handling of multiple values'
  112. multi_separator:
  113. type: string
  114. label: 'Separator for multiple values'
  115. views.field.search_api_date:
  116. type: views.field.date
  117. label: 'Search API date'
  118. mapping:
  119. link_to_item:
  120. type: boolean
  121. label: 'Link to item'
  122. use_highlighting:
  123. type: boolean
  124. label: 'Use highlighted field data'
  125. multi_type:
  126. type: string
  127. label: 'Handling of multiple values'
  128. multi_separator:
  129. type: string
  130. label: 'Separator for multiple values'
  131. views.field.search_api_entity:
  132. type: views.field.search_api
  133. label: 'Search API entity reference'
  134. mapping:
  135. display_methods:
  136. type: sequence
  137. label: 'Display settings'
  138. sequence:
  139. type: mapping
  140. label: 'Display settings for bundle'
  141. mapping:
  142. display_method:
  143. type: string
  144. label: 'Display method'
  145. view_mode:
  146. type: string
  147. label: 'View mode'
  148. views.field.search_api_field:
  149. type: views.field.field
  150. label: 'Search API entity field'
  151. mapping:
  152. field_rendering:
  153. type: boolean
  154. label: 'Use entity field rendering'
  155. fallback_handler:
  156. type: string
  157. label: 'Fallback handler'
  158. fallback_options:
  159. type: views.field.[%parent.fallback_handler]
  160. label: 'Options for fallback handler'
  161. views.field.search_api_numeric:
  162. type: views.field.numeric
  163. label: 'Search API boolean'
  164. mapping:
  165. link_to_item:
  166. type: boolean
  167. label: 'Link to item'
  168. use_highlighting:
  169. type: boolean
  170. label: 'Use highlighted field data'
  171. multi_type:
  172. type: string
  173. label: 'Handling of multiple values'
  174. multi_separator:
  175. type: string
  176. label: 'Separator for multiple values'
  177. format_plural_values:
  178. type: sequence
  179. label: 'Pluralized strings'
  180. sequence:
  181. type: string
  182. label: 'Singular/Plural string'
  183. views.filter.search_api_boolean:
  184. type: views.filter.boolean
  185. label: 'Search API boolean'
  186. views.filter.search_api_datasource:
  187. type: views.filter.search_api_options
  188. label: 'Search API datasource'
  189. views.filter.search_api_fulltext:
  190. type: views_filter
  191. label: 'Search API fulltext search'
  192. mapping:
  193. parse_mode:
  194. type: string
  195. label: Parse mode
  196. min_length:
  197. type: integer
  198. label: Minimum search string length
  199. fields:
  200. type: sequence
  201. label: Fields to search on
  202. sequence:
  203. type: string
  204. label: Field name
  205. views.filter.search_api_language:
  206. type: views.filter.language
  207. label: 'Search API language'
  208. views.filter.search_api_numeric:
  209. type: views.filter.numeric
  210. label: 'Search API numeric'
  211. views.filter.search_api_options:
  212. type: views.filter.many_to_one
  213. label: 'Search API options'
  214. views.filter.search_api_string:
  215. type: views.filter.search_api_numeric
  216. label: 'Search API string'
  217. views.filter.search_api_term:
  218. type: views.filter.taxonomy_index_tid
  219. label: 'Search API taxonomy term'
  220. views.filter.search_api_text:
  221. type: views.filter.search_api_string
  222. label: 'Search API text'
  223. views.filter.search_api_user:
  224. type: views.filter.user_name
  225. label: 'Search API user'
  226. views.filter_value.search_api_boolean:
  227. type: string
  228. views.filter_value.search_api_datasource:
  229. type: string
  230. views.filter_value.search_api_date:
  231. type: views.filter_value.date
  232. label: 'Search API date'
  233. views.filter_value.search_api_fulltext:
  234. type: string
  235. views.filter_value.search_api_language:
  236. type: string
  237. views.filter_value.search_api_numeric:
  238. type: views.filter_value.numeric
  239. views.filter_value.search_api_options:
  240. type: sequence
  241. sequence:
  242. type: string
  243. label: 'Value'
  244. views.filter_value.search_api_string:
  245. type: views.filter_value.numeric
  246. views.filter_value.search_api_term:
  247. type: string
  248. views.filter_value.search_api_text:
  249. type: views.filter_value.numeric
  250. views.filter_value.search_api_user:
  251. type: string
  252. views.relationship.search_api:
  253. type: views_relationship
  254. label: 'Search API'
  255. mapping:
  256. skip_access:
  257. type: boolean
  258. label: Do not execute access checks for entities referenced via this relationship.