Schema for Eliza Response Content

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

title: Response Content
description: >-
  This is the `content` encoded in the Response answer object for Jarvis data flow.

type: object
additionalProperties: false
required: [title]

properties:
  title:
    title: Title
    description: Title of the dialogue. This will be used in the carousels/quick reply.
    type: string

    minLength: 1

  is_quick_reply:
    title: Is quick reply
    description: If response is available as quick reply.
    type: boolean

  messages:
    title: Messages
    description: Array of messages that will be returned to user as is.
    type: array

    items:
      - $ref: "/ratatoskr/Message.schema"
    #end items
  #end messages

  random_messages:
    title: Random messages
    description: Array of messages (i.e., array of array of message) which will be randomly selected and returned to the user.
    type: array

    items:
      type: array

      items:
        - $ref: "/ratatoskr/Message.schema"
    #end items
  #end random_messages

  metadata:
    title: Metadata
    description: Metadata associated with the messages to return to the user via delivery metadata.

    $ref: "/ratatoskr/DeliveryMetadata.schema"
  #end metadata
#end properties