Schema for Hospital Common definitions

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

title: Common definitions
description: A schema containing common properties required in Amplitude events.
skeletonOptions:
  hasTests: false
type: "null"

definitions:
  open_from:
    title: Open from
    description: Location in app from which user triggered this event.
    type: string
    minLength: 1
  #end open_from

  url_properties:
    title: URL properties
    description: Base URL properties to be included with every URL open event.

    type: object
    required: [title, domain, url]
    additionalProperties: false

    properties:
      title:
        title: Title
        description: Title of url opened.
        type: string
        minLength: 1
      #end url_title

      domain:
        title: Domain
        description: Domain of url opened.
        type: string
        format: hostname
      #end Domain

      url:
        title: URL
        desciption: URL opened.
        type: string
        format: uri
      #end URL
    #end properties
  #end url_properties

  message_properties:
    title: Message properties
    description: Base message properties to be included with every message sent to user.
    type: object
    required: [chatterbox_url]
    additionalProperties: false

    properties:
      message_id:
        title: Message ID
        description: ID of message sent to user, can be ignored if link was from outside a chat.
        type: string
        minLength: 1
      #end message_id

      chatterbox_url:
        title: Chatterbox url
        description: Chatterbox url which sent user the link.
        type: string
        format: uri
      #end message_id
    #end properties
  #end message_properties
#end definitions