You are here

Home » API reference » Search API 8

search_api.views.schema.yml in Search API 8

config/schema/search_api.views.schema.yml

File

config/schema/search_api.views.schema.yml
View source 
  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.     preserve_facet_query_args:

  12.       type: boolean

  13.       label: By default, changing an exposed filter would reset all selected facets. This option allows you to prevent this behavior.

  14. 

  15. views.row.search_api:

  16.   type: views_row

  17.   label: 'Search API rendered item'

  18.   mapping:

  19.     view_modes:

  20.       type: sequence

  21.       label: View modes for each datasource

  22.       orderby: key

  23.       sequence:

  24.         type: sequence

  25.         label: A list of all the bundles and their configured view mode

  26.         orderby: key

  27.         sequence:

  28.           type: string

  29.           label: View mode for the specific bundle

  30. 

  31. views.cache.search_api_time:

  32.   type: views_cache

  33.   label: 'Time-based caching (Search API)'

  34.   mapping:

  35.     options:

  36.       type: mapping

  37.       label: 'Cache options'

  38.       mapping:

  39.         results_lifespan:

  40.           type: integer

  41.           label: 'The length of time raw query results should be cached.'

  42.         results_lifespan_custom:

  43.           type: integer

  44.           label: 'Length of time in seconds raw query results should be cached.'

  45.         output_lifespan:

  46.           type: integer

  47.           label: 'The length of time rendered HTML output should be cached.'

  48.         output_lifespan_custom:

  49.           type: integer

  50.           label: 'Length of time in seconds rendered HTML output should be cached.'

  51. 

  52. views.cache.search_api_tag:

  53.   type: views_cache

  54.   label: 'Tag-based caching (Search API)'

  55.   mapping:

  56.     options:

  57.       type: mapping

  58.       label: 'Cache options'

  59. 

  60. 

  61. views.argument.search_api:

  62.   type: views.argument.numeric

  63.   label: 'Search API'

  64. 

  65. views.argument.search_api_fulltext:

  66.   type: views.argument.search_api

  67.   label: 'Search API more like this'

  68.   mapping:

  69.     parse_mode:

  70.       type: string

  71.       label: 'Parse mode'

  72.     conjunction:

  73.       type: string

  74.       label: 'Conjunction'

  75.     fields:

  76.       type: sequence

  77.       label: 'Fields'

  78.       orderby: value

  79.       sequence:

  80.         type: string

  81.         label: 'Field'

  82. 

  83. views.argument.search_api_more_like_this:

  84.   type: views_argument

  85.   label: 'Search API more like this'

  86.   mapping:

  87.     fields:

  88.       type: sequence

  89.       label: 'Fields'

  90.       orderby: value

  91.       sequence:

  92.         type: string

  93.         label: 'Field'

  94. 

  95. views.argument.search_api_term:

  96.   type: views.argument.search_api

  97.   label: 'Search API taxonomy term'

  98. 

  99. views.field.search_api:

  100.   type: views_field

  101.   label: 'Search API standard'

  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. 

  116. views.field.search_api_boolean:

  117.   type: views.field.boolean

  118.   label: 'Search API boolean'

  119.   mapping:

  120.     link_to_item:

  121.       type: boolean

  122.       label: 'Link to item'

  123.     use_highlighting:

  124.       type: boolean

  125.       label: 'Use highlighted field data'

  126.     multi_type:

  127.       type: string

  128.       label: 'Handling of multiple values'

  129.     multi_separator:

  130.       type: string

  131.       label: 'Separator for multiple values'

  132. 

  133. views.field.search_api_bulk_form:

  134.   type: views.field.bulk_form

  135.   label: 'Search API bulk form'

  136. 

  137. views.field.search_api_date:

  138.   type: views.field.date

  139.   label: 'Search API date'

  140.   mapping:

  141.     link_to_item:

  142.       type: boolean

  143.       label: 'Link to item'

  144.     use_highlighting:

  145.       type: boolean

  146.       label: 'Use highlighted field data'

  147.     multi_type:

  148.       type: string

  149.       label: 'Handling of multiple values'

  150.     multi_separator:

  151.       type: string

  152.       label: 'Separator for multiple values'

  153. 

  154. views.field.search_api_entity:

  155.   type: views.field.search_api

  156.   label: 'Search API entity reference'

  157.   mapping:

  158.     display_methods:

  159.       type: sequence

  160.       label: 'Display settings'

  161.       orderby: key

  162.       sequence:

  163.         type: mapping

  164.         label: 'Display settings for bundle'

  165.         mapping:

  166.           display_method:

  167.             type: string

  168.             label: 'Display method'

  169.           view_mode:

  170.             type: string

  171.             label: 'View mode'

  172. 

  173. views.field.search_api_field:

  174.   type: views.field.field

  175.   label: 'Search API entity field'

  176.   mapping:

  177.     field_rendering:

  178.       type: boolean

  179.       label: 'Use entity field rendering'

  180.     fallback_handler:

  181.       type: string

  182.       label: 'Fallback handler'

  183.     fallback_options:

  184.       type: views.field.[%parent.fallback_handler]

  185.       label: 'Options for fallback handler'

  186. 

  187. views.field.search_api_numeric:

  188.   type: views.field.numeric

  189.   label: 'Search API boolean'

  190.   mapping:

  191.     link_to_item:

  192.       type: boolean

  193.       label: 'Link to item'

  194.     use_highlighting:

  195.       type: boolean

  196.       label: 'Use highlighted field data'

  197.     multi_type:

  198.       type: string

  199.       label: 'Handling of multiple values'

  200.     multi_separator:

  201.       type: string

  202.       label: 'Separator for multiple values'

  203.     format_plural_values:

  204.       type: sequence

  205.       label: 'Pluralized strings'

  206.       sequence:

  207.         type: string

  208.         label: 'Singular/Plural string'

  209. 

  210. views.field.search_api_rendered_item:

  211.   type: views.field.search_api

  212.   label: 'Search API rendered item'

  213.   mapping:

  214.     view_modes:

  215.       type: sequence

  216.       label: 'View modes for each datasource'

  217.       orderby: key

  218.       sequence:

  219.         type: sequence

  220.         label: 'A list of all the bundles and their configured view mode'

  221.         orderby: key

  222.         sequence:

  223.           type: string

  224.           label: 'View mode for the specific bundle'

  225. 

  226. views.filter.search_api_boolean:

  227.   type: views.filter.boolean

  228.   label: 'Search API boolean'

  229. 

  230. views.filter.search_api_datasource:

  231.   type: views.filter.search_api_options

  232.   label: 'Search API datasource'

  233. 

  234. views.filter.search_api_date:

  235.   type: views.filter.date

  236.   label: 'Search API date'

  237. 

  238. views.filter.search_api_fulltext:

  239.   type: views_filter

  240.   label: 'Search API fulltext search'

  241.   mapping:

  242.     parse_mode:

  243.       type: string

  244.       label: Parse mode

  245.     min_length:

  246.       type: integer

  247.       label: Minimum search string length

  248.     fields:

  249.       type: sequence

  250.       label: Fields to search on

  251.       orderby: value

  252.       sequence:

  253.         type: string

  254.         label: Field name

  255.     expose:

  256.       type: mapping

  257.       label: 'Exposed'

  258.       mapping:

  259.         expose_fields:

  260.           type: boolean

  261.           label: 'Expose the list of searched fields'

  262.         placeholder:

  263.           type: label

  264.           label: 'Placeholder'

  265.         searched_fields_id:

  266.           type: string

  267.           label: 'Searched fields identifier'

  268. 

  269. views.filter.search_api_language:

  270.   type: views.filter.language

  271.   label: 'Search API language'

  272. 

  273. views.filter.search_api_numeric:

  274.   type: views.filter.numeric

  275.   label: 'Search API numeric'

  276. 

  277. views.filter.search_api_options:

  278.   type: views.filter.many_to_one

  279.   label: 'Search API options'

  280. 

  281. views.filter.search_api_string:

  282.   type: views.filter.search_api_numeric

  283.   label: 'Search API string'

  284. 

  285. views.filter.search_api_term:

  286.   type: views.filter.taxonomy_index_tid

  287.   label: 'Search API taxonomy term'

  288. 

  289. views.filter.search_api_text:

  290.   type: views.filter.search_api_string

  291.   label: 'Search API text'

  292. 

  293. views.filter.search_api_user:

  294.   type: views.filter.user_name

  295.   label: 'Search API user'

  296. 

  297. views.filter_value.search_api_boolean:

  298.   type: string

  299. 

  300. views.filter_value.search_api_datasource:

  301.   type: string

  302. 

  303. views.filter_value.search_api_date:

  304.   type: views.filter_value.date

  305.   label: 'Search API date'

  306. 

  307. views.filter_value.search_api_fulltext:

  308.   type: string

  309. 

  310. views.filter_value.search_api_language:

  311.   type: string

  312. 

  313. views.filter_value.search_api_numeric:

  314.   type: views.filter_value.numeric

  315. 

  316. views.filter_value.search_api_options:

  317.   type: sequence

  318.   orderby: value

  319.   sequence:

  320.     type: string

  321.     label: 'Value'

  322. 

  323. views.filter_value.search_api_string:

  324.   type: views.filter_value.numeric

  325. 

  326. views.filter_value.search_api_term:

  327.   type: string

  328. 

  329. views.filter_value.search_api_text:

  330.   type: views.filter_value.numeric

  331. 

  332. views.filter_value.search_api_user:

  333.   type: string

  334. 

  335. views.relationship.search_api:

  336.   type: views_relationship

  337.   label: 'Search API'

  338.   mapping:

  339.     skip_access:

  340.       type: boolean

  341.       label: Do not execute access checks for entities referenced via this relationship.