You are here

Home » API reference » Apigee Edge 8

apigee_edge.schema.yml in Apigee Edge 8

config/schema/apigee_edge.schema.yml

File

config/schema/apigee_edge.schema.yml
View source 
  1. apigee_edge.error_page:

  2.   type: config_object

  3.   label: 'Apigee Edge: Error page'

  4.   mapping:

  5.     error_page_title:

  6.       type: label

  7.       label: 'Error page title'

  8.     error_page_content:

  9.       type: mapping

  10.       mapping:

  11.         format:

  12.           type: string

  13.         value:

  14.           type: text

  15.           label: 'Error page content'

  16.     error_page_debug_messages:

  17.       type: boolean

  18.       label: 'Show additional debug messages'

  19. 

  20. apigee_edge.auth:

  21.   type: config_object

  22.   mapping:

  23.     active_key:

  24.       type: string

  25.     oauth_token_storage_location:

  26.       type: string

  27. 

  28. apigee_edge.client:

  29.   type: config_object

  30.   mapping:

  31.     http_client_connect_timeout:

  32.       type: float

  33.     http_client_timeout:

  34.       type: float

  35.     http_client_proxy:

  36.       type: string

  37. 

  38. apigee_edge.common_app_settings:

  39.   type: config_object

  40.   label: 'Common app settings'

  41.   mapping:

  42.     display_as_select:

  43.       type: boolean

  44.     user_select:

  45.       type: boolean

  46.     multiple_products:

  47.       type: boolean

  48.     default_products:

  49.       type: sequence

  50.       sequence:

  51.         type: string

  52.     analytics_available_environments:

  53.       type: sequence

  54.       sequence:

  55.         type: string

  56.     analytics_environment:

  57.       type: string

  58.     callback_url_pattern:

  59.       type: string

  60.     callback_url_pattern_error_message:

  61.       type: label

  62.       label: 'Human readable description of the validation criteria that a Callback URL should match'

  63.     callback_url_description:

  64.       type: label

  65.       label: 'Description of the Callback URL field'

  66.     callback_url_placeholder:

  67.       type: label

  68.       label: 'Placeholder for a Callback URL'

  69. 

  70. apigee_edge.developer_app_settings:

  71.   type: config_object

  72.   label: 'Developer app settings'

  73.   mapping:

  74.     entity_label_singular:

  75.       type: label

  76.       label: 'How to refer to a Developer App on the UI (singular)'

  77.     entity_label_plural:

  78.       type: label

  79.       label: 'How to refer to a Developer App on the UI (plural)'

  80.     cache_expiration:

  81.       type: integer

  82.     required_base_fields:

  83.       type: sequence

  84.       sequence:

  85.         type: string

  86.     locked_base_fields:

  87.       type: sequence

  88.       sequence:

  89.         type: string

  90.     credential_lifetime:

  91.       type: integer

  92. 

  93. apigee_edge.display_settings.*:

  94.   type: config_object

  95.   label: 'Display settings'

  96.   mapping:

  97.     display_type:

  98.       type: string

  99.       label: 'Display type'

  100.     view_mode:

  101.       type: string

  102.       label: 'View mode'

  103. 

  104. field.widget.settings.app_callback_url:

  105.   type: mapping

  106.   label: 'Callback URL widget settings'

  107.   mapping:

  108.     size:

  109.       type: integer

  110.       label: 'Size of textfield'

  111.     placeholder:

  112.       type: label

  113.       label: 'Placeholder for a Callback URL field'

  114.     callback_url_pattern:

  115.       type: string

  116.       label: 'Regular expression that a Callback URL should match'

  117.     callback_url_pattern_error_message:

  118.       type: string

  119.       label: 'Client-side validation error message if a Callback URL does not match'

  120.     callback_url_description:

  121.       type: string

  122.       label: 'Description of a Callback URL field'

  123. 

  124. apigee_edge.developer_settings:

  125.   type: config_object

  126.   label: 'Developer settings'

  127.   mapping:

  128.     verification_action:

  129.       type: string

  130.     display_only_error_message_content:

  131.       type: mapping

  132.       label: 'Error message when a new user registers and the developer email address is already taken on Apigee Edge but not in Drupal'

  133.       mapping:

  134.         format:

  135.           type: string

  136.         value:

  137.           type: text

  138.           label: 'Message'

  139.     verify_email_error_message:

  140.       type: mapping

  141.       mapping:

  142.         format:

  143.           type: string

  144.         value:

  145.           type: text

  146.     verification_email:

  147.       type: 'mail'

  148.       label: 'Verification email'

  149.     verification_token:

  150.       type: string

  151.     verification_token_expires:

  152.       type: integer

  153.     user_edit_error_message:

  154.       type: mapping

  155.       label: 'Error message displayed to a user when the email address is already taken on Apigee Edge but not in Drupal'

  156.       mapping:

  157.         format:

  158.           type: string

  159.         value:

  160.           type: text

  161.           label: 'Message'

  162.     cache_expiration:

  163.       type: integer

  164. 

  165. apigee_edge.api_product_settings:

  166.   type: config_object

  167.   label: 'API Product settings'

  168.   mapping:

  169.     entity_label_singular:

  170.       type: label

  171.       label: 'How to refer to an API Product on the UI (singular)'

  172.     entity_label_plural:

  173.       type: label

  174.       label: 'How to refer to an API Product on the UI (plural)'

  175.     cache_expiration:

  176.       type: integer

  177.     access:

  178.       type: mapping

  179.       label: 'Filter displayed API products by access attribute'

  180.       mapping:

  181.         public:

  182.           type: sequence

  183.           sequence:

  184.             type: string

  185.         private:

  186.           type: sequence

  187.           sequence:

  188.             type: string

  189.         internal:

  190.           type: sequence

  191.           sequence:

  192.             type: string

  193. 

  194. apigee_edge.sync:

  195.   type: config_object

  196.   mapping:

  197.     filter:

  198.       type: string

  199.     user_fields_to_sync:

  200.       type: sequence

  201.       sequence:

  202.         type: string

  203. 

  204. key.type.apigee_auth:

  205.   type: sequence

  206. 

  207. key.input.apigee_auth_input:

  208.   type: sequence

  209. 

  210. key.provider.apigee_edge_environment_variables:

  211.   type: sequence

  212. 

  213. key.provider.apigee_edge_private_file:

  214.   type: sequence

  215. 

  216. field.formatter.settings.status_property:

  217.   type: mapping

  218.   label: 'Status property settings'

  219.   mapping:

  220.     indicator_status_ok:

  221.       type: string

  222.       label: 'Indicator status: OK'

  223.     indicator_status_warning:

  224.       type: string

  225.       label: 'Indicator status: Warning'

  226.     indicator_status_error:

  227.       type: string

  228.       label: 'Indicator status: Error'

  229. 

  230. # Dangerous settings. Enabling these might lead to data corruption.

  231. #

  232. # Mostly used for testing, or in specific scenarios.

  233. apigee_edge.dangerzone:

  234.   type: config_object

  235.   label: 'Dangerous settings'

  236.   mapping:

  237. 

  238.     # Allows changing whether single or multiple products can be assigned for an app,

  239.     # even when content exists.

  240.     skip_developer_app_settings_validation:

  241.       type: boolean

  242.     # Disable modifications added by the Apigee Edge module to the Key add/edit

  243.     # forms. If something would be broken because of the customizations that

  244.     # we made this is the simplest way to disable them without any code change.

  245.     do_not_alter_key_entity_forms:

  246.       type: boolean