You are here

Home » API reference » Address 8

address.schema.yml in Address 8

config/schema/address.schema.yml

File

config/schema/address.schema.yml
View source 
  1. address:

  2.   type: mapping

  3.   label: 'Address'

  4.   mapping:

  5.     langcode:

  6.       type: string

  7.       label: 'Language code'

  8.     country_code:

  9.       type: string

  10.       label: 'Country code'

  11.     administrative_area:

  12.       type: string

  13.       label: 'Administrative area'

  14.     locality:

  15.       type: string

  16.       label: 'Locality'

  17.     dependent_locality:

  18.       type: string

  19.       label: 'Dependent locality'

  20.     postal_code:

  21.       type: string

  22.       label: 'Postal code'

  23.     sorting_code:

  24.       type: string

  25.       label: 'Sorting code'

  26.     address_line1:

  27.       type: string

  28.       label: 'First line of the address block'

  29.     address_line2:

  30.       type: string

  31.       label: 'Second line of the address block'

  32.     organization:

  33.       type: string

  34.       label: 'Organization'

  35.     given_name:

  36.       type: string

  37.       label: 'Given name'

  38.     additional_name:

  39.       type: string

  40.       label: 'Additional name'

  41.     family_name:

  42.       type: string

  43.       label: 'Family name'

  44. 

  45. address_zone:

  46.   type: mapping

  47.   label: 'Zone'

  48.   mapping:

  49.     label:

  50.       type: label

  51.       label: 'Label'

  52.     territories:

  53.       type: sequence

  54.       label: 'Territories'

  55.       sequence:

  56.         - type: address_zone_territory

  57. 

  58. address_zone_territory:

  59.   type: mapping

  60.   label: 'Zone territory'

  61.   mapping:

  62.     country_code:

  63.       type: string

  64.       label: 'Country'

  65.     administrative_area:

  66.       type: string

  67.       label: 'Administrative area'

  68.     locality:

  69.       type: string

  70.       label: 'Locality'

  71.     dependent_locality:

  72.       type: string

  73.       label: 'Dependent locality'

  74.     included_postal_codes:

  75.       type: string

  76.       label: 'Included postal codes'

  77.     excluded_postal_codes:

  78.       type: string

  79.       label: 'Excluded postal codes'

  80. 

  81. field.value.address:

  82.   type: address

  83.   label: 'Default value'

  84. 

  85. field.value.address_country:

  86.   type: mapping

  87.   label: 'Default value'

  88.   mapping:

  89.     value:

  90.       type: string

  91.       label: 'Country code'

  92. 

  93. field.value.address_zone:

  94.   type: ignore

  95. 

  96. field.field_settings.address:

  97.   type: mapping

  98.   label: 'Address field settings'

  99.   mapping:

  100.     available_countries:

  101.       type: sequence

  102.       label: 'Available countries'

  103.       sequence:

  104.         - type: string

  105.     langcode_override:

  106.       type: string

  107.       label: 'Language override'

  108.     field_overrides:

  109.       type: sequence

  110.       label: 'Field overrides'

  111.       sequence:

  112.         type: mapping

  113.         mapping:

  114.           override:

  115.             type: string

  116.             label: 'Override'

  117.     # Deprecated, replaced by field_overrides.

  118.     fields:

  119.       type: sequence

  120.       label: 'Used fields'

  121.       sequence:

  122.         - type: string

  123. 

  124. field.field_settings.address_country:

  125.   type: mapping

  126.   label: 'Country field settings'

  127.   mapping:

  128.     available_countries:

  129.       type: sequence

  130.       label: 'Available countries'

  131.       sequence:

  132.         - type: string

  133. 

  134. field.field_settings.address_zone:

  135.   type: mapping

  136.   label: 'Zone field settings'

  137.   mapping:

  138.     available_countries:

  139.       type: sequence

  140.       label: 'Available countries'

  141.       sequence:

  142.         - type: string

  143. 

  144. field.widget.settings.address_default:

  145.   type: mapping

  146.   label: 'Default address widget settings'

  147. 

  148. field.widget.settings.address_zone_default:

  149.   type: mapping

  150.   label: 'Default zone widget settings'

  151.   mapping:

  152.     show_label_field:

  153.       type: boolean

  154.       label: 'Show the zone label field'

  155. 

  156. views.field.country:

  157.   type: views_field

  158.   label: 'Country'

  159.   mapping:

  160.     display_name:

  161.       type: boolean

  162.       label: 'Display the country name instead of the country code'

  163. 

  164. views.field.country_code:

  165.   type: views.field.country

  166.   label: 'Country code'

  167. 

  168. views.field.subdivision:

  169.   type: views_field

  170.   label: 'Subdivision'

  171.   mapping:

  172.     display_name:

  173.       type: boolean

  174.       label: 'Display the subdivision name instead of the subdivision code'

  175. 

  176. views.filter.country:

  177.   type: views.filter.in_operator

  178.   label: 'Country'

  179. 

  180. views.filter.country_code:

  181.   type: views.filter.country

  182.   label: 'Country code'

  183. 

  184. views.filter.administrative_area:

  185.   type: views.filter.in_operator

  186.   label: 'Administrative area'

  187.   mapping:

  188.     country:

  189.       type: mapping

  190.       mapping:

  191.         country_source:

  192.           type: string

  193.           label: 'Country source'

  194.         country_argument_id:

  195.           type: string

  196.           label: 'Country contextual filter ID'

  197.         country_filter_id:

  198.           type: string

  199.           label: 'Exposed country filter ID'

  200.         country_static_code:

  201.           type: string

  202.           label: 'Predefined country for administrative areas'

  203.     expose:

  204.       type: mapping

  205.       mapping:

  206.         label_type:

  207.           type: string

  208.           label: 'Label type'

  209. 

  210. views.sort.country:

  211.   type: views_sort

  212.   label: 'Country'

  213.   mapping:

  214.     sort_by:

  215.       type: string

  216.       label: 'Sort by'