docs: Add OpenRPC specs for implemented APIs

.github/workflows/ci.yml

@@ -121,7 +121,7 @@ jobs:
               && cmake -B build -S . \
                     -DCMAKE_BUILD_TYPE=Debug \
                     -DENABLE_TESTS=ON \
-              && cp firebolt-open-rpc.json build/test/ \
+              && cp docs/openrpc/the-spec/firebolt-open-rpc.json build/test/ \
             "
 
       - name: Build Project
@@ -246,6 +246,6 @@ jobs:
             ./.github/scripts/run-component-tests.sh \
               --mock /mock \
               --config /workspace/.github/mock-firebolt/config.json \
-              --openrpc /workspace/firebolt-open-rpc.json \
-              --app-openrpc /workspace/.github/openrpc/firebolt-app-open-rpc.json \
+              --openrpc /workspace/docs/openrpc/the-spec/firebolt-open-rpc.json \
+              --app-openrpc /workspace/docs/openrpc/the-spec/firebolt-app-open-rpc.json \
               --test-exe /workspace/build/test/FireboltClientComponentTests

docs/openrpc/.gitignore

@@ -0,0 +1,2 @@
+descriptions/
+node_modules/

docs/openrpc/openrpc/accessibility.json

@@ -0,0 +1,157 @@
+{
+  "openrpc": "1.2.4",
+  "info": {
+    "title": "Accessibility",
+    "version": "0.0.0",
+    "description": "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."
+  },
+  "methods": [
+    {
+      "name": "audioDescription",
+      "summary": "Returns the audio description setting of the device",
+      "params": [],
+      "tags": [
+        {
+          "name": "property:readonly"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:accessibility:audio-descriptions"
+          ]
+        }
+      ],
+      "result": {
+        "name": "setting",
+        "summary": "the audio description setting",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the audio description setting",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": true
+          }
+        }
+      ]
+    },
+    {
+      "name": "closedCaptionsSettings",
+      "summary": "Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference",
+      "params": [],
+      "tags": [
+        {
+          "name": "property:readonly",
+          "x-notifier-params-flattening": "true"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:accessibility:closed-captions"
+          ]
+        }
+      ],
+      "result": {
+        "name": "closedCaptionsSettings",
+        "summary": "the closed captions settings",
+        "schema": {
+          "$ref": "https://meta.comcast.com/firebolt/accessibility#/definitions/ClosedCaptionsSettings"
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the closed captions settings",
+          "params": [],
+          "result": {
+            "name": "settings",
+            "value": {
+              "enabled": true,
+              "preferredLanguages": [
+                "eng",
+                "spa"
+              ]
+            }
+          }
+        }
+      ]
+    },
+    {
+      "name": "highContrastUI",
+      "summary": "Returns the high contrast UI device setting",
+      "params": [],
+      "tags": [
+        {
+          "name": "property:readonly"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:accessibility:high-contrast-ui"
+          ]
+        }
+      ],
+      "result": {
+        "name": "highContrastUI",
+        "summary": "Whether high-contrast UI mode is enabled",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "examples": [
+        {
+          "name": "High-contrast UI mode is enabled",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": true
+          }
+        }
+      ]
+    },
+    {
+      "name": "voiceGuidanceSettings",
+      "summary": "Returns voice guidance settings: enabled, rate, and verbosity",
+      "params": [],
+      "tags": [
+        {
+          "name": "property:readonly",
+          "x-notifier-params-flattening": "true"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:accessibility:voice-guidance"
+          ]
+        }
+      ],
+      "result": {
+        "name": "settings",
+        "summary": "the voice guidance settings",
+        "schema": {
+          "$ref": "https://meta.comcast.com/firebolt/accessibility#/definitions/VoiceGuidanceSettings"
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the voice guidance settings",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "enabled": true,
+              "rate": 0.8,
+              "navigationHints": true
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "components": {
+    "schemas": {}
+  }
+}

docs/openrpc/openrpc/advertising.json

@@ -0,0 +1,99 @@
+{
+  "openrpc": "1.2.4",
+  "info": {
+    "title": "Advertising",
+    "version": "0.0.0",
+    "description": "A module for platform provided advertising settings and functionality."
+  },
+  "methods": [
+    {
+      "name": "advertisingId",
+      "tags": [
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:advertising:identifier"
+          ]
+        }
+      ],
+      "summary": "Returns the IFA.",
+      "params": [],
+      "result": {
+        "name": "advertisingId",
+        "summary": "The advertising ID",
+        "schema": {
+          "$ref": "#/components/schemas/AdvertisingIdResult"
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the advertising ID",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "ifa": "bd87dd10-8d1d-4b93-b1a6-a8e5d410e400",
+              "ifa_type": "sspid",
+              "lmt": "0"
+            }
+          }
+        },
+        {
+          "name": "Getting the advertising ID with scope browse",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "ifa": "bd87dd10-8d1d-4b93-b1a6-a8e5d410e400",
+              "ifa_type": "sspid",
+              "lmt": "1"
+            }
+          }
+        },
+        {
+          "name": "Getting the advertising ID with scope content",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "ifa": "bd87dd10-8d1d-4b93-b1a6-a8e5d410e400",
+              "ifa_type": "idfa",
+              "lmt": "0"
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "components": {
+    "schemas": {
+      "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",
+            "enum": [
+              "0",
+              "1"
+            ],
+            "description": "Boolean that if set to 1, user has requested ad tracking and measurement is disabled"
+          }
+        },
+        "required": [
+          "ifa",
+          "ifa_type",
+          "lmt"
+        ]
+      }
+    }
+  }
+}