From b12908c0281e865bb3c8b671a26d91fd087a1273 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 19 Feb 2024 21:15:50 +0000 Subject: [PATCH] chore: Publish pr-major-device --- .../core/Accessibility/index.md | 2 +- apis/pr-major-device/core/Account/index.md | 2 +- .../pr-major-device/core/Advertising/index.md | 2 +- .../core/Authentication/index.md | 2 +- .../core/Capabilities/index.md | 2 +- apis/pr-major-device/core/Device/index.md | 2 +- apis/pr-major-device/core/Discovery/index.md | 2 +- .../core/Intents/schemas/index.md | 49 +++++--- apis/pr-major-device/core/Internal/index.md | 2 +- apis/pr-major-device/core/Keyboard/index.md | 2 +- apis/pr-major-device/core/Lifecycle/index.md | 2 +- .../core/Localization/index.md | 2 +- apis/pr-major-device/core/Metrics/index.md | 2 +- apis/pr-major-device/core/Parameters/index.md | 2 +- apis/pr-major-device/core/Profile/index.md | 2 +- .../core/SecondScreen/index.md | 2 +- .../core/SecureStorage/index.md | 2 +- apis/pr-major-device/core/changelog.md | 9 +- apis/pr-major-device/manage/Account/index.md | 2 +- .../manage/AcknowledgeChallenge/index.md | 2 +- .../manage/Advertising/index.md | 2 +- .../manage/AudioDescriptions/index.md | 2 +- .../manage/ClosedCaptions/index.md | 2 +- apis/pr-major-device/manage/Device/index.md | 2 +- .../pr-major-device/manage/Discovery/index.md | 2 +- .../pr-major-device/manage/HDMIInput/index.md | 2 +- .../manage/Intents/schemas/index.md | 49 +++++--- apis/pr-major-device/manage/Keyboard/index.md | 2 +- .../manage/Localization/index.md | 2 +- apis/pr-major-device/manage/Metrics/index.md | 2 +- .../manage/PinChallenge/index.md | 2 +- apis/pr-major-device/manage/Privacy/index.md | 2 +- .../manage/SecureStorage/index.md | 2 +- .../manage/UserGrants/index.md | 2 +- .../manage/VoiceGuidance/index.md | 2 +- apis/pr-major-device/manage/Wifi/index.md | 2 +- apis/pr-major-device/manage/changelog.md | 12 +- .../device/device-information/index.md | 4 + .../device/syndication-ontology/index.md | 117 ++++++++++++++++++ .../specifications/firebolt-open-rpc.json | 28 ++++- .../firebolt-specification.json | 46 +++++-- 41 files changed, 306 insertions(+), 74 deletions(-) create mode 100644 requirements/pr-major-device/specifications/device/syndication-ontology/index.md diff --git a/apis/pr-major-device/core/Accessibility/index.md b/apis/pr-major-device/core/Accessibility/index.md index 60c7a0ff3..3c592e38b 100644 --- a/apis/pr-major-device/core/Accessibility/index.md +++ b/apis/pr-major-device/core/Accessibility/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Accessibility 1.1.0-major-device.0 +Version Accessibility 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Account/index.md b/apis/pr-major-device/core/Account/index.md index f58e176e8..b0b1a0392 100644 --- a/apis/pr-major-device/core/Account/index.md +++ b/apis/pr-major-device/core/Account/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Account 1.1.0-major-device.0 +Version Account 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Advertising/index.md b/apis/pr-major-device/core/Advertising/index.md index 08625c283..83a09bdbf 100644 --- a/apis/pr-major-device/core/Advertising/index.md +++ b/apis/pr-major-device/core/Advertising/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Advertising 1.1.0-major-device.0 +Version Advertising 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Authentication/index.md b/apis/pr-major-device/core/Authentication/index.md index 17b7d5362..80fe29b4b 100644 --- a/apis/pr-major-device/core/Authentication/index.md +++ b/apis/pr-major-device/core/Authentication/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Authentication 1.1.0-major-device.0 +Version Authentication 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Capabilities/index.md b/apis/pr-major-device/core/Capabilities/index.md index b2a9474de..e627fe687 100644 --- a/apis/pr-major-device/core/Capabilities/index.md +++ b/apis/pr-major-device/core/Capabilities/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Capabilities 1.1.0-major-device.0 +Version Capabilities 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Device/index.md b/apis/pr-major-device/core/Device/index.md index 5f498d274..0af2c9dcf 100644 --- a/apis/pr-major-device/core/Device/index.md +++ b/apis/pr-major-device/core/Device/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Device 1.1.0-major-device.0 +Version Device 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Discovery/index.md b/apis/pr-major-device/core/Discovery/index.md index 6b4eaf41b..01b4d50d0 100644 --- a/apis/pr-major-device/core/Discovery/index.md +++ b/apis/pr-major-device/core/Discovery/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Discovery 1.1.0-major-device.0 +Version Discovery 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Intents/schemas/index.md b/apis/pr-major-device/core/Intents/schemas/index.md index cba0433b3..62595e205 100644 --- a/apis/pr-major-device/core/Intents/schemas/index.md +++ b/apis/pr-major-device/core/Intents/schemas/index.md @@ -24,14 +24,15 @@ Version Intents 0.0.0-unknown.0 - [SearchIntent](#searchintent) - [SectionIntent](#sectionintent) - [ChannelEntity](#channelentity) - - [AdditionalEntity](#additionalentity) + - [MusicEntity](#musicentity) - [PlayQueryIntent](#playqueryintent) - [HomeIntent](#homeintent) - [LaunchIntent](#launchintent) - [TVSeriesEntity](#tvseriesentity) - - [MovieEntity](#movieentity) + - [AdditionalEntity](#additionalentity) - [TVSeasonEntity](#tvseasonentity) - [UntypedEntity](#untypedentity) + - [MovieEntity](#movieentity) - [TVEpisodeEntity](#tvepisodeentity) - [EntityIntent](#entityintent) - [PlaylistEntity](#playlistentity) @@ -147,21 +148,19 @@ type ChannelEntity = { --- -### AdditionalEntity +### MusicEntity ```typescript -type AdditionalEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. +type MusicEntity = { + entityType: 'music' + musicType: MusicType // In the case of a music `entityType`, specifies the type of music entity. entityId: string - assetId?: string - appContentData?: string } ``` See also: -[ProgramEntity](#programentity) +'song' | 'album' --- @@ -240,12 +239,12 @@ See also: --- -### MovieEntity +### AdditionalEntity ```typescript -type MovieEntity = { +type AdditionalEntity = { entityType: 'program' - programType: 'movie' + programType: ProgramType // In the case of a program `entityType`, specifies the program type. entityId: string assetId?: string appContentData?: string @@ -291,6 +290,24 @@ type UntypedEntity = { --- +### MovieEntity + +```typescript +type MovieEntity = { + entityType: 'program' + programType: 'movie' + entityId: string + assetId?: string + appContentData?: string +} +``` + +See also: + +[ProgramEntity](#programentity) + +--- + ### TVEpisodeEntity ```typescript @@ -323,6 +340,7 @@ type EntityIntent = { | TVEpisodeEntity | TVSeriesEntity | TVSeasonEntity + | MusicEntity | AdditionalEntity | UntypedEntity context: { @@ -337,6 +355,7 @@ See also: [TVEpisodeEntity](#tvepisodeentity) [TVSeriesEntity](#tvseriesentity) [TVSeasonEntity](#tvseasonentity) +[MusicEntity](#musicentity) [AdditionalEntity](#additionalentity) [UntypedEntity](#untypedentity) @@ -391,6 +410,7 @@ type PlayableEntity = | MovieEntity | TVEpisodeEntity | PlaylistEntity + | MusicEntity | AdditionalEntity ``` @@ -399,6 +419,7 @@ See also: [MovieEntity](#movieentity) [TVEpisodeEntity](#tvepisodeentity) [PlaylistEntity](#playlistentity) +[MusicEntity](#musicentity) [AdditionalEntity](#additionalentity) --- @@ -419,7 +440,7 @@ type PlaybackIntent = { See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | AdditionalEntity +MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity --- @@ -445,7 +466,7 @@ type PlayEntityIntent = { See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | AdditionalEntity +MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity --- diff --git a/apis/pr-major-device/core/Internal/index.md b/apis/pr-major-device/core/Internal/index.md index 0f6e8371a..f0bb6f7a8 100644 --- a/apis/pr-major-device/core/Internal/index.md +++ b/apis/pr-major-device/core/Internal/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Internal 1.1.0-major-device.0 +Version Internal 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Keyboard/index.md b/apis/pr-major-device/core/Keyboard/index.md index b3d97d2de..64139ca0a 100644 --- a/apis/pr-major-device/core/Keyboard/index.md +++ b/apis/pr-major-device/core/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Keyboard 1.1.0-major-device.0 +Version Keyboard 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Lifecycle/index.md b/apis/pr-major-device/core/Lifecycle/index.md index f21751a2f..d9e4bcdec 100644 --- a/apis/pr-major-device/core/Lifecycle/index.md +++ b/apis/pr-major-device/core/Lifecycle/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Lifecycle 1.1.0-major-device.0 +Version Lifecycle 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Localization/index.md b/apis/pr-major-device/core/Localization/index.md index e28e281ff..aa74c8d1e 100644 --- a/apis/pr-major-device/core/Localization/index.md +++ b/apis/pr-major-device/core/Localization/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Localization 1.1.0-major-device.0 +Version Localization 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Metrics/index.md b/apis/pr-major-device/core/Metrics/index.md index 1b4a83cd3..2c9699540 100644 --- a/apis/pr-major-device/core/Metrics/index.md +++ b/apis/pr-major-device/core/Metrics/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Metrics 1.1.0-major-device.0 +Version Metrics 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Parameters/index.md b/apis/pr-major-device/core/Parameters/index.md index 39e7a2a9b..15941edf9 100644 --- a/apis/pr-major-device/core/Parameters/index.md +++ b/apis/pr-major-device/core/Parameters/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Parameters 1.1.0-major-device.0 +Version Parameters 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/Profile/index.md b/apis/pr-major-device/core/Profile/index.md index 0877f4d0f..9d9c1dd15 100644 --- a/apis/pr-major-device/core/Profile/index.md +++ b/apis/pr-major-device/core/Profile/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Profile 1.1.0-major-device.0 +Version Profile 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/SecondScreen/index.md b/apis/pr-major-device/core/SecondScreen/index.md index 7b7cb4ab8..77c6a6531 100644 --- a/apis/pr-major-device/core/SecondScreen/index.md +++ b/apis/pr-major-device/core/SecondScreen/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecondScreen 1.1.0-major-device.0 +Version SecondScreen 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/SecureStorage/index.md b/apis/pr-major-device/core/SecureStorage/index.md index 14d0fa36e..0477701e1 100644 --- a/apis/pr-major-device/core/SecureStorage/index.md +++ b/apis/pr-major-device/core/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecureStorage 1.1.0-major-device.0 +Version SecureStorage 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/core/changelog.md b/apis/pr-major-device/core/changelog.md index bf302c517..16ac6e10c 100644 --- a/apis/pr-major-device/core/changelog.md +++ b/apis/pr-major-device/core/changelog.md @@ -5,7 +5,14 @@ version: pr-major-device layout: default sdk: core --- -# 1.0.0 (https://github.com/rdkcentral/firebolt-apis/compare/v0.17.1...v1.0.0) (2023-11-03) +# [1.1.0](https://github.com/rdkcentral/firebolt-apis/compare/v1.0.0...v1.1.0) (2024-02-09) + +### Bug Fixes + + * Add Music to Playable entities (#225 (https://github.com/rdkcentral/firebolt-apis/issues/225)) (22c9b71 (https://github.com/rdkcentral/firebolt-apis/commit/22c9b71d3c0ee98d32585d1b365afabf8e64d6ed)) + * Modified account:uid to SHOULD (#224 (https://github.com/rdkcentral/firebolt-apis/issues/224)) (70c8b24 (https://github.com/rdkcentral/firebolt-apis/commit/70c8b24decfcbff2c32fb1b0d21290afc00a8432)) + +# [1.0.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.17.1...v1.0.0) (2023-11-03) Upgraded to 1.0 at part of RDK6 release. This API is still compatibile with 0.x versions. diff --git a/apis/pr-major-device/manage/Account/index.md b/apis/pr-major-device/manage/Account/index.md index 44d6e05c8..c6b975c4c 100644 --- a/apis/pr-major-device/manage/Account/index.md +++ b/apis/pr-major-device/manage/Account/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Account 1.1.0-major-device.0 +Version Account 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/AcknowledgeChallenge/index.md b/apis/pr-major-device/manage/AcknowledgeChallenge/index.md index bc200511e..dc83b8513 100644 --- a/apis/pr-major-device/manage/AcknowledgeChallenge/index.md +++ b/apis/pr-major-device/manage/AcknowledgeChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AcknowledgeChallenge 1.1.0-major-device.0 +Version AcknowledgeChallenge 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Advertising/index.md b/apis/pr-major-device/manage/Advertising/index.md index 2a510fac2..388b664f9 100644 --- a/apis/pr-major-device/manage/Advertising/index.md +++ b/apis/pr-major-device/manage/Advertising/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Advertising 1.1.0-major-device.0 +Version Advertising 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/AudioDescriptions/index.md b/apis/pr-major-device/manage/AudioDescriptions/index.md index 9c97b0403..7f889129d 100644 --- a/apis/pr-major-device/manage/AudioDescriptions/index.md +++ b/apis/pr-major-device/manage/AudioDescriptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AudioDescriptions 1.1.0-major-device.0 +Version AudioDescriptions 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/ClosedCaptions/index.md b/apis/pr-major-device/manage/ClosedCaptions/index.md index 3eecc7730..9b10158f8 100644 --- a/apis/pr-major-device/manage/ClosedCaptions/index.md +++ b/apis/pr-major-device/manage/ClosedCaptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version ClosedCaptions 1.1.0-major-device.0 +Version ClosedCaptions 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Device/index.md b/apis/pr-major-device/manage/Device/index.md index d78905707..9d1d48afc 100644 --- a/apis/pr-major-device/manage/Device/index.md +++ b/apis/pr-major-device/manage/Device/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Device 1.1.0-major-device.0 +Version Device 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Discovery/index.md b/apis/pr-major-device/manage/Discovery/index.md index fe7fc0623..89e06f0c7 100644 --- a/apis/pr-major-device/manage/Discovery/index.md +++ b/apis/pr-major-device/manage/Discovery/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Discovery 1.1.0-major-device.0 +Version Discovery 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/HDMIInput/index.md b/apis/pr-major-device/manage/HDMIInput/index.md index 295d09e9f..26ca29fee 100644 --- a/apis/pr-major-device/manage/HDMIInput/index.md +++ b/apis/pr-major-device/manage/HDMIInput/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version HDMIInput 1.1.0-major-device.0 +Version HDMIInput 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Intents/schemas/index.md b/apis/pr-major-device/manage/Intents/schemas/index.md index ff2544875..e96144e03 100644 --- a/apis/pr-major-device/manage/Intents/schemas/index.md +++ b/apis/pr-major-device/manage/Intents/schemas/index.md @@ -24,14 +24,15 @@ Version Intents 0.0.0-unknown.0 - [SearchIntent](#searchintent) - [SectionIntent](#sectionintent) - [ChannelEntity](#channelentity) - - [AdditionalEntity](#additionalentity) + - [MusicEntity](#musicentity) - [PlayQueryIntent](#playqueryintent) - [HomeIntent](#homeintent) - [LaunchIntent](#launchintent) - [TVSeriesEntity](#tvseriesentity) - - [MovieEntity](#movieentity) + - [AdditionalEntity](#additionalentity) - [TVSeasonEntity](#tvseasonentity) - [UntypedEntity](#untypedentity) + - [MovieEntity](#movieentity) - [TVEpisodeEntity](#tvepisodeentity) - [EntityIntent](#entityintent) - [PlaylistEntity](#playlistentity) @@ -147,21 +148,19 @@ type ChannelEntity = { --- -### AdditionalEntity +### MusicEntity ```typescript -type AdditionalEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. +type MusicEntity = { + entityType: 'music' + musicType: MusicType // In the case of a music `entityType`, specifies the type of music entity. entityId: string - assetId?: string - appContentData?: string } ``` See also: -[ProgramEntity](#programentity) +'song' | 'album' --- @@ -240,12 +239,12 @@ See also: --- -### MovieEntity +### AdditionalEntity ```typescript -type MovieEntity = { +type AdditionalEntity = { entityType: 'program' - programType: 'movie' + programType: ProgramType // In the case of a program `entityType`, specifies the program type. entityId: string assetId?: string appContentData?: string @@ -291,6 +290,24 @@ type UntypedEntity = { --- +### MovieEntity + +```typescript +type MovieEntity = { + entityType: 'program' + programType: 'movie' + entityId: string + assetId?: string + appContentData?: string +} +``` + +See also: + +[ProgramEntity](#programentity) + +--- + ### TVEpisodeEntity ```typescript @@ -323,6 +340,7 @@ type EntityIntent = { | TVEpisodeEntity | TVSeriesEntity | TVSeasonEntity + | MusicEntity | AdditionalEntity | UntypedEntity context: { @@ -337,6 +355,7 @@ See also: [TVEpisodeEntity](#tvepisodeentity) [TVSeriesEntity](#tvseriesentity) [TVSeasonEntity](#tvseasonentity) +[MusicEntity](#musicentity) [AdditionalEntity](#additionalentity) [UntypedEntity](#untypedentity) @@ -391,6 +410,7 @@ type PlayableEntity = | MovieEntity | TVEpisodeEntity | PlaylistEntity + | MusicEntity | AdditionalEntity ``` @@ -399,6 +419,7 @@ See also: [MovieEntity](#movieentity) [TVEpisodeEntity](#tvepisodeentity) [PlaylistEntity](#playlistentity) +[MusicEntity](#musicentity) [AdditionalEntity](#additionalentity) --- @@ -419,7 +440,7 @@ type PlaybackIntent = { See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | AdditionalEntity +MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity --- @@ -445,7 +466,7 @@ type PlayEntityIntent = { See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | AdditionalEntity +MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity --- diff --git a/apis/pr-major-device/manage/Keyboard/index.md b/apis/pr-major-device/manage/Keyboard/index.md index 64aaebf13..f0793bfdc 100644 --- a/apis/pr-major-device/manage/Keyboard/index.md +++ b/apis/pr-major-device/manage/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Keyboard 1.1.0-major-device.0 +Version Keyboard 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Localization/index.md b/apis/pr-major-device/manage/Localization/index.md index 3463ae551..6d1e775f2 100644 --- a/apis/pr-major-device/manage/Localization/index.md +++ b/apis/pr-major-device/manage/Localization/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Localization 1.1.0-major-device.0 +Version Localization 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Metrics/index.md b/apis/pr-major-device/manage/Metrics/index.md index 33e62444d..eab348424 100644 --- a/apis/pr-major-device/manage/Metrics/index.md +++ b/apis/pr-major-device/manage/Metrics/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Metrics 1.1.0-major-device.0 +Version Metrics 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/PinChallenge/index.md b/apis/pr-major-device/manage/PinChallenge/index.md index 662545095..0e9a5f47e 100644 --- a/apis/pr-major-device/manage/PinChallenge/index.md +++ b/apis/pr-major-device/manage/PinChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version PinChallenge 1.1.0-major-device.0 +Version PinChallenge 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Privacy/index.md b/apis/pr-major-device/manage/Privacy/index.md index ce90cc078..ed14aea8b 100644 --- a/apis/pr-major-device/manage/Privacy/index.md +++ b/apis/pr-major-device/manage/Privacy/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Privacy 1.1.0-major-device.0 +Version Privacy 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/SecureStorage/index.md b/apis/pr-major-device/manage/SecureStorage/index.md index a52d2f3b1..b77180466 100644 --- a/apis/pr-major-device/manage/SecureStorage/index.md +++ b/apis/pr-major-device/manage/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version SecureStorage 1.1.0-major-device.0 +Version SecureStorage 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/UserGrants/index.md b/apis/pr-major-device/manage/UserGrants/index.md index 0a2c7c02e..49ff92be2 100644 --- a/apis/pr-major-device/manage/UserGrants/index.md +++ b/apis/pr-major-device/manage/UserGrants/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version UserGrants 1.1.0-major-device.0 +Version UserGrants 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/VoiceGuidance/index.md b/apis/pr-major-device/manage/VoiceGuidance/index.md index b2c3eea25..4e6ab8e25 100644 --- a/apis/pr-major-device/manage/VoiceGuidance/index.md +++ b/apis/pr-major-device/manage/VoiceGuidance/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version VoiceGuidance 1.1.0-major-device.0 +Version VoiceGuidance 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/Wifi/index.md b/apis/pr-major-device/manage/Wifi/index.md index 1b986dca2..e53220f6e 100644 --- a/apis/pr-major-device/manage/Wifi/index.md +++ b/apis/pr-major-device/manage/Wifi/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Wifi 1.1.0-major-device.0 +Version Wifi 1.1.1-major-device.0 ## Table of Contents diff --git a/apis/pr-major-device/manage/changelog.md b/apis/pr-major-device/manage/changelog.md index 3583fb846..fb10ec131 100644 --- a/apis/pr-major-device/manage/changelog.md +++ b/apis/pr-major-device/manage/changelog.md @@ -5,7 +5,17 @@ version: pr-major-device layout: default sdk: manage --- -# 1.0.0 (https://github.com/rdkcentral/firebolt-apis/compare/v0.17.1...v1.0.0) (2023-11-03) +# [1.1.0](https://github.com/rdkcentral/firebolt-apis/compare/v1.0.0...v1.1.0) (2024-02-09) + +### Bug Fixes + + * Modified account:uid to SHOULD (#224 (https://github.com/rdkcentral/firebolt-apis/issues/224)) (70c8b24 (https://github.com/rdkcentral/firebolt-apis/commit/70c8b24decfcbff2c32fb1b0d21290afc00a8432)) + +### Features + + * HDMI Low Latency Mode (#156 (https://github.com/rdkcentral/firebolt-apis/issues/156)) (06d3624 (https://github.com/rdkcentral/firebolt-apis/commit/06d3624b69ee0529d4c1a1c78a15dbfdf54c8b16)) + +# [1.0.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.17.1...v1.0.0) (2023-11-03) Upgraded to 1.0 at part of RDK6 release. This API is still compatibile with 0.x versions. diff --git a/requirements/pr-major-device/specifications/device/device-information/index.md b/requirements/pr-major-device/specifications/device/device-information/index.md index 5bca14bdd..8d6054189 100644 --- a/requirements/pr-major-device/specifications/device/device-information/index.md +++ b/requirements/pr-major-device/specifications/device/device-information/index.md @@ -23,6 +23,8 @@ See [Firebolt Requirements Governance](../../../governance) for more info. ## 1. Overview This document outlines the requirements for ontological, intrinsic, and product-related device indentification APIs. +**TODO**: add capabilities to all APIs + 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](https://www.rfc-editor.org/rfc/rfc2119.txt) [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. ## 2. Table of Contents @@ -63,6 +65,8 @@ This API will likely only be permitted to fisrt-party apps and **MUST** only be The value of this **MUST** be unique within a distributor. +This API requires `use` access to the `xrn:firebolt:capability:device:identification` capability. + **NOTE**: we probably need a registry of Firebolt distributors to avoid collisions. ### 3.2. Anonymized Device Identifier diff --git a/requirements/pr-major-device/specifications/device/syndication-ontology/index.md b/requirements/pr-major-device/specifications/device/syndication-ontology/index.md new file mode 100644 index 000000000..757297c1f --- /dev/null +++ b/requirements/pr-major-device/specifications/device/syndication-ontology/index.md @@ -0,0 +1,117 @@ +--- + +version: pr-major-device +layout: default +title: Syndication SDK +category: requirements +type: specification +--- +# Syndication SDK + +Document Status: Working Draft + +See [Firebolt Requirements Governance](../../../governance) for more info. + +| Contributor | Organization | +| --------------- | -------------- | +| Jeremy LaCivita | Comcast | +| Peter Yu | Comcast | + +## 1. Overview +This document outlines the requirements for ontological, intrinsic, and product-related device indentification APIs. + +**TODO**: add capabilities to all APIs + +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](https://www.rfc-editor.org/rfc/rfc2119.txt) [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. + +## 2. Table of Contents +- [1. Overview](#1-overview) +- [2. Table of Contents](#2-table-of-contents) +- [3. Ontology](#3-ontology) + - [3.1. OS Class](#31-os-class) + - [3.2. Leased](#32-leased) + - [3.3. Experience](#33-experience) + - [3.4. Account Type](#34-account-type) + - [3.5. Account Sub Type](#35-account-sub-type) + - [3.6. Programmer](#36-programmer) + - [3.7. Retailer](#37-retailer) + +## 3. Ontology +The Syndication Extension SDK **MUST** expose an `Ontology` module to contain the APIs outlined below. + +### 3.1. OS Class +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `osClass` property that returns what software and bootstrap configuration needs to be loaded on the device for a given operator. + +This property **MUST** be readable by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +This property **MUST** be read/write and have a setter available to any app with `manage` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value **SHOULD** be set during device activation by a 1st party setup experience. + +Examples values: + +- `entos-rdk-residential` +- `entos-rdk-commercial` +- `skyq-rdk` +- `xre-rdk` +- `flex-rdk` + +### 3.2. Leased +The `Ontology` module of the Syndication Extension SDK **MUST** have a boolean `leased` property that returns whether or not the device is leased by the customer (true) or owned (false). + +This property **MUST** be readable by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +This property **MUST** be read/write and have a setter available to any app with `manage` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value **SHOULD** be set during device activation by a 1st party setup experience. + +### 3.3. Experience +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `experienceAppId` property that returns the appId of the primary aggregated experience app, aka "launcher", aka EPG, installed on this device. + +This property **MUST** be readable by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +This property **MUST** be read/write and have a setter available to any app with `manage` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value **SHOULD** be set during device activation by a 1st party setup experience. + +**TODO**: is app id okay here? what if a Firebolt app is using this API and is running on a different distribution platform w/ different app ids? + +### 3.4. Account Type +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `accountType` property that returns the type of account that is active on this device, e.g. `"residential"` or `"business"`. + +This property **MUST** be read only by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value of this property **MUST** be configurable as a pass-through provider and may be provided by an App, a middleware component, or a cloud REST API. + +See [Cloud Pass-through Providers](#) for more info. + +### 3.5. Account Sub Type +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `accountSubType` property that returns the type of account that is active on this device, e.g. `"hospitality"` or `"university"`. + +This property **MUST** be read only by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value of this property **MUST** be configurable as a pass-through provider and may be provided by an App, a middleware component, or a cloud REST API. + +See [Cloud Pass-through Providers](#) for more info. + +### 3.6. Programmer +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `programmerId` property that returns the ID of the partner that is providing programming to the primary aggregated experience. + +This property **MUST** be readable by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +This property **MUST** be read/write and have a setter available to any app with `manage` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value **SHOULD** be set during device activation by a 1st party setup experience. + +**TODO**: What is the scope of these ids? + +### 3.7. Retailer +The `Ontology` module of the Syndication Extension SDK **MUST** have a string `retailerId` property that returns the ID of the partner that initially retailed the device. + +This property **MUST** be readable by any app with `use` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +This property **MUST** be read/write and have a setter available to any app with `manage` access to the `xrn:firebolt:capability:syndication:ontology` capability. + +The value **SHOULD** be set during device activation by a 1st party setup experience. + +**TODO**: What is the scope of these ids? diff --git a/requirements/pr-major-device/specifications/firebolt-open-rpc.json b/requirements/pr-major-device/specifications/firebolt-open-rpc.json index 33e59074a..e5af8fc00 100644 --- a/requirements/pr-major-device/specifications/firebolt-open-rpc.json +++ b/requirements/pr-major-device/specifications/firebolt-open-rpc.json @@ -2,7 +2,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.1.0-major-device.0", + "version": "1.1.1-major-device.0", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -20195,6 +20195,9 @@ { "$ref": "#/x-schemas/Intents/TVSeasonEntity" }, + { + "$ref": "#/x-schemas/Intents/MusicEntity" + }, { "$ref": "#/x-schemas/Intents/AdditionalEntity" }, @@ -20862,6 +20865,26 @@ } ] }, + "MusicEntity": { + "title": "MusicEntity", + "type": "object", + "properties": { + "entityType": { + "const": "music" + }, + "musicType": { + "$ref": "#/x-schemas/Entertainment/MusicType" + }, + "entityId": { + "type": "string" + } + }, + "required": [ + "entityType", + "musicType", + "entityId" + ] + }, "AdditionalEntity": { "title": "AdditionalEntity", "allOf": [ @@ -20956,6 +20979,9 @@ { "$ref": "#/x-schemas/Intents/PlaylistEntity" }, + { + "$ref": "#/x-schemas/Intents/MusicEntity" + }, { "$ref": "#/x-schemas/Intents/AdditionalEntity" } diff --git a/requirements/pr-major-device/specifications/firebolt-specification.json b/requirements/pr-major-device/specifications/firebolt-specification.json index 5cf61da3c..fc3985fc7 100644 --- a/requirements/pr-major-device/specifications/firebolt-specification.json +++ b/requirements/pr-major-device/specifications/firebolt-specification.json @@ -456,22 +456,22 @@ "negotiable": false } }, - "xrn:firebolt:capability:accessibility:audiodescriptions": { - "level": "must", + "xrn:firebolt:capability:account:uid": { + "level": "should", "use": { "public": true, "negotiable": true }, "manage": { - "public": true, - "negotiable": true + "public": false, + "negotiable": false }, "provide": { "public": false, "negotiable": false } }, - "xrn:firebolt:capability:accessibility:closedcaptions": { + "xrn:firebolt:capability:accessibility:audiodescriptions": { "level": "must", "use": { "public": true, @@ -486,7 +486,7 @@ "negotiable": false } }, - "xrn:firebolt:capability:accessibility:voiceguidance": { + "xrn:firebolt:capability:accessibility:closedcaptions": { "level": "must", "use": { "public": true, @@ -501,15 +501,15 @@ "negotiable": false } }, - "xrn:firebolt:capability:account:uid": { + "xrn:firebolt:capability:accessibility:voiceguidance": { "level": "must", "use": { "public": true, "negotiable": true }, "manage": { - "public": false, - "negotiable": false + "public": true, + "negotiable": true }, "provide": { "public": false, @@ -912,7 +912,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.1.0-major-device.0", + "version": "1.1.1-major-device.0", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -21105,6 +21105,9 @@ { "$ref": "#/x-schemas/Intents/TVSeasonEntity" }, + { + "$ref": "#/x-schemas/Intents/MusicEntity" + }, { "$ref": "#/x-schemas/Intents/AdditionalEntity" }, @@ -21772,6 +21775,26 @@ } ] }, + "MusicEntity": { + "title": "MusicEntity", + "type": "object", + "properties": { + "entityType": { + "const": "music" + }, + "musicType": { + "$ref": "#/x-schemas/Entertainment/MusicType" + }, + "entityId": { + "type": "string" + } + }, + "required": [ + "entityType", + "musicType", + "entityId" + ] + }, "AdditionalEntity": { "title": "AdditionalEntity", "allOf": [ @@ -21866,6 +21889,9 @@ { "$ref": "#/x-schemas/Intents/PlaylistEntity" }, + { + "$ref": "#/x-schemas/Intents/MusicEntity" + }, { "$ref": "#/x-schemas/Intents/AdditionalEntity" }