fix: Adding assetId back to spec

rdkcentral · Aug 23, 2023 · 7d298a0 · 7d298a0
1 parent be435d9
commit 7d298a0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/requirements/specifications/entities/index.md b/requirements/specifications/entities/index.md
@@ -23,6 +23,8 @@ Every Entity **MUST** be of type `object`.
 
 Every Entity object **MUST** have a `string` property named `entityId`, which identifies the entity. The scope of entity identifiers **SHOULD** be defined by the app providing or receiving the Entity, so that the App may work across Firebolt distrubutions without mapping IDs from a distributor space to the App's space.
 
+Every Entity object **MAY** have a `string` property named `assetId`, which disambiguates the asset from the entity, if needed. The scope of asset identifiers **SHOULD** be defined by the app providing or receiving the Entity, so that the App may work across Firebolt distrubutions without mapping IDs from a distributor space to the App's space.
+
 Every Entity object **MAY** have a `string` property named `appContentData`, limited to 256 characters, which provides additional information useful for targeting that Entity, e.g. a deeplink path.
 
 An example Entity:
@@ -38,6 +40,7 @@ Another example Entity:
 ```json
 {
     "entityId": "entity/abc",
+    "assetId": "asset/123",
     "appContentData": "xyz"
 }
 ```

diff --git a/requirements/specifications/intents/play.md b/requirements/specifications/intents/play.md
@@ -1,6 +1,6 @@
 # Play Intent
 
-Document Status: Working Draft
+Document Status: Candidate Specification
 
 See [Firebolt Requirements Governance](../../governance.md) for more info.
 
@@ -18,8 +18,6 @@ Apps will need to be able to play specific entities from a back-office meta-data
 
 The existing Firebolt `playback` intent does not meet these requirements. This document outlines a more flexible `play-entity` and `play-query` intent to replace it.
 
-TODO: 
-
 ## 2. Table of Contents
 - [1. Overview](#1-overview)
 - [2. Table of Contents](#2-table-of-contents)