From DeviceMetadata.schema.yaml (ratatoskr/DeviceMetadata.schema
)
---
$id: https://skeleton.botmd.io/ratatoskr/DeviceMetadata.schema
$schema: http://json-schema.org/draft-07/schema#
title: Device Metadata
description: >-
`Device.metadata` is common across providers and will be used by us for differentiating between types of devices.
type: object
additionalProperties: false
required: [channel]
properties:
platform:
title: Platform
description: Used to distinguish between mobile users and desktop users. We don't differentiate between web mobile and web desktop users at this time.
type: string
enum: [mobile, web]
channel:
title: Channel
description: The messaging platform/system.
type: string
enum: [native, sms, line, messenger, telegram, wechat, web, whatsapp, viber, email]
os:
title: Operating system
description: The operating system the user is on. Not set when on a non-native messaging platform.
type: string
enum: [android, ios, windows, linux, mac]
application:
title: Application
description: The name of the application accessing the server.
type: string
enum: [hospital, cleo, einstein, other]
version:
title: Application Version
description: An integer representing the version of the application.
type: integer
minimum: 1
maximum: 2
browser:
title: Browser
description: The type of browser the user is on. Only applicable when `platform` is `web`.
type: string
enum: [safari, chrome, msie, opera]
is_subscribed:
title: Is Subscribed?
description: The subscription status of this device.
type: boolean
#end properties