Merge pull request rdkcentral#5222 from Shanmugasundaramraj24/main/RD…

…K-49128 RDK-49128 - Add Documentation for "Age" Parameter in Warehouse Plugin isClean API
nhanasi · Apr 30, 2024 · 6296082 · 6296082
2 parents cfe69eb + f6b76a1
commit 6296082
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/Warehouse/Warehouse.json b/Warehouse/Warehouse.json
@@ -158,6 +158,17 @@
         },
         "isClean":{
             "summary": "Checks the locations on the device where customer data may be stored. If there are contents contained in those folders, then the device is not clean.",
+	    "params": {
+                "type":"object",
+                "properties": {
+                    "age": {
+                        "summary": "Ignore files/folders for the isClean checkup that were created/updated within the last age (in seconds) when this API is called",
+                        "type": "integer",
+                        "example": "300"
+                    }
+                },
+                "required": []
+            },
             "result": {
                 "type": "object",
                 "properties": {
@@ -298,4 +309,4 @@
             }
         }
     }
-}
+}
diff --git a/docs/api/WarehousePlugin.md b/docs/api/WarehousePlugin.md
@@ -282,7 +282,10 @@ No Events
 
 ### Parameters
 
-This method takes no parameters.
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params?.age | integer | <sup>*(optional)*</sup> Ignore files/folders for the isClean checkup that were created/updated within the last age (in seconds) when this API is called |
 
 ### Result
 
@@ -302,7 +305,10 @@ This method takes no parameters.
 {
     "jsonrpc": "2.0",
     "id": 42,
-    "method": "org.rdk.Warehouse.isClean"
+    "method": "org.rdk.Warehouse.isClean",
+    "params": {
+        "age": 300
+    }
 }
 ```