Channel Entities

Document Status: Proposed Specification

See Firebolt Requirements Governance for more info.

1. Overview

TBD…

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

2. Table of Contents

• 1. Overview
• 2. Table of Contents
• 3. Channel Entities

3. Channel Entities

Every Channel Entity MUST be an Entity.

Every Channel Entity MUST have a const property named entityType, which MUST have the value "channel".

Every Channel Entity MUST have a string property named channelType, whose value MUST be one of:

• "streaming"
• "broadcast"

An example Channel Entity:

{
    "entityType": "channel",
    "channelType": "streaming",
    "entityId": "streaming/xyz"
}

Another example Channel Entity:

{
    "entityType": "channel",
    "channelType": "broadcast",
    "entityId": "broadcast/xyz"
}