feat: Added optional parameter 'force' in usergrants.request (#186)

* feat: Added optional parameter 'force' in usergrants.request * Addressed review comments
rdkcentral · Sep 26, 2023 · 31801ca · 31801ca
1 parent 5ac54bd
commit 31801ca
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/openrpc/user_grants.json b/src/openrpc/user_grants.json
@@ -391,6 +391,14 @@
                         "minItems": 1
                     },
                     "required": true
+                },
+                {
+                    "name": "options",
+                    "summary": "Request options",
+                    "schema": {
+                        "$ref": "#/components/schemas/RequestOptions"
+                    },
+                    "required": false
                 }
             ],
             "result": {
@@ -405,7 +413,7 @@
             },
             "examples": [
                 {
-                    "name": "Default result",
+                    "name": "Default result #1",
                     "params": [
                         {
                             "name": "appId",
@@ -436,6 +444,45 @@
                             }
                         ]
                     }
+                },
+                {
+                    "name": "Default result #2",
+                    "params": [
+                        {
+                            "name": "appId",
+                            "value": "certapp"
+                        },
+                        {
+                            "name": "permissions",
+                            "value": [
+                                {
+                                    "role": "use",
+                                    "capability": "xrn:firebolt:capability:localization:postal-code"
+                                }
+                            ]
+                        },
+                        {
+                            "name": "options",
+                            "value": {
+                                "force": true
+                            }
+                        }
+                    ],
+                    "result": {
+                        "name": "defaultResult",
+                        "value": [
+                            {
+                                "app": {
+                                    "id": "certapp",
+                                    "title": "Certification App"
+                                },
+                                "state": "granted",
+                                "capability": "xrn:firebolt:capability:localization:postal-code",
+                                "role": "use",
+                                "lifespan": "powerActive"
+                            }
+                        ]
+                    }
                 }
             ]
         }
@@ -528,6 +575,16 @@
                 },
                 "additionalProperties": false,
                 "required": []
+            },
+            "RequestOptions": {
+                "title": "RequestOptions",
+                "type": "object",
+                "properties": {
+                    "force": {
+                        "type": "boolean",
+                        "description": "Whether to force for user grant even if the previous decision stored"
+                    }
+                }
             }
         }
     }