Schema for Cleo DialogueTriggerResponse

From DialogueTriggerResponse.schema.yaml (cleo/DialogueTriggerResponse.schema)

---
$id: https://skeleton.botmd.io/cleo/DialogueTriggerResponse.schema
$schema: http://json-schema.org/draft-07/schema#
title: DialogueTriggerResponse
description: The structure for dialogue triggers and responses.
required: [triggers, responses]
type: object
properties:
  responses:
    description: List of response messages for the dialogue.
    items:
      $ref: "#/$defs/DialogueResponse"
    title: Responses
    type: array
  triggers:
    description: List of triggers for the dialogue.
    items:
      $ref: "#/$defs/V1Trigger"
    title: Triggers
    type: array

$defs:
  CommunicationMethod:
    enum: [any, botmd, email, line, messenger, sms, telegram, whatsapp, viber]
    title: CommunicationMethod
    type: string
  DialogueResponse:
    properties:
      communication_method:
        $ref: "#/$defs/CommunicationMethod"
      messages:
        items:
          $ref: "/ratatoskr/Message.schema"
        title: Messages
        type: array
      is_templated_answer:
        type: boolean
        title: Is Templated Answer
        description: Whether the response is a templated answer.
        default: false
      is_yaml_template:
        type: boolean
        title: Is YAML Template
        description: Whether the templated answer is a YAML template.
        default: false
    required: [communication_method, messages]
    title: DialogueResponse
    type: object
  V1Trigger:
    properties:
      type:
        default: v1_trigger
        description: List of triggers for the dialogue.
        title: Triggers
        type: string
      v1_trigger:
        default: []
        items:
          type: string
        title: V1 Trigger
        type: array
    title: V1Trigger
    type: object

[Main Page] [Schema Documentation] [Examples]