From 143f863a5cb11e4d811cb961b1c79ddef248c018 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Wed, 14 Aug 2024 12:03:57 -0400 Subject: [PATCH 1/8] fix: Spec and Doc fixes for Release 1.3.1 --- package-lock.json | 6 +- src/json/firebolt-specification.json | 3 - src/openrpc/_internal.json | 24 +- src/openrpc/advertising.json | 44 ++-- src/openrpc/authentication.json | 36 +-- src/openrpc/device.json | 247 ++++++++++++++----- src/schemas/accessibility.json | 6 +- src/schemas/types.json | 2 - src/sdks/core/sdk.config.json | 2 +- src/sdks/core/test/suite/advertising.test.ts | 2 +- 10 files changed, 251 insertions(+), 121 deletions(-) diff --git a/package-lock.json b/package-lock.json index 42027e562..87fbc63cd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16962,7 +16962,7 @@ }, "src/sdks/core": { "name": "@firebolt-js/sdk", - "version": "1.3.0-next.3", + "version": "1.3.0", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", @@ -16973,7 +16973,7 @@ }, "src/sdks/discovery": { "name": "@firebolt-js/discovery-sdk", - "version": "1.3.0-next.3", + "version": "1.3.0", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", @@ -16984,7 +16984,7 @@ }, "src/sdks/manage": { "name": "@firebolt-js/manage-sdk", - "version": "1.3.0-next.3", + "version": "1.3.0", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", diff --git a/src/json/firebolt-specification.json b/src/json/firebolt-specification.json index 13f662b93..568f4b9e4 100644 --- a/src/json/firebolt-specification.json +++ b/src/json/firebolt-specification.json @@ -147,9 +147,6 @@ "negotiable": false } }, - "xrn:firebolt:capability:privacy:advertising": { - "level": "could" - }, "xrn:firebolt:capability:metrics:distributor": { "level": "could" }, diff --git a/src/openrpc/_internal.json b/src/openrpc/_internal.json index 7f04a6dc1..a04b45e79 100644 --- a/src/openrpc/_internal.json +++ b/src/openrpc/_internal.json @@ -35,15 +35,7 @@ "name": "session", "summary": "Info about the SDK/FEE session", "schema": { - "type": "object", - "required": ["version"], - "properties": { - "version": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The semantic version of the FEE." - } - }, - "additionalProperties": false + "$ref": "#/components/schemas/InitializeResult" } }, "examples": [ @@ -76,7 +68,19 @@ } ], "components": { - "schemas": { + "schemas": { + "InitializeResult": { + "title": "InitializeResult", + "type": "object", + "required": ["version"], + "properties": { + "version": { + "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", + "description": "The semantic version of the FEE." + } + }, + "additionalProperties": false + } } } } \ No newline at end of file diff --git a/src/openrpc/advertising.json b/src/openrpc/advertising.json index 22a86b312..aeb9f8769 100644 --- a/src/openrpc/advertising.json +++ b/src/openrpc/advertising.json @@ -81,8 +81,7 @@ { "name": "capabilities", "x-uses": [ - "xrn:firebolt:capability:privacy:advertising", - "xrn:firebolt:capability:advertising:configuration" + "xrn:firebolt:capability:advertising:policy" ] } ], @@ -157,7 +156,7 @@ ] } ], - "summary": "Get the advertising ID", + "summary": "Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings.", "params": [ { "name": "options", @@ -172,21 +171,7 @@ "name": "advertisingId", "summary": "the advertising ID", "schema": { - "type": "object", - "properties": { - "ifa": { - "type": "string" - }, - "ifa_type": { - "type": "string" - }, - "lmt": { - "type": "string" - } - }, - "required": [ - "ifa" - ] + "$ref": "#/components/schemas/AdvertisingIdResult" } }, "examples": [ @@ -303,7 +288,7 @@ "params": [], "result": { "name": "Default Result", - "value": "operator.app" + "value": "app.operator" } } ] @@ -404,6 +389,27 @@ } } } + }, + "AdvertisingIdResult": { + "title": "AdvertisingIdResult", + "type": "object", + "properties": { + "ifa": { + "type": "string", + "description": "UUID conforming to IAB standard" + }, + "ifa_type": { + "type": "string", + "description": "source of the IFA as defined by IAB" + }, + "lmt": { + "type": "string", + "description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled" + } + }, + "required": [ + "ifa" + ] } } } diff --git a/src/openrpc/authentication.json b/src/openrpc/authentication.json index 18a633183..977846b46 100644 --- a/src/openrpc/authentication.json +++ b/src/openrpc/authentication.json @@ -44,22 +44,7 @@ "name": "token", "summary": "the token value, type, and expiration", "schema": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "expires": { - "type": "string", - "format": "date-time" - }, - "type": { - "type": "string" - } - }, - "required": [ - "value" - ] + "$ref": "#/components/schemas/AuthenticationTokenResult" } }, "examples": [ @@ -233,6 +218,25 @@ "device", "distributor" ] + }, + "AuthenticationTokenResult": { + "title": "AuthenticationTokenResult", + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "expires": { + "type": "string", + "format": "date-time" + }, + "type": { + "type": "string" + } + }, + "required": [ + "value" + ] } } } diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 04cdced4d..0db106f4c 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -292,34 +292,7 @@ "name": "versions", "summary": "the versions", "schema": { - "type": "object", - "properties": { - "sdk": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The Firebolt SDK version" - }, - "api": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The lateset Firebolt API version supported by the curent device." - }, - "firmware": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The device firmware version." - }, - "os": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "**Deprecated** Use `firmware`, instead." - }, - "debug": { - "type": "string", - "description": "Detail version as a string, for debugging purposes" - } - }, - "required": [ - "api", - "firmware", - "os" - ] + "$ref": "#/components/schemas/HDCPType" } }, "examples": [ @@ -378,7 +351,7 @@ "name": "supportedHdcpProfiles", "summary": "the supported HDCP profiles", "schema": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/BooleanMap" + "$ref": "#/components/schemas/HDCPType" } }, "examples": [ @@ -414,7 +387,7 @@ "name": "supportedHdrProfiles", "summary": "the supported HDR profiles", "schema": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/BooleanMap" + "$ref": "#/components/schemas/HDRType" } }, "examples": [ @@ -435,7 +408,7 @@ }, { "name": "audio", - "summary": "Get the supported audio profiles", + "summary": "Get the supported audio profiles for the connected devices. \n\n It is not recommended to use this API for visual badging on content within your app since this does not reflect the settings of the user. \n\n **Note:** This method is planned to be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -473,7 +446,7 @@ }, { "name": "screenResolution", - "summary": "Get the current screen resolution", + "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -509,7 +482,7 @@ }, { "name": "videoResolution", - "summary": "Get the current video resolution", + "summary": "Get the maximum supported video resolution of the currently connected device and display. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -641,19 +614,7 @@ "name": "networkInfo", "summary": "the status and type", "schema": { - "type": "object", - "properties": { - "state": { - "$ref": "#/components/schemas/NetworkState" - }, - "type": { - "$ref": "#/components/schemas/NetworkType" - } - }, - "required": [ - "state", - "type" - ] + "$ref": "#/components/schemas/NetworkInfoResult" } }, "examples": [ @@ -759,18 +720,98 @@ "components": { "schemas": { "Resolution": { - "type": "array", - "items": [ + "oneOf": [ + { + "type": "array", + "items": [ + { + "type": "integer", + "const": 720, + "description": "Width in pixels" + }, + { + "type": "integer", + "const": 480, + "description": "Height in pixels" + } + ], + "additionalItems": false, + "minItems": 2, + "maxItems": 2 + }, { - "type": "integer" + "type": "array", + "items": [ + { + "type": "integer", + "const": 720, + "description": "Width in pixels" + }, + { + "type": "integer", + "const": 576, + "description": "Height in pixels" + } + ], + "additionalItems": false, + "minItems": 2, + "maxItems": 2 }, { - "type": "integer" + "type": "array", + "items": [ + { + "type": "integer", + "const": 1280, + "description": "Width in pixels" + }, + { + "type": "integer", + "const": 720, + "description": "Height in pixels" + } + ], + "additionalItems": false, + "minItems": 2, + "maxItems": 2 + }, + { + "type": "array", + "items": [ + { + "type": "integer", + "const": 1920, + "description": "Width in pixels" + }, + { + "type": "integer", + "const": 1080, + "description": "Height in pixels" + } + ], + "additionalItems": false, + "minItems": 2, + "maxItems": 2 + }, + { + "type": "array", + "items": [ + { + "type": "integer", + "const": 3840, + "description": "Width in pixels" + }, + { + "type": "integer", + "const": 2160, + "description": "Height in pixels" + } + ], + "additionalItems": false, + "minItems": 2, + "maxItems": 2 } - ], - "additionalItems": false, - "minItems": 2, - "maxItems": 2 + ] }, "NetworkType": { "title": "NetworkType", @@ -793,16 +834,98 @@ }, "AudioProfiles": { "title": "AudioProfiles", - "allOf": [ - { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/BooleanMap" + "properties": { + "stereo": { + "type": "boolean" }, - { - "type": "object", - "propertyNames": { - "$ref": "https://meta.comcast.com/firebolt/types#/definitions/AudioProfile" - } + "dolbyDigital5.1": { + "type": "boolean" + }, + "dolbyDigital5.1+": { + "type": "boolean" + }, + "dolbyAtmos": { + "type": "boolean" + } + } + }, + "HDRType": { + "title": "HDRType", + "type": "object", + "properties": { + "hdr10": { + "type": "boolean" + }, + "hdr10plus": { + "type": "boolean" + }, + "dolbyVision": { + "type": "boolean" + }, + "hlg": { + "type": "boolean" + } + }, + "description": "The type of HDR that is supported" + }, + "HDCPType": { + "title": "HDCPType", + "type": "object", + "properties": { + "hdcp1.4": { + "type": "boolean" + }, + "hdcp2.2": { + "type": "boolean" } + }, + "description": "The type of HDCP that is supported" + }, + "DeviceVersion": { + "title": "DeviceVersion", + "type": "object", + "properties": { + "sdk": { + "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", + "description": "The Firebolt SDK version" + }, + "api": { + "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", + "description": "The lateset Firebolt API version supported by the curent device." + }, + "firmware": { + "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", + "description": "The device firmware version." + }, + "os": { + "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", + "description": "**Deprecated** Use `firmware`, instead." + }, + "debug": { + "type": "string", + "description": "Detail version as a string, for debugging purposes" + } + }, + "required": [ + "api", + "firmware", + "os" + ] + }, + "NetworkInfoResult": { + "title": "NetworkInfoResult", + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/NetworkState" + }, + "type": { + "$ref": "#/components/schemas/NetworkType" + } + }, + "required": [ + "state", + "type" ] } } diff --git a/src/schemas/accessibility.json b/src/schemas/accessibility.json index ce6ad419a..e274d8b91 100644 --- a/src/schemas/accessibility.json +++ b/src/schemas/accessibility.json @@ -100,8 +100,7 @@ "title": "ClosedCaptionsSettings", "type": "object", "required": [ - "enabled", - "styles" + "enabled" ], "properties": { "enabled": { @@ -152,8 +151,7 @@ "title": "VoiceGuidanceSettings", "type": "object", "required": [ - "enabled", - "speed" + "enabled" ], "properties": { "enabled": { diff --git a/src/schemas/types.json b/src/schemas/types.json index 0caa49c1f..5d5eed60e 100644 --- a/src/schemas/types.json +++ b/src/schemas/types.json @@ -36,9 +36,7 @@ "enum": [ "stereo", "dolbyDigital5.1", - "dolbyDigital7.1", "dolbyDigital5.1+", - "dolbyDigital7.1+", "dolbyAtmos" ] }, diff --git a/src/sdks/core/sdk.config.json b/src/sdks/core/sdk.config.json index 14ba4d55c..f34bf72c8 100644 --- a/src/sdks/core/sdk.config.json +++ b/src/sdks/core/sdk.config.json @@ -23,7 +23,7 @@ "use": [ "xrn:firebolt:capability:advertising:configuration", "xrn:firebolt:capability:advertising:identifier", - "xrn:firebolt:capability:privacy:advertising" + "xrn:firebolt:capability:advertising:policy" ] }, { diff --git a/src/sdks/core/test/suite/advertising.test.ts b/src/sdks/core/test/suite/advertising.test.ts index 95ec53e77..9f788abd4 100644 --- a/src/sdks/core/test/suite/advertising.test.ts +++ b/src/sdks/core/test/suite/advertising.test.ts @@ -50,7 +50,7 @@ test("deviceAttributes()", () => { test("appBundleId()", () => { return Advertising.appBundleId().then((res: string) => { - expect(res).toBe("operator.app"); + expect(res).toBe("app.operator"); expect(typeof res).toBe("string"); }); }); From 09a309b20373dcdef0a2cb9018de07f0ac3648ac Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Wed, 14 Aug 2024 14:29:33 -0400 Subject: [PATCH 2/8] fix: Addressed review comments --- src/openrpc/device.json | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 0db106f4c..f4a588372 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -292,7 +292,7 @@ "name": "versions", "summary": "the versions", "schema": { - "$ref": "#/components/schemas/HDCPType" + "$ref": "#/components/schemas/DeviceVersion" } }, "examples": [ @@ -446,7 +446,7 @@ }, { "name": "screenResolution", - "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -856,7 +856,7 @@ "hdr10": { "type": "boolean" }, - "hdr10plus": { + "hdr10Plus": { "type": "boolean" }, "dolbyVision": { @@ -866,6 +866,12 @@ "type": "boolean" } }, + "required": [ + "hdr10", + "hdr10Plus", + "dolbyVision", + "hlg" + ], "description": "The type of HDR that is supported" }, "HDCPType": { @@ -879,6 +885,10 @@ "type": "boolean" } }, + "required": [ + "hdcp1.4", + "hdcp2.2" + ], "description": "The type of HDCP that is supported" }, "DeviceVersion": { From bc82d26a3a3ed8a86ebe2b9cfcf556804b6bcc09 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Wed, 14 Aug 2024 15:14:35 -0400 Subject: [PATCH 3/8] fix: Addressed review comments --- src/openrpc/advertising.json | 8 +++++++- src/openrpc/device.json | 23 +++++++++++++++-------- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/src/openrpc/advertising.json b/src/openrpc/advertising.json index aeb9f8769..496832597 100644 --- a/src/openrpc/advertising.json +++ b/src/openrpc/advertising.json @@ -404,11 +404,17 @@ }, "lmt": { "type": "string", + "enum": [ + "0", + "1" + ], "description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled" } }, "required": [ - "ifa" + "ifa", + "ifa_type", + "lmt" ] } } diff --git a/src/openrpc/device.json b/src/openrpc/device.json index f4a588372..b3f26a949 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -351,7 +351,7 @@ "name": "supportedHdcpProfiles", "summary": "the supported HDCP profiles", "schema": { - "$ref": "#/components/schemas/HDCPType" + "$ref": "#/components/schemas/HDCPVersion" } }, "examples": [ @@ -387,7 +387,7 @@ "name": "supportedHdrProfiles", "summary": "the supported HDR profiles", "schema": { - "$ref": "#/components/schemas/HDRType" + "$ref": "#/components/schemas/HDRFormat" } }, "examples": [ @@ -834,6 +834,7 @@ }, "AudioProfiles": { "title": "AudioProfiles", + "type": "object", "properties": { "stereo": { "type": "boolean" @@ -847,10 +848,16 @@ "dolbyAtmos": { "type": "boolean" } - } + }, + "required": [ + "stereo", + "dolbyDigital5.1", + "dolbyDigital5.1+", + "dolbyAtmos" + ] }, - "HDRType": { - "title": "HDRType", + "HDRFormat": { + "title": "HDRFormat", "type": "object", "properties": { "hdr10": { @@ -874,8 +881,8 @@ ], "description": "The type of HDR that is supported" }, - "HDCPType": { - "title": "HDCPType", + "HDCPVersion": { + "title": "HDCPVersion", "type": "object", "properties": { "hdcp1.4": { @@ -901,7 +908,7 @@ }, "api": { "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The lateset Firebolt API version supported by the curent device." + "description": "The latest Firebolt API version supported by the current device." }, "firmware": { "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", From 4815927ea720985d252b45104e65384f02d039c4 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Wed, 14 Aug 2024 16:35:49 -0400 Subject: [PATCH 4/8] fix: Removed deprecation notes --- src/openrpc/device.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index b3f26a949..e8604bb56 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -408,7 +408,7 @@ }, { "name": "audio", - "summary": "Get the supported audio profiles for the connected devices. \n\n It is not recommended to use this API for visual badging on content within your app since this does not reflect the settings of the user. \n\n **Note:** This method is planned to be deprecated with a future Firebolt release", + "summary": "Get the supported audio profiles for the connected devices. \n\n It is not recommended to use this API for visual badging on content within your app since this does not reflect the settings of the user.", "params": [], "tags": [ { @@ -446,7 +446,7 @@ }, { "name": "screenResolution", - "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080]", "params": [], "tags": [ { @@ -482,7 +482,7 @@ }, { "name": "videoResolution", - "summary": "Get the maximum supported video resolution of the currently connected device and display. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported video resolution of the currently connected device and display. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080]", "params": [], "tags": [ { From bc0f82dfbcaf8bb147314f48a5ccd95e451dcfd5 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Wed, 14 Aug 2024 17:00:34 -0400 Subject: [PATCH 5/8] fix: Few more description changes --- src/openrpc/device.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index e8604bb56..ba36ad3a4 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -334,7 +334,7 @@ }, { "name": "hdcp", - "summary": "Get the supported HDCP profiles", + "summary": "Get the negotiated HDCP profiles for a connected device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.", "params": [], "tags": [ { @@ -370,7 +370,7 @@ }, { "name": "hdr", - "summary": "Get the supported HDR profiles", + "summary": "Get the negotiated HDR formats for the connected display and device", "params": [], "tags": [ { @@ -912,7 +912,7 @@ }, "firmware": { "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", - "description": "The device firmware version." + "description": "The firmware version as reported by the device" }, "os": { "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion", @@ -920,7 +920,7 @@ }, "debug": { "type": "string", - "description": "Detail version as a string, for debugging purposes" + "description": "Detailed version as a string, for debugging purposes" } }, "required": [ From efc596eb1036ca410510c3c2095f4f86fbd075c5 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Thu, 15 Aug 2024 12:11:05 -0400 Subject: [PATCH 6/8] fix: Description fix --- src/openrpc/advertising.json | 4 ++-- src/openrpc/device.json | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/openrpc/advertising.json b/src/openrpc/advertising.json index 496832597..20235446e 100644 --- a/src/openrpc/advertising.json +++ b/src/openrpc/advertising.json @@ -182,7 +182,7 @@ "name": "Default Result", "value": { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } } @@ -204,7 +204,7 @@ "name": "Default Result", "value": { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } } diff --git a/src/openrpc/device.json b/src/openrpc/device.json index ba36ad3a4..024a2a32e 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -348,15 +348,15 @@ } ], "result": { - "name": "supportedHdcpProfiles", - "summary": "the supported HDCP profiles", + "name": "supportedHdcpVersions", + "summary": "the supported HDCP versions", "schema": { "$ref": "#/components/schemas/HDCPVersion" } }, "examples": [ { - "name": "Getting the supported HDCP profiles", + "name": "Getting the supported HDCP versions", "params": [], "result": { "name": "Default Result", @@ -384,15 +384,15 @@ } ], "result": { - "name": "supportedHdrProfiles", - "summary": "the supported HDR profiles", + "name": "supportedHdrFormats", + "summary": "the supported HDR formats", "schema": { "$ref": "#/components/schemas/HDRFormat" } }, "examples": [ { - "name": "Getting the supported HDR profiles", + "name": "Getting the supported HDR formats", "params": [], "result": { "name": "Default Result", @@ -446,7 +446,7 @@ }, { "name": "screenResolution", - "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080]", + "summary": "Get the resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [3840, 2160]", "params": [], "tags": [ { @@ -482,7 +482,7 @@ }, { "name": "videoResolution", - "summary": "Get the maximum supported video resolution of the currently connected device and display. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080]", + "summary": "Get the maximum supported video resolution of the currently connected device and display. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [3840, 2160]", "params": [], "tags": [ { From 16673cdac0e482ecad9bee20e90bc9ebab034d83 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Mon, 19 Aug 2024 14:37:10 -0400 Subject: [PATCH 7/8] fix: Changed schema component name for HDCP and HDR --- src/openrpc/device.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 024a2a32e..bab86e260 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -351,7 +351,7 @@ "name": "supportedHdcpVersions", "summary": "the supported HDCP versions", "schema": { - "$ref": "#/components/schemas/HDCPVersion" + "$ref": "#/components/schemas/HDCPVersionMap" } }, "examples": [ @@ -387,7 +387,7 @@ "name": "supportedHdrFormats", "summary": "the supported HDR formats", "schema": { - "$ref": "#/components/schemas/HDRFormat" + "$ref": "#/components/schemas/HDRFormatMap" } }, "examples": [ @@ -856,8 +856,8 @@ "dolbyAtmos" ] }, - "HDRFormat": { - "title": "HDRFormat", + "HDRFormatMap": { + "title": "HDRFormatMap", "type": "object", "properties": { "hdr10": { @@ -881,8 +881,8 @@ ], "description": "The type of HDR that is supported" }, - "HDCPVersion": { - "title": "HDCPVersion", + "HDCPVersionMap": { + "title": "HDCPVersionMap", "type": "object", "properties": { "hdcp1.4": { From ba5826a5c6280ff8cce671442e8fcc34710b05e3 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Mon, 19 Aug 2024 14:41:24 -0400 Subject: [PATCH 8/8] fix: Component description change --- src/openrpc/device.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index bab86e260..0dd8e11b4 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -879,7 +879,7 @@ "dolbyVision", "hlg" ], - "description": "The type of HDR that is supported" + "description": "The type of HDR format that is supported" }, "HDCPVersionMap": { "title": "HDCPVersionMap", @@ -896,7 +896,7 @@ "hdcp1.4", "hdcp2.2" ], - "description": "The type of HDCP that is supported" + "description": "The type of HDCP versions that is supported" }, "DeviceVersion": { "title": "DeviceVersion",