Skip to content

Commit 003beba

Browse files
authored
RDKEMW-4187: Missing error response string in the isClean method (#194)
* RDKEMW-4187: Missing error response string in the isClean method of the Warehouse plugin Reason for change: Added error response string in the isClean method Test Procedure: Test isClean method Risks: Medium Priority: P1 Signed-off-by:Dineshkumar P [email protected] * Update WarehousePlugin.md * Update Warehouse.json
1 parent 283e0ce commit 003beba

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

apis/Warehouse/IWarehouse.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ namespace WPEFramework
8080
// @param clean - out - boolean
8181
// @param files - out - string [] of file locations for each file
8282
// @param success - out - boolean
83-
virtual Core::hresult IsClean(const int age, bool &clean /* @out */, IStringIterator*& files /* @out */, bool &success /* @out */) = 0;
83+
// @param error -out - string
84+
virtual Core::hresult IsClean(const int age, bool &clean /* @out */, IStringIterator*& files /* @out */, bool &success /* @out */, string& error /* @out */) = 0;
8485

8586
// @text lightReset
8687
// @brief Resets the application data.

docs/apis/WarehousePlugin.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@ No Events
226226
| result.files | array | A string [] of file locations for each file that is found that should have been deleted in the cleaning process. If the `clean` property is `true`, then this array is empty or `null` |
227227
| result.files[#] | string | |
228228
| result.success | boolean | Whether the request succeeded |
229+
| result.error | string | An error message in case of a failure |
229230

230231
### Example
231232

@@ -253,7 +254,8 @@ No Events
253254
"files": [
254255
"/opt/ctrlm.sql"
255256
],
256-
"success": true
257+
"success": true,
258+
"error": "..."
257259
}
258260
}
259261
```

tools/json_generator/output/Warehouse/Warehouse.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,16 @@
104104
},
105105
"success":{
106106
"$ref": "#/common/success"
107+
},
108+
"error":{
109+
"$ref": "#/definitions/error"
107110
}
108111
},
109112
"required": [
110113
"clean",
111114
"files",
112-
"success"
115+
"success",
116+
"error"
113117
]
114118
}
115119
},

0 commit comments

Comments
 (0)