RDKEMW-12082: Interface Changes for RDKAppManagers plugin by ABIRAMI-S · Pull Request #752 · rdkcentral/entservices-apis

ABIRAMI-S · 2026-02-28T04:59:50Z

No description provided.

Copilot

Pull request overview

Adds new Thunder RPC/JSON-RPC interface definitions and ID allocations to support the RDKAppManagers “Application Service” plugin API surface.

Changes:

Allocates a new ID_APPLICATION_SERVICE_* ID range in apis/Ids.h.
Introduces apis/ApplicationManager/IApplicationService.h defining request/config/listener/system-info/system-settings/test-preferences/diagnostics interfaces for Thunder codegen.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File	Description
`apis/Ids.h`	Adds a new ID block for Application Service related interfaces.
`apis/ApplicationManager/IApplicationService.h`	New Thunder RPC interface header defining Application Service APIs and notifications.

Copilot · 2026-02-28T05:03:53Z

apis/ApplicationManager/IApplicationService.h

+            // @return Error code: ERROR_NONE on success
+            // @text:request
+            virtual Core::hresult Request(


The @text tag syntax is inconsistent with the project’s interface-header guidelines/examples (which use // @text <name> with a space). Using // @text:<name> may not be recognized by the documentation/code generators. Please switch these to the documented form (e.g., // @text request, // @text getSystemInfo, etc.).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers_methods.instructions.md#api--notification-naming-for-interface-and-json-rpc

Copilot · 2026-02-28T05:03:53Z

apis/ApplicationManager/IApplicationService.h

+            // @brief Process an HTTP-style request
+            // @param flags Request type flags: GET=0x01, POST=0x02, DELETE=0x04
+            // @param url Request URL path (e.g., "/as/network/ipconfig/settings")
+            // @param headers HTTP headers as JSON object string
+            // @param queryParams Query parameters as JSON object string
+            // @param body Request body (for POST requests)
+            // @param code HTTP status code (output)
+            // @param responseHeaders Response headers as JSON object string (output)
+            // @param responseBody Response body as JSON string (output)
+            // @return Error code: ERROR_NONE on success
+            // @text:request
+            virtual Core::hresult Request(
+                const uint32_t flags,


flags encodes a small, well-known set of request types (GET/POST/DELETE) but is exposed as a raw uint32_t. Per the interface guidelines, prefer an enum/bitmask enum for constrained values to make the API self-describing and type-safe (and to avoid undocumented flag combinations).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers_methods.instructions.md#special-considerations-for-enum-and-string-parameters

Suggested change

// @brief Process an HTTP-style request

// @param flags Request type flags: GET=0x01, POST=0x02, DELETE=0x04

// @param url Request URL path (e.g., "/as/network/ipconfig/settings")

// @param headers HTTP headers as JSON object string

// @param queryParams Query parameters as JSON object string

// @param body Request body (for POST requests)

// @param code HTTP status code (output)

// @param responseHeaders Response headers as JSON object string (output)

// @param responseBody Response body as JSON string (output)

// @return Error code: ERROR_NONE on success

// @text:request

virtual Core::hresult Request(

const uint32_t flags,

enum REQUEST_FLAGS : uint32_t {

REQUEST_GET = 0x01 /* @text REQUEST_GET */,

REQUEST_POST = 0x02 /* @text REQUEST_POST */,

REQUEST_DELETE = 0x04 /* @text REQUEST_DELETE */

};

// @brief Process an HTTP-style request

// @param flags Request type flags. Bitmask of REQUEST_FLAGS (e.g., REQUEST_GET, REQUEST_POST, REQUEST_DELETE)

// @param url Request URL path (e.g., "/as/network/ipconfig/settings")

// @param headers HTTP headers as JSON object string

// @param queryParams Query parameters as JSON object string

// @param body Request body as JSON string (typically used for POST requests)

// @param code HTTP status code (output)

// @param responseHeaders Response headers as JSON object string (output)

// @param responseBody Response body as JSON string (output)

// @retval Core::ERROR_NONE: Request processed successfully

// @retval Core::ERROR_GENERAL: Request processing failed

// @text:request

virtual Core::hresult Request(

const REQUEST_FLAGS flags,

Copilot · 2026-02-28T05:03:54Z

apis/ApplicationManager/IApplicationService.h

+            // @brief Process an HTTP-style request
+            // @param flags Request type flags: GET=0x01, POST=0x02, DELETE=0x04
+            // @param url Request URL path (e.g., "/as/network/ipconfig/settings")
+            // @param headers HTTP headers as JSON object string
+            // @param queryParams Query parameters as JSON object string
+            // @param body Request body (for POST requests)
+            // @param code HTTP status code (output)
+            // @param responseHeaders Response headers as JSON object string (output)
+            // @param responseBody Response body as JSON string (output)
+            // @return Error code: ERROR_NONE on success
+            // @text:request


Method documentation uses @return prose but is missing the required @retval <ErrorCode>: <Description> annotations. Please add explicit @retval entries for each possible return value for these APIs (e.g., success and common error cases), as required for generated docs.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Copilot · 2026-02-28T05:03:54Z

apis/ApplicationManager/IApplicationService.h

+                // @brief WebSocket update notification
+                // @param url WebSocket URL that sent update
+                // @param message Update message content
+                // @text:onNotifyWebSocketUpdate
+                virtual void OnNotifyWebSocketUpdate(const string &url, const string &message) = 0;
+


IApplicationServiceListener::INotification defines notification methods as pure virtual (= 0). Notification interfaces in these API headers must provide default (empty) implementations and must not use pure virtual methods, to keep implementation and binary compatibility expectations consistent.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers_notifications.instructions.md#notification-interfaces

Copilot · 2026-02-28T05:03:54Z

apis/ApplicationManager/IApplicationService.h

+                // @brief WebSocket update notification
+                // @param url WebSocket URL that sent update
+                // @param message Update message content
+                // @text:onNotifyWebSocketUpdate
+                virtual void OnNotifyWebSocketUpdate(const string &url, const string &message) = 0;
+
+                // @brief HTTP update notification
+                // @param url HTTP endpoint that sent update
+                // @param code HTTP status code
+                // @text:onNotifyHttpUpdate
+                virtual void OnNotifyHttpUpdate(const string &url, const uint32_t code) = 0;


Notification naming doesn’t follow the documented on[Object][Action] pattern. For example, OnNotifyWebSocketUpdate / @text:onNotifyWebSocketUpdate uses an extra “Notify” prefix that makes the object/action unclear. Please rename notifications (and their @text names) to match the pattern (e.g., OnWebSocketUpdate with // @text onWebSocketUpdate).

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers_notifications.instructions.md#notification-name-formatting

Copilot · 2026-02-28T05:03:54Z

apis/ApplicationManager/IApplicationService.h

+            };
+            virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;


Register / Unregister are missing the required interface documentation tags (@brief, @param, and (where applicable) @retval). Please document these methods consistently so the generated API docs are complete.

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Suggested change

};

virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;

};

// @brief Register a notification sink for application service listener events.

// @param notification Pointer to the notification interface instance to be registered.

// @retval Core::ERROR_NONE: Registration succeeded.

// @retval Core::ERROR_BAD_REQUEST: The notification parameter is null or invalid.

// @retval Core::ERROR_ALREADY_CONNECTED: The notification interface is already registered.

// @text register

virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;

// @brief Unregister a previously registered notification sink.

// @param notification Pointer to the notification interface instance to be unregistered.

// @retval Core::ERROR_NONE: Unregistration succeeded.

// @retval Core::ERROR_BAD_REQUEST: The notification parameter is null or invalid.

// @retval Core::ERROR_UNKNOWN_KEY: The specified notification interface is not currently registered.

// @text unregister

Copilot · 2026-02-28T05:03:55Z

apis/Ids.h


        ID_RESOURCEMANAGER                           = ID_ENTOS_OFFSET + 0x480,
+
+	ID_APPLICATION_SERVICE_REQUEST               = ID_ENTOS_OFFSET + 0x490,


Indentation within the newly added ID block is inconsistent (ID_APPLICATION_SERVICE_REQUEST is tab-indented while the following lines are space-indented). Please normalize indentation in this block to match the surrounding style to keep diffs clean.

Suggested change

ID_APPLICATION_SERVICE_REQUEST = ID_ENTOS_OFFSET + 0x490,

ID_APPLICATION_SERVICE_REQUEST = ID_ENTOS_OFFSET + 0x490,

Copilot · 2026-02-28T05:03:55Z

apis/ApplicationManager/IApplicationService.h

+//
+// IApplicationService.h
+// Thunder RPC interface definitions for AS Services
+// Uses Thunder header-based code generation approach
+//
+// USAGE:
+//   Run Thunder ProxyStubGenerator or JsonGenerator on this file to generate:
+//   - JSON-RPC proxy classes (client-side for asproxy)
+//   - JSON-RPC stub registration (server-side for services)
+//   - Marshalling/unmarshalling code
+//
+
+#pragma once
+
+#include "Module.h"


The file header is missing the standard Apache 2.0 copyright/license block that other apis/**/I*.h interface headers include. Please add the repository-standard license header at the top of this new API file for consistency and compliance.

madanagopalt

Rename ApplicationManager name to RDKAppManagerService

RDKEMW-12082: Interface Changes for RDKAppManagers plugin

9480510

ABIRAMI-S requested a review from a team as a code owner February 28, 2026 04:59

Copilot AI review requested due to automatic review settings February 28, 2026 04:59

Copilot started reviewing on behalf of ABIRAMI-S February 28, 2026 05:00 View session

Copilot AI reviewed Feb 28, 2026

View reviewed changes

madanagopalt requested changes Feb 28, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RDKEMW-12082: Interface Changes for RDKAppManagers plugin#752

RDKEMW-12082: Interface Changes for RDKAppManagers plugin#752
ABIRAMI-S wants to merge 1 commit intotopic/RDKEMW-13976from
topic/RDKEMW-12082_1

ABIRAMI-S commented Feb 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

Copilot AI Feb 28, 2026

Uh oh!

madanagopalt left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		};
		virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;

-            };
-            virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;
+            };
+            // @brief Register a notification sink for application service listener events.
+            // @param notification Pointer to the notification interface instance to be registered.
+            // @retval Core::ERROR_NONE: Registration succeeded.
+            // @retval Core::ERROR_BAD_REQUEST: The notification parameter is null or invalid.
+            // @retval Core::ERROR_ALREADY_CONNECTED: The notification interface is already registered.
+            // @text register
+            virtual Core::hresult Register(IApplicationServiceListener::INotification *notification) = 0;
+            // @brief Unregister a previously registered notification sink.
+            // @param notification Pointer to the notification interface instance to be unregistered.
+            // @retval Core::ERROR_NONE: Unregistration succeeded.
+            // @retval Core::ERROR_BAD_REQUEST: The notification parameter is null or invalid.
+            // @retval Core::ERROR_UNKNOWN_KEY: The specified notification interface is not currently registered.
+            // @text unregister


		ID_RESOURCEMANAGER = ID_ENTOS_OFFSET + 0x480,

		ID_APPLICATION_SERVICE_REQUEST = ID_ENTOS_OFFSET + 0x490,

Conversation

ABIRAMI-S commented Feb 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

madanagopalt left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants