You are here

Home » API reference » Acquia Content Hub 8

acquia_contenthub.schema.yml in Acquia Content Hub 8

Same filename and directory in other branches
  1. 8.2 config/schema/acquia_contenthub.schema.yml
config/schema/acquia_contenthub.schema.yml

File

config/schema/acquia_contenthub.schema.yml
View source 
  1. # Schema for the configuration files of the Acquia Content Hub module.

  2. acquia_contenthub.admin_settings:

  3.   type: config_object

  4.   label: 'Acquia Content Hub admin settings'

  5.   mapping:

  6.     hostname:

  7.       type: string

  8.       label: "Content Hub API Hostname."

  9.     api_key:

  10.       type: string

  11.       label: "Content Hub API Key."

  12.     secret_key:

  13.       type: string

  14.       label: "Content Hub API Secret Key."

  15.     rewrite_domain:

  16.       type: string

  17.       label: "Rewrite current domain to the domain set in this variable to 'fool' content hub where to fetch the content from. Useful with tunnels such as ngrok."

  18.     client_name:

  19.       type: string

  20.       label: "Name of the current site as known in Acquia Content Hub."

  21.     origin:

  22.       type: string

  23.       label: "Content Hub Token for this site."

  24. 

  25. acquia_contenthub.entity_config:

  26.   type: config_object

  27.   label: 'Acquia Content Hub entity configuration settings'

  28.   mapping:

  29.     user_role:

  30.       type: string

  31.       label: "Role to use when converting an Entity to a CDF with or without Metadata"

  32.     dependency_depth:

  33.       type: integer

  34.       label: "The maximum level of dependencies to collect for exporting entities"

  35.     use_block_content_view_builder:

  36.       type: boolean

  37.       label: "If true, uses block_content view builder instead of block plugin render."

  38.     export_with_queue:

  39.       type: integer

  40.       label: "Whether to export entities using the queue"

  41.     export_queue_entities_per_item:

  42.       type: integer

  43.       label: "Number of top-level entities that will be included in each item."

  44.     export_queue_batch_size:

  45.       type: integer

  46.       label: "Number of items that will be processed in the same batch."

  47.     export_queue_waiting_time:

  48.       type: integer

  49.       label: "Waiting time in seconds between processing queue items."

  50.     delete_mismatching_translations:

  51.       type: integer

  52.       label: "Delete mismatching translations when importing content."

  53. 

  54. acquia_contenthub.entity.*:

  55.   type: config_entity

  56.   label: 'Acquia Content Hub entity type configuration'

  57.   mapping:

  58.     id:

  59.       type: string

  60.       label: 'REST resource config ID'

  61.     bundles:

  62.       type: sequence

  63.       label: 'Entity bundle configuration'

  64.       sequence:

  65.         type: mapping

  66.         label: 'A specific entity bundle configuration'

  67.         mapping:

  68.           enable_index:

  69.             type: boolean

  70.             label: 'Defines if this is being sent to Content Hub.'

  71.           enable_viewmodes:

  72.             type: boolean

  73.             label: 'Defines if we want to index view modes to Content Hub.'

  74.           rendering:

  75.             type: sequence

  76.             label: 'Defines which view modes are enabled for this entity bundle.'

  77.             sequence:

  78.               type: string

  79.               label: 'An enabled view mode'

  80.           preview_image_field:

  81.             type: string

  82.             label: 'A mapping string to the field which holds the image file.'

  83.           preview_image_style:

  84.             type: string

  85.             label: 'A image style machine name.'