Conversation
Reason For Change: Adding ResourceManager plugin Changes Test procedure : Test UnifiedCASManagement Priority: P1 Signed-off-by: naveen-0206 <naveenkumar.t@ltts.com>
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
There was a problem hiding this comment.
Pull request overview
This PR adds ResourceManager plugin documentation and interface definitions to the Thunder framework, supporting the UnifiedCASManagement testing initiative.
Changes:
- Added ResourceManager interface header file defining core operations for AV blocking and TTS resource management
- Created comprehensive API documentation for the ResourceManager plugin
- Updated navigation sidebar to include the new ResourceManager documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/apis/ResourceManager.md | Complete API documentation for ResourceManager plugin with method descriptions, parameters, and examples |
| docs/_sidebar.md | Added ResourceManager link to documentation navigation |
| apis/ResourceManager/IResourceManager.h | Interface definition with methods for AV blocking control and TTS resource reservation |
| apis/Ids.h | Added ID_RESOURCEMANAGER constant for interface identification |
| - [RDKWindowManager](apis/RDKWindowManager.md) | ||
| - [RemoteControl<sup>@</sup>](apis/RemoteControlPlugin.md) | ||
| - [ResourceManager](apis/ResourceManager.md) | ||
| - [ResourceManager<sup>@</sup>](apis/ResourceManagerPlugin.md) |
There was a problem hiding this comment.
There are now two entries for ResourceManager in the sidebar (lines 48 and 49). This creates ambiguity for users navigating the documentation. If these represent different versions or implementations, they should have distinct, descriptive names (e.g., 'ResourceManager (New)' and 'ResourceManager (Legacy)' or similar differentiation).
| - [ResourceManager<sup>@</sup>](apis/ResourceManagerPlugin.md) | |
| - [ResourceManager Plugin<sup>@</sup>](apis/ResourceManagerPlugin.md) |
|
|
||
| ```json | ||
| { | ||
| "jsonrpc": 2.0, |
There was a problem hiding this comment.
JSON-RPC version should be a string '2.0', not a number 2.0. This appears in multiple examples throughout the document (lines 78, 96, 132, 152, 186, 208, 242, 264).
| | Name | Type | Description | | ||
| | :-------- | :-------- | :-------- | | ||
| | params | object | | | ||
| | params.appId | string | string | |
There was a problem hiding this comment.
The description column repeats the type 'string' instead of providing a meaningful description of what appId represents. This also occurs on line 227.
| | :-------- | :-------- | :-------- | | ||
| | params | object | | | ||
| | params.appId | string | string | | ||
| | params.blocked | bool | bool | |
There was a problem hiding this comment.
The description column repeats the type 'bool' instead of explaining what the blocked parameter means (e.g., 'Whether to block or unblock AV access for the application').
| | params.blocked | bool | bool | | |
| | params.blocked | bool | Whether to block (`true`) or unblock (`false`) AV access for the application | |
| bool success; | ||
| Core::OptionalType<string> message; | ||
| }; | ||
|
|
||
| // Result struct for TTS operations | ||
| struct EXTERNAL TTSResult { | ||
| bool success; | ||
| Core::OptionalType<string> message; |
There was a problem hiding this comment.
The message field in SetAVBlockedResult is not documented in the API documentation (ResourceManager.md), but it appears to be part of the interface. Users won't know this field exists or what it contains. This also applies to the message field in TTSResult on line 46.
| bool success; | |
| Core::OptionalType<string> message; | |
| }; | |
| // Result struct for TTS operations | |
| struct EXTERNAL TTSResult { | |
| bool success; | |
| Core::OptionalType<string> message; | |
| // Indicates whether the SetAVBlocked operation completed successfully. | |
| bool success; | |
| // Optional human-readable description providing additional details about the result. | |
| // Typically contains an error reason when success is false; may be empty on success. | |
| Core::OptionalType<string> message; | |
| }; | |
| // Result struct for TTS operations | |
| struct EXTERNAL TTSResult { | |
| // Indicates whether the TTS-related operation completed successfully. | |
| bool success; | |
| // Optional human-readable description providing additional details about the result. | |
| // Typically contains an error reason when success is false; may be empty on success. | |
| Core::OptionalType<string> message; |
Reason For Change: Adding ResourceManager plugin Changes
Test procedure : Test UnifiedCASManagement
version : minor
Priority: P1