fix: Added deprecation note in screen resolution method (#323)

rdkcentral · Sep 20, 2024 · e146c43 · e146c43
1 parent d9a8ac6
commit e146c43
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/openrpc/device.json b/src/openrpc/device.json
@@ -446,7 +446,7 @@
     },
     {
       "name": "screenResolution",
-      "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]",
+      "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] \n\n**Deprecated:** Use non-Firebolt APIs specific to your platform, e.g. W3C APIs",
       "params": [],
       "tags": [
         {
@@ -459,7 +459,9 @@
           ]
         },
         {
-          "name": "deprecated"
+          "name": "deprecated",
+          "x-alternative": "Use non-Firebolt APIs specific to your platform, e.g. W3C APIs",
+          "x-since": "1.4.0"
         }
       ],
       "result": {