fix: Reverted PR 197 and 201

rdkcentral · Aug 21, 2024 · d399e46 · d399e46
1 parent aa6a09b
commit d399e46
Showing 1 changed file with 89 additions and 0 deletions.
diff --git a/src/openrpc/device.json b/src/openrpc/device.json
@@ -270,6 +270,95 @@
         }
       ]
     },
+    {
+      "name": "version",
+      "summary": "Get the SDK, OS and other version info",
+      "params": [],
+      "tags": [
+        {
+          "name": "exclude-from-sdk"
+        },
+        {
+          "name": "property:immutable"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:device:info"
+          ]
+        }
+      ],
+      "result": {
+        "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"
+          ]
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the os and sdk versions",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "sdk": {
+                "major": 0,
+                "minor": 8,
+                "patch": 0,
+                "readable": "Firebolt JS SDK v0.8.0"
+              },
+              "api": {
+                "major": 0,
+                "minor": 8,
+                "patch": 0,
+                "readable": "Firebolt API v0.8.0"
+              },
+              "firmware": {
+                "major": 1,
+                "minor": 2,
+                "patch": 3,
+                "readable": "Device Firmware v1.2.3"
+              },
+              "os": {
+                "major": 0,
+                "minor": 1,
+                "patch": 0,
+                "readable": "Firebolt OS v0.1.0"
+              },
+              "debug": "Non-parsable build info for error logging only."
+            }
+          }
+        }
+      ]
+    },
     {
       "name": "hdcp",
       "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.",