From 61f255cdfd85a6b6b04a9da79de29b50b615bf18 Mon Sep 17 00:00:00 2001 From: Your Name Date: Wed, 18 Sep 2024 17:39:42 +0000 Subject: [PATCH] chore: Publish pr-feature-mfos-run-manage-discovery --- .../core/Device/index.md | 34 ++++---- .../core/Discovery/index.md | 85 ------------------- .../firebolt-core-open-rpc.json | 77 +++++------------ .../specifications/firebolt-open-rpc.json | 77 +++++------------ .../firebolt-specification.json | 77 +++++------------ 5 files changed, 87 insertions(+), 263 deletions(-) diff --git a/apis/pr-feature-mfos-run-manage-discovery/core/Device/index.md b/apis/pr-feature-mfos-run-manage-discovery/core/Device/index.md index 9cc3287b..ad7c8581 100644 --- a/apis/pr-feature-mfos-run-manage-discovery/core/Device/index.md +++ b/apis/pr-feature-mfos-run-manage-discovery/core/Device/index.md @@ -307,18 +307,18 @@ Capabilities: #### Examples -Getting the supported HDCP versions +Getting the negotiated HDCP versions JavaScript: ```javascript import { Device } from '@firebolt-js/sdk' -let supportedHdcpVersions = await Device.hdcp() -console.log(supportedHdcpVersions) +let negotiatedHdcpVersions = await Device.hdcp() +console.log(negotiatedHdcpVersions) ``` -Value of `supportedHdcpVersions`: +Value of `negotiatedHdcpVersions`: ```javascript { @@ -371,7 +371,7 @@ number #### Examples -Getting the supported HDCP versions +Getting the negotiated HDCP versions JavaScript: @@ -384,7 +384,7 @@ let listenerId = await hdcp((value) => { console.log(listenerId) ``` -Value of `supportedHdcpVersions`: +Value of `negotiatedHdcpVersions`: ```javascript { @@ -427,7 +427,9 @@ Response: ### hdr -Get the negotiated HDR formats for the connected display and device +Get the negotiated HDR formats for the connected display and device. + +For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles. To get the value of `hdr` call the method like this: @@ -447,18 +449,18 @@ Capabilities: #### Examples -Getting the supported HDR formats +Getting the negotiated HDR formats JavaScript: ```javascript import { Device } from '@firebolt-js/sdk' -let supportedHdrFormats = await Device.hdr() -console.log(supportedHdrFormats) +let negotiatedHdrFormats = await Device.hdr() +console.log(negotiatedHdrFormats) ``` -Value of `supportedHdrFormats`: +Value of `negotiatedHdrFormats`: ```javascript { @@ -515,7 +517,7 @@ number #### Examples -Getting the supported HDR formats +Getting the negotiated HDR formats JavaScript: @@ -528,7 +530,7 @@ let listenerId = await hdr((value) => { console.log(listenerId) ``` -Value of `supportedHdrFormats`: +Value of `negotiatedHdrFormats`: ```javascript { @@ -1231,7 +1233,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio ### platform -Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms. +Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms. To get the value of `platform` call the method like this: @@ -2011,7 +2013,7 @@ NetworkType: { ### HDRFormatMap -The type of HDR format that is supported +The type of HDR format ```typescript type HDRFormatMap = { @@ -2101,7 +2103,7 @@ See also: ### HDCPVersionMap -The type of HDCP versions that is supported +The type of HDCP versions ```typescript type HDCPVersionMap = { diff --git a/apis/pr-feature-mfos-run-manage-discovery/core/Discovery/index.md b/apis/pr-feature-mfos-run-manage-discovery/core/Discovery/index.md index 9ff06401..80ff7d4e 100644 --- a/apis/pr-feature-mfos-run-manage-discovery/core/Discovery/index.md +++ b/apis/pr-feature-mfos-run-manage-discovery/core/Discovery/index.md @@ -2501,91 +2501,6 @@ Response: -Launch the Aggregated Experience to it's search screen. - -JavaScript: - -```javascript -import { Discovery } from '@firebolt-js/sdk' - -let success = await Discovery.launch('xrn:firebolt:application-type:main', { - action: 'search', - data: { - query: 'a cool show', - suggestions: [ - { - entityType: 'program', - programType: 'movie', - entityId: 'xyz', - }, - { - entityType: 'music', - musicType: 'song', - entityId: 'abc', - }, - ], - }, - context: { - source: 'voice', - }, -}) -console.log(success) -``` - -Value of `success`: - -```javascript -true -``` - -
-JSON-RPC: -Request: - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "Discovery.launch", - "params": { - "appId": "xrn:firebolt:application-type:main", - "intent": { - "action": "search", - "data": { - "query": "a cool show", - "suggestions": [ - { - "entityType": "program", - "programType": "movie", - "entityId": "xyz" - }, - { - "entityType": "music", - "musicType": "song", - "entityId": "abc" - } - ] - }, - "context": { - "source": "voice" - } - } - } -} -``` - -Response: - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": true -} -``` - -
- --- ### listen diff --git a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-core-open-rpc.json b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-core-open-rpc.json index d337f511..ba4aebf2 100644 --- a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-core-open-rpc.json +++ b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-core-open-rpc.json @@ -2033,7 +2033,7 @@ }, { "name": "Device.platform", - "summary": "Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", + "summary": "Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", "params": [], "tags": [ { @@ -2307,15 +2307,15 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "$ref": "#/components/schemas/HDCPVersionMap" } }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [], "result": { "name": "Default Result", @@ -2329,7 +2329,7 @@ }, { "name": "Device.hdr", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [], "tags": [ { @@ -2343,15 +2343,15 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "$ref": "#/components/schemas/HDRFormatMap" } }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [], "result": { "name": "Default Result", @@ -2416,6 +2416,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -2710,8 +2713,8 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "anyOf": [ { @@ -2725,7 +2728,7 @@ }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [ { "name": "listen", @@ -2744,7 +2747,7 @@ }, { "name": "Device.onHdrChanged", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [ { "name": "listen", @@ -2771,8 +2774,8 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "anyOf": [ { @@ -2786,7 +2789,7 @@ }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [ { "name": "listen", @@ -2894,6 +2897,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -4295,43 +4301,6 @@ "name": "success", "value": true } - }, - { - "name": "Launch the Aggregated Experience to it's search screen.", - "params": [ - { - "name": "appId", - "value": "xrn:firebolt:application-type:main" - }, - { - "name": "intent", - "value": { - "action": "search", - "data": { - "query": "a cool show", - "suggestions": [ - { - "entityType": "program", - "programType": "movie", - "entityId": "xyz" - }, - { - "entityType": "music", - "musicType": "song", - "entityId": "abc" - } - ] - }, - "context": { - "source": "voice" - } - } - } - ], - "result": { - "name": "success", - "value": true - } } ] }, @@ -8650,7 +8619,7 @@ "dolbyVision", "hlg" ], - "description": "The type of HDR format that is supported" + "description": "The type of HDR format" }, "HDCPVersionMap": { "title": "HDCPVersionMap", @@ -8667,7 +8636,7 @@ "hdcp1.4", "hdcp2.2" ], - "description": "The type of HDCP versions that is supported" + "description": "The type of HDCP versions" }, "DeviceVersion": { "title": "DeviceVersion", diff --git a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-open-rpc.json b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-open-rpc.json index 82cb620a..1aee1fe8 100644 --- a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-open-rpc.json +++ b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-open-rpc.json @@ -5817,7 +5817,7 @@ }, { "name": "Device.platform", - "summary": "Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", + "summary": "Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", "params": [], "tags": [ { @@ -6091,15 +6091,15 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "$ref": "#/components/schemas/HDCPVersionMap" } }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [], "result": { "name": "Default Result", @@ -6113,7 +6113,7 @@ }, { "name": "Device.hdr", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [], "tags": [ { @@ -6127,15 +6127,15 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "$ref": "#/components/schemas/HDRFormatMap" } }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [], "result": { "name": "Default Result", @@ -6200,6 +6200,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -6579,8 +6582,8 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "anyOf": [ { @@ -6594,7 +6597,7 @@ }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [ { "name": "listen", @@ -6613,7 +6616,7 @@ }, { "name": "Device.onHdrChanged", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [ { "name": "listen", @@ -6640,8 +6643,8 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "anyOf": [ { @@ -6655,7 +6658,7 @@ }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [ { "name": "listen", @@ -6763,6 +6766,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -8224,43 +8230,6 @@ "name": "success", "value": true } - }, - { - "name": "Launch the Aggregated Experience to it's search screen.", - "params": [ - { - "name": "appId", - "value": "xrn:firebolt:application-type:main" - }, - { - "name": "intent", - "value": { - "action": "search", - "data": { - "query": "a cool show", - "suggestions": [ - { - "entityType": "program", - "programType": "movie", - "entityId": "xyz" - }, - { - "entityType": "music", - "musicType": "song", - "entityId": "abc" - } - ] - }, - "context": { - "source": "voice" - } - } - } - ], - "result": { - "name": "success", - "value": true - } } ] }, @@ -18882,7 +18851,7 @@ "dolbyVision", "hlg" ], - "description": "The type of HDR format that is supported" + "description": "The type of HDR format" }, "HDCPVersionMap": { "title": "HDCPVersionMap", @@ -18899,7 +18868,7 @@ "hdcp1.4", "hdcp2.2" ], - "description": "The type of HDCP versions that is supported" + "description": "The type of HDCP versions" }, "DeviceVersion": { "title": "DeviceVersion", diff --git a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-specification.json b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-specification.json index 772b5423..d47d3f9b 100644 --- a/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-specification.json +++ b/requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-specification.json @@ -6757,7 +6757,7 @@ }, { "name": "Device.platform", - "summary": "Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", + "summary": "Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.", "params": [], "tags": [ { @@ -7031,15 +7031,15 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "$ref": "#/components/schemas/HDCPVersionMap" } }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [], "result": { "name": "Default Result", @@ -7053,7 +7053,7 @@ }, { "name": "Device.hdr", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [], "tags": [ { @@ -7067,15 +7067,15 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "$ref": "#/components/schemas/HDRFormatMap" } }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [], "result": { "name": "Default Result", @@ -7140,6 +7140,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -7519,8 +7522,8 @@ } ], "result": { - "name": "supportedHdcpVersions", - "summary": "the supported HDCP versions", + "name": "negotiatedHdcpVersions", + "summary": "the negotiated HDCP versions", "schema": { "anyOf": [ { @@ -7534,7 +7537,7 @@ }, "examples": [ { - "name": "Getting the supported HDCP versions", + "name": "Getting the negotiated HDCP versions", "params": [ { "name": "listen", @@ -7553,7 +7556,7 @@ }, { "name": "Device.onHdrChanged", - "summary": "Get the negotiated HDR formats for the connected display and device", + "summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [ { "name": "listen", @@ -7580,8 +7583,8 @@ } ], "result": { - "name": "supportedHdrFormats", - "summary": "the supported HDR formats", + "name": "negotiatedHdrFormats", + "summary": "the negotiated HDR formats", "schema": { "anyOf": [ { @@ -7595,7 +7598,7 @@ }, "examples": [ { - "name": "Getting the supported HDR formats", + "name": "Getting the negotiated HDR formats", "params": [ { "name": "listen", @@ -7703,6 +7706,9 @@ "x-uses": [ "xrn:firebolt:capability:device:info" ] + }, + { + "name": "deprecated" } ], "result": { @@ -9164,43 +9170,6 @@ "name": "success", "value": true } - }, - { - "name": "Launch the Aggregated Experience to it's search screen.", - "params": [ - { - "name": "appId", - "value": "xrn:firebolt:application-type:main" - }, - { - "name": "intent", - "value": { - "action": "search", - "data": { - "query": "a cool show", - "suggestions": [ - { - "entityType": "program", - "programType": "movie", - "entityId": "xyz" - }, - { - "entityType": "music", - "musicType": "song", - "entityId": "abc" - } - ] - }, - "context": { - "source": "voice" - } - } - } - ], - "result": { - "name": "success", - "value": true - } } ] }, @@ -19822,7 +19791,7 @@ "dolbyVision", "hlg" ], - "description": "The type of HDR format that is supported" + "description": "The type of HDR format" }, "HDCPVersionMap": { "title": "HDCPVersionMap", @@ -19839,7 +19808,7 @@ "hdcp1.4", "hdcp2.2" ], - "description": "The type of HDCP versions that is supported" + "description": "The type of HDCP versions" }, "DeviceVersion": { "title": "DeviceVersion",