maintenance-1.0.0-beta1/config/schema/maintenance.schema.yml

# Schema for the configuration files of the maintenance module.
maintenance.settings:
  type: config_object
  label: 'Maintenance Settings'
  mapping:
    report:
      type: mapping
      label: 'Maintenance Mode Reports'
      mapping:
        enabled:
          type: boolean
          label: 'Maintenance Status'
        latest:
          type: timestamp
          label: 'Maintenance Latest Time'
        log:
          type: mapping
          label: 'Maintenance Log Settings'
          mapping:
            enabled:
              type: boolean
              label: 'Log enabled'
            note:
              type: text
              label: 'Log note'
    content:
      type: mapping
      label: 'Maintenance Content Settings'
      mapping:
        base:
          type: string
          label: 'Message source (html / node)'
        title:
          type: string
          label: 'Title'
        message:
          type: text_format
          label: 'Message'
        format:
          type: string
          label: 'Text-format'
        node:
          type: string
          label: 'Specific node content'
        notice:
          type: string
          label: 'Notice after time is up'
    countdown:
      type: mapping
      label: 'Maintenance Countdown Settings'
      mapping:
        enabled:
          type: boolean
          label: 'Countdown enabled'
        date:
          type: string
          label: 'Countdown date'
    refresh:
      type: mapping
      label: 'Maintenance Refresh Settings'
      mapping:
        enabled:
          type: boolean
          label: 'Refresh enabled'
        reload:
          type: integer
          label: 'Refresh page reload'
    redirect:
      type: mapping
      label: 'Maintenance redirect'
      mapping:
        enabled:
          type: boolean
          label: 'Redirect enabled'
        url:
          type: string
          label: 'Redirect URL'
        delay:
          type: integer
          label: 'Redirect delay (in seconds)'
    status:
      type: mapping
      label: 'Maintenance HTTP Status'
      mapping:
        enabled:
          type: boolean
          label: 'HTTP status enabled'
        code:
          type: string
          label: 'HTTP status code'
    schedule:
      type: mapping
      label: 'Maintenance Schedule Settings'
      mapping:
        enabled:
          type: boolean
          label: 'Schedule enabled'
        automatic:
          type: boolean
          label: 'Schedule auto turn off maintenance'
        start:
          type: string
          label: 'Schedule start time'
        end:
          type: string
          label: 'Schedule end time'
        warning:
          type: string
          label: 'Warning message before maintenance'
        offset:
          type: mapping
          label: 'Warning offset before maintenance'
          mapping:
            value:
              type: integer
              label: 'Offset value'
            unit:
              type: string
              label: 'Unit of time before start (e.g. minute)'
    theme:
      type: mapping
      label: 'Maintenance Theme Settings'
      mapping:
        template:
          type: string
          label: 'Theme template'
        logo:
          type: boolean
          label: 'Theme site logo'
        name:
          type: boolean
          label: 'Theme site name'
        slogan:
          type: boolean
          label: 'Theme site slogan'
    ip:
      type: mapping
      label: 'Maintenance IP Visibility'
      mapping:
        visibility:
          type: integer
          label: 'IP visibility'
        addresses:
          type: array
          label: 'IP addresses'
    page:
      type: mapping
      label: 'Maintenance Page Visibility'
      mapping:
        visibility:
          type: integer
          label: 'Page visibility'
        routes:
          type: array
          label: 'Page routes'
    query:
      type: mapping
      label: 'Maintenance Query Visibility'
      mapping:
        strings:
          type: string
          label: 'Query strings'