fix: Spec and Doc fixes (#302)

* fix: Spec and Doc fixes
rdkcentral · Aug 19, 2024 · 6010a85 · 6010a85
1 parent 9c0cae4
commit 6010a85
Show file tree

Hide file tree

Showing 10 changed files with 284 additions and 131 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git 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
@@ -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
+      }
     }
   }
 }
diff --git 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": [
@@ -197,7 +182,7 @@
             "name": "Default Result",
             "value": {
               "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-              "ifa_type": "idfa",
+              "ifa_type": "sspid",
               "lmt": "0"
             }
           }
@@ -219,7 +204,7 @@
             "name": "Default Result",
             "value": {
               "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-              "ifa_type": "idfa",
+              "ifa_type": "sspid",
               "lmt": "0"
             }
           }
@@ -303,7 +288,7 @@
           "params": [],
           "result": {
             "name": "Default Result",
-            "value": "operator.app"
+            "value": "app.operator"
           }
         }
       ]
@@ -404,6 +389,33 @@
             }
           }
         }
+      },
+      "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"
+        ]
       }
     }
   }

diff --git 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"
+        ]
       }
     }
   }