From 38b0acf4fb874a61f734bface5795adda0984521 Mon Sep 17 00:00:00 2001 From: shanmugasundaramraj_kasirajan Date: Tue, 23 Apr 2024 17:14:01 +0530 Subject: [PATCH 1/2] RDK-49128 - Add Documentation for "Age" Parameter in Warehouse Plugin isClean API Signed-off-by: shanmugasundaramraj_kasirajan --- Warehouse/Warehouse.json | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Warehouse/Warehouse.json b/Warehouse/Warehouse.json index 9260855062..0c0e77ce7a 100644 --- 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 for the isClean checkup that were created/updated before age in seconds", + "type": "integer", + "example": "10" + } + }, + "required": [] + }, "result": { "type": "object", "properties": { @@ -298,4 +309,4 @@ } } } -} \ No newline at end of file +} From f6b76a1a635a27cdca7d865e2c59be9e0e61bc97 Mon Sep 17 00:00:00 2001 From: shanmugasundaramraj_kasirajan Date: Wed, 24 Apr 2024 12:29:13 +0530 Subject: [PATCH 2/2] RDK-49128 - Add Documentation for "Age" Parameter in Warehouse Plugin isClean API - updated as per review comments. Signed-off-by: shanmugasundaramraj_kasirajan --- Warehouse/Warehouse.json | 4 ++-- docs/api/WarehousePlugin.md | 10 ++++++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Warehouse/Warehouse.json b/Warehouse/Warehouse.json index 0c0e77ce7a..9d73b2d134 100644 --- a/Warehouse/Warehouse.json +++ b/Warehouse/Warehouse.json @@ -162,9 +162,9 @@ "type":"object", "properties": { "age": { - "summary": "Ignore files for the isClean checkup that were created/updated before age in seconds", + "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": "10" + "example": "300" } }, "required": [] diff --git a/docs/api/WarehousePlugin.md b/docs/api/WarehousePlugin.md index 50c3ab456e..1b2b503168 100644 --- 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 | *(optional)* 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 + } } ```