Schema for Cleo Triggered Alert Metadata

---
$id: https://skeleton.botmd.io/cleo/TriggeredAlertMetadata.schema
$schema: http://json-schema.org/draft-07/schema#

title: Triggered Alert Metadata
description: Metadata for triggered alert such as the rule at time of trigger.

type: object
additionalProperties: false
required: [alert_reasons, alert_rule]

properties:
  alert_reasons:
    title: Alert Reasons
    description: Array of reasons why the alert was raised.

    type: array
    minItems: 0
    items:
      type: object
      additionalProperties: false
      required: [reason]

      properties:
        reason:
          title: Reason
          description: Human readable description of the reason for this alert.
          type: string
          minLength: 1

        submission_value:
          title: Submission Value
          description: The submission value that triggered this alert. This is a dictified version of the `SubmissionValue` model.

          type: [object, "null"]
          additionalProperties: true
        #end submission_value
      #end properties
    #end items
  #end alert_reasons

  alert_rule:
    title: Alert Rule
    description: The dictified alert rule that triggered this alert. This is important for audit and debugging.

    type: object
    additionalProperties: true
    required: [name, parser_import_path, parser_settings]
  #end alert_rule
#end properties