knowledge-8.x-1.x-dev/config/schema/knowledge.schema.yml

# Schema for the configuration files of the Knowledge module.

knowledge.settings.actions:
  type: mapping
  mapping:
    action:
      type: string
    count:
      type: integer
    frequency:
      type: string
    message:
      type: string


knowledge.settings:
  type: config_object
  label: 'Knowledge settings'
  mapping:
    audience:
      type: mapping
      label: 'Audience field values.'
      mapping:
        public:
          type: mapping
          label: 'Public audience field values.'
          mapping:
            enabled:
              type: boolean
              label: 'Is the public value allowed'
            label:
              type: string
              label: 'Label for Public'
        customer:
          type: mapping
          label: 'Customer audience field values.'
          mapping:
            enabled:
              type: boolean
              label: 'Is the customer value allowed'
            label:
              type: string
              label: 'Label for customer'
        partner:
          type: mapping
          label: 'Partner audience field values.'
          mapping:
            enabled:
              type: boolean
              label: 'Is the partner value allowed'
            label:
              type: string
              label: 'Label for partner'
        internal:
          type: mapping
          label: 'Internal audience field values.'
          mapping:
            enabled:
              type: boolean
              label: 'Is the internal value allowed'
            label:
              type: string
              label: 'Label for internal'
    competency:
      type: mapping
      label: 'competency promotion options.'
      mapping:
        candidate:
          type: string
          label: 'Promotion option when candidate competencies are met.'
        contributor:
          type: string
          label: 'Promotion option when contributor competencies are met.'
        publisher:
          type: string
          label: 'Promotion option when publisher competencies are met.'
        all:
          type: string
          label: 'Promotion option when all competencies are met.'
    node_types:
      type: sequence
      label: 'Knowledge content types'
      sequence:
        type: string
    leader_coach:
      type: boolean
      label: 'Allow leaders to coach their direct reports'
    actions:
      type: mapping
      mapping:
        work_in_progress__not_validated:
          type: knowledge.settings.actions
        not_validated__validated:
          type: knowledge.settings.actions


knowledge.governance.settings:
  type: config_object
  label: 'governance settings'
  mapping:
    roles:
      type: sequence
      sequence:
        type: string

field.formatter.settings.knowledge_default:
  type: mapping
  label: 'Knowledge display format settings'
  mapping:
    view_mode:
      type: string
      label: 'The knowledge entity view mode to be used in this formatter'
    pager_id:
      type: integer
      label: 'Pager ID'
    form:
      type: boolean
      label: Show form

field.widget.settings.knowledge_default:
  type: mapping
  label: 'Knowledge display format settings'

action.configuration.knowledge_unpublish_by_keyword_action:
  type: mapping
  label: 'Unpublish knowledge containing keyword(s) configuration'
  mapping:
    keywords:
      type: sequence
      label: 'Keywords'
      sequence:
        type: string
        label: 'Keyword'

action.configuration.knowledge_set_user_wave_action:
  type: mapping
  label: 'Configuration for the set wave action'
  mapping:
    wave:
      type: string
      label: 'The ID of the wave to set'

knowledge.type.*:
  type: config_entity
  label: 'Knowledge type settings'
  mapping:
    id:
      type: string
      label: 'ID'
    label:
      type: label
      label: 'Label'
    target_entity_type_id:
      type: string
      label: 'Target Entity Type ID'
    incident_entity_type_id:
      type: string
      label: 'Incident Entity Type ID'
    description:
      type: text
      label: 'Description'

field.storage_settings.knowledge:
  type: mapping
  label: 'Knowledge settings'
  mapping:
    knowledge_type:
      label: 'Knowledge type'
      type: string
    short_period:
      label: 'Short period'
      type: integer
    medium_period:
      label: 'Medium period'
      type: integer
    long_period:
      label: 'Long period'
      type: integer

field.value.knowledge:
  type: mapping
  label: 'Default value'
  mapping:
    status:
      type: integer
      label: 'Knowledge status'
    kid:
      type: integer
      label: 'Last knowledge ID'
    first_knowledge_timestamp:
      type: integer
      label: 'First link timestamp'
    first_knowledge_uid:
      type: integer
      label: 'First user ID who linked'
    first_knowledge:
      type: integer
      label: 'First knowledge link ID'
    last_knowledge_timestamp:
      type: integer
      label: 'Last knowledge timestamp'
    last_knowledge_uid:
      type: integer
      label: 'Last user ID who linked'
    last_knowledge:
      type: integer
      label: 'Last knowledge link ID'
    total_count:
      type: integer
      label: 'Amount of links'
    long_count:
      type: integer
      label: 'Amount of links'
    medium_count:
      type: integer
      label: 'Amount of links'
    short_count:
      type: integer
      label: 'Amount of links'
    total_citation:
      type: integer
      label: 'Amount of citations'
    long_citation:
      type: integer
      label: 'Amount of citations'
    medium_citation:
      type: integer
      label: 'Amount of citations'
    short_citation:
      type: integer
      label: 'Amount of citations'

field.field_settings.knowledge:
  type: mapping
  label: 'Knowledge settings'
  mapping:
    anonymous:
      type: integer
      label: 'Mode'
    form_location:
      type: boolean
      label: 'Allow knowledge title'
    per_page:
      type: integer
      label: 'Amount of knowledge per page'

field.formatter.settings.knowledge_permalink:
  type: field.formatter.settings.string

block.settings.knowledge_block:
  type: block_settings
  label: 'Link incident block'
  mapping:
    context:
      type: string
      label: Context
    hash:
      type: string
      label: Hash
    type:
      type: string
      label: Type
    field_name:
      type: string
      label: field_name

knowledge.competency.settings:
  type: config_object
  label: 'Knowledge Competency settings'
  mapping:
    roles:
      type: sequence
      orderby: weight
      sequence:
        type: mapping
        mapping:
          role:
            type: string
            label: 'Role'
          weight:
            type: integer
            label: 'Weight'
          action:
            type: string
            label: 'Action'
          promote:
            type: string
            label: 'Promotion'

knowledge.quality.settings:
  type: config_object
  label: 'Knowledge Quality settings'
  mapping:
    categories:
      type: string

field.field.*.*.*.third_party.knowledge:
  type: config_entity
  label: 'Competency field settings'
  mapping:
    competency_role:
      label: 'The role the competency field belongs to'
      type: string
    quality_category:
      label: 'The quality category'
      type: string

field.field.*.knowledge_quality.*.third_party.knowledge:
  type: mapping
  label: 'Competency field settings'
  mapping:
    quality_category:
      label: 'The quality category'
      type: string

field.formatter.settings.knowledge_competency:
  type: mapping
  mapping:
    format:
      type: string
      label: 'Output format'
    format_custom_false:
      type: label
      label: 'Custom output for FALSE'
    format_custom_true:
      type: label
      label: 'Custom output for TRUE'

field.widget.settings.nullable_bool:
  type: mapping
  label: 'WIDGET NAME widget settings'
  mapping:
    yes:
      type: string
      label: 'The yes value'
    no:
      type: string
      label: 'The no value'
    placeholder:
      type: string
      label: The placeholder