Define interfaces for Account and Backup by ramasat · Pull Request #728 · rdkcentral/entservices-apis

ramasat · 2026-02-09T15:43:55Z

Reason for change: Defining Interface for new Plugins.
Test Procedure: Compile the interface repo and make sure document is getting generated.
Risks: Low
version: Major
Signed-off-by: Ramasamy Thalavay Pillai Ramasamy_ThalavayPillai@comcast.com

github-actions · 2026-02-09T15:44:14Z

Documentation Auto-Generated

Documentation 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.

Copilot

Pull request overview

Adds new Thunder Exchange interfaces for Account and Backup plugins and publishes generated API reference docs for them.

Changes:

Introduced IAccount interface and generated docs/apis/Account.md.
Introduced IBackupManager / IBackupProvider interfaces and generated docs/apis/Backup.md.
Linked the new API docs into docs/_sidebar.md.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
docs/apis/Backup.md	Adds generated JSON-RPC documentation for Backup plugin methods.
docs/apis/Account.md	Adds generated JSON-RPC documentation for Account plugin methods.
docs/_sidebar.md	Adds navigation links for the new Account and Backup API docs.
apis/Backup/IBackup.h	Defines the Exchange interfaces for system backup/restore plus per-plugin backup/restore provider.
apis/Account/IAccount.h	Defines the Exchange interface for account-level operations.

docs/apis/Account.md

apis/Backup/IBackup.h

Copilot · 2026-02-09T15:45:49Z

apis/Backup/IBackup.h

+        // @param scenario: Scenario for which the backup to happen
+        virtual Core::hresult Restore(const Scenario scenario) const = 0;
+
+    }; 


Two issues in this block: (1) Restore's @param scenario description says 'backup' but should say 'restore'. (2) There's trailing whitespace after }; on line 76. Update the comment text and remove the trailing space to keep generated docs and formatting clean.

Suggested change

// @param scenario: Scenario for which the backup to happen

virtual Core::hresult Restore(const Scenario scenario) const = 0;

};

// @param scenario: Scenario for which the restore to happen

virtual Core::hresult Restore(const Scenario scenario) const = 0;

};

Copilot · 2026-02-09T15:45:50Z

docs/apis/Backup.md

+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.scenario | string | Scenario for which the backup to happen |


Both restore and restoreSettings parameter descriptions incorrectly say 'backup'. These should describe the restore operation (e.g., 'Scenario for which the restore is to happen') to avoid confusion and mismatched generated docs.

Copilot · 2026-02-09T15:45:50Z

docs/apis/Backup.md

+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.scenario | string | Scenario for which the backup to happen |


Both restore and restoreSettings parameter descriptions incorrectly say 'backup'. These should describe the restore operation (e.g., 'Scenario for which the restore is to happen') to avoid confusion and mismatched generated docs.

Suggested change

| params.scenario | string | Scenario for which the backup to happen |

| params.scenario | string | Scenario for which the restore is to happen |

Copilot · 2026-02-09T15:45:50Z

docs/apis/Account.md

+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | object |  |
+| result.resetTime | integer | Time in UTC. Returns 0, if time is not available. |


IAccount uses uint64_t for resetTime, but the generated docs describe it only as integer (often interpreted as 32-bit). Update the documentation/type mapping to explicitly indicate a 64-bit integer (or document the unit/range) so API consumers don't truncate large epoch values.

Suggested change

| result.resetTime | integer | Time in UTC. Returns 0, if time is not available. |

| result.resetTime | integer (64-bit) | 64-bit unsigned integer representing epoch time in UTC (may exceed 32-bit range). Returns 0, if time is not available. |

Copilot · 2026-02-09T15:45:50Z

docs/apis/Account.md

+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.resetTime | integer | Time in UTC. Returns 0, if time is not available. |


IAccount uses uint64_t for resetTime, but the generated docs describe it only as integer (often interpreted as 32-bit). Update the documentation/type mapping to explicitly indicate a 64-bit integer (or document the unit/range) so API consumers don't truncate large epoch values.

Suggested change

| params.resetTime | integer | Time in UTC. Returns 0, if time is not available. |

| params.resetTime | integer (int64) | Time in UTC as a 64-bit Unix epoch value (seconds since 1970-01-01T00:00:00Z). Returns 0 if time is not available. |

Copilot · 2026-02-09T15:45:51Z

apis/Account/IAccount.h

+        // @text getLastCheckoutResetTime
+        // @brief Gets the last reset time for Hotel Checkout.
+        // @param resetTime: Time in UTC. Returns 0, if time is not available.
+        virtual Core::hresult GetLastCheckoutResetTime(uint64_t& resetTime /* @out */) = 0;


GetLastCheckoutResetTime appears to be a read-only accessor but is not marked const, unlike SetLastCheckoutResetTime. Consider making it const for const-correctness and to make the interface easier to implement with immutable state.

Suggested change

virtual Core::hresult GetLastCheckoutResetTime(uint64_t& resetTime /* @out */) = 0;

virtual Core::hresult GetLastCheckoutResetTime(uint64_t& resetTime /* @out */) const = 0;

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

anand-ky

Test review for checking if "Require conversation resolution before merging" works

github-actions · 2026-02-12T10:53:26Z

Documentation Auto-Generated

Documentation 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.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

docs/apis/Backup.md

apis/Account/IAccount.h

apis/Backup/IBackup.h

apis/Ids.h

github-actions · 2026-02-12T13:13:05Z

Documentation Auto-Generated

Documentation 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.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

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

apis/Backup/IBackup.h

apis/Account/IAccount.h

japsen73 · 2026-02-24T16:46:12Z

apis/Backup/IBackup.h

+        virtual ~IBackupManager() = default;
+
+        enum Scenario : uint8_t {
+            HOSPITALITY_RESET /* @text HOSPITALITY_RESET */


Would just call it HOSPITALITY and strip the RESET

japsen73 · 2026-02-24T16:50:48Z

apis/Backup/IBackup.h

+
+        virtual ~IBackupManager() = default;
+
+        enum Scenario : uint8_t {


Is Context a better name ?
Would also add a GENERIC entry as the first entry in the enum. Allowing for usage that does not require a context.

japsen73 · 2026-02-24T17:04:55Z

apis/Backup/IBackup.h

+        // @brief Backup settings across the system
+        // @param scenario: Scenario for which the backup to happen
+        // @retval Core::ERROR_NONE Successfully backed up the settings
+        virtual Core::hresult BackupSettings(const Scenario scenario) = 0;


We should add a string to allow naming the backup. Enabling several backups of the same type.
E.g. A backup for english or french speeking hotel guests

japsen73 · 2026-02-24T17:09:53Z

apis/Backup/IBackup.h

+
+        virtual ~IBackupProvider() = default;
+
+        enum Scenario : uint8_t {


not needed here, as we maintain in BackupManager

japsen73 · 2026-02-24T17:10:30Z

apis/Backup/IBackup.h

+        // @brief Backup settings that belong to this component.
+        // @param scenario: Scenario for which the backup to happen
+        // @retval Core::ERROR_NONE Successfully backed up
+        virtual Core::hresult Backup(const Scenario scenario) = 0;


Add a name string as suggested on the manager.
on both Backup and Restore

japsen73 · 2026-02-24T17:12:07Z

apis/Backup/IBackup.h

+        // @brief Backup settings across the system
+        // @param scenario: Scenario for which the backup to happen
+        // @retval Core::ERROR_NONE Successfully backed up the settings
+        virtual Core::hresult BackupSettings(const Scenario scenario) = 0;


Would Backup and Restore be better names also on the Manager

japsen73 · 2026-02-24T17:13:48Z

apis/Backup/IBackup.h

+        // @param scenario: Scenario for which the backup to happen
+        // @retval Core::ERROR_NONE Successfully backed up the settings
+        virtual Core::hresult BackupSettings(const Scenario scenario) = 0;
+


With the intro of a name on the backups.
It would be good to have an iterator to list available backups.

japsen73 · 2026-02-24T17:14:52Z

apis/Backup/IBackup.h

+        enum { ID = ID_BACKUP_MANAGER };
+
+        virtual ~IBackupManager() = default;
+


I would think we need a delete method. to remove a named backup.

ramasat requested a review from a team as a code owner February 9, 2026 15:43

Copilot AI review requested due to automatic review settings February 9, 2026 15:43

Copilot AI reviewed Feb 9, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings February 9, 2026 16:09

Copilot AI reviewed Feb 9, 2026

View reviewed changes

anand-ky previously approved these changes Feb 9, 2026

View reviewed changes

ramasat dismissed anand-ky’s stale review via 4b5c4bb February 12, 2026 10:53

Copilot AI review requested due to automatic review settings February 12, 2026 10:53

Copilot AI reviewed Feb 12, 2026

View reviewed changes

ramasat requested review from anand-ky and Copilot February 12, 2026 10:56

Copilot started reviewing on behalf of ramasat February 12, 2026 10:57 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

docs/apis/Backup.md Show resolved Hide resolved

apis/Account/IAccount.h Show resolved Hide resolved

apis/Backup/IBackup.h Show resolved Hide resolved

apis/Ids.h Show resolved Hide resolved

Copilot AI review requested due to automatic review settings February 12, 2026 13:13

Copilot AI reviewed Feb 12, 2026

View reviewed changes

ramasat requested a review from Copilot February 12, 2026 13:29

Copilot started reviewing on behalf of ramasat February 12, 2026 13:39 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

ramasat and others added 8 commits February 16, 2026 19:27

Define interfaces for Account and Backup

fe4763b

Auto-generate documentation from interface changes

d0e8eae

Added IDs for backup and account interfaces

a9edddc

Minor correction in the backup interface

8631742

Minor corrections on constness

cfb376c

Auto-generate documentation from interface changes

94ab6d9

Added retval tags to aid documentation

694b434

Auto-generate documentation from interface changes

f49503b

ramasat force-pushed the topic/CPESP-9044 branch from 5d59ef7 to f49503b Compare February 16, 2026 13:57

japsen73 requested changes Feb 24, 2026

View reviewed changes

	\| params.scenario \| string \| Scenario for which the backup to happen \|
	\| params.scenario \| string \| Scenario for which the restore is to happen \|

	\| result.resetTime \| integer \| Time in UTC. Returns 0, if time is not available. \|
	\| result.resetTime \| integer (64-bit) \| 64-bit unsigned integer representing epoch time in UTC (may exceed 32-bit range). Returns 0, if time is not available. \|

	\| params.resetTime \| integer \| Time in UTC. Returns 0, if time is not available. \|
	\| params.resetTime \| integer (int64) \| Time in UTC as a 64-bit Unix epoch value (seconds since 1970-01-01T00:00:00Z). Returns 0 if time is not available. \|

	virtual Core::hresult GetLastCheckoutResetTime(uint64_t& resetTime /* @out */) = 0;
	virtual Core::hresult GetLastCheckoutResetTime(uint64_t& resetTime /* @out */) const = 0;


		virtual ~IBackupManager() = default;

		enum Scenario : uint8_t {


		virtual ~IBackupProvider() = default;

		enum Scenario : uint8_t {

		enum { ID = ID_BACKUP_MANAGER };

		virtual ~IBackupManager() = default;

Conversation

ramasat commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 9, 2026

Documentation Auto-Generated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

anand-ky left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 12, 2026

Documentation Auto-Generated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 12, 2026

Documentation Auto-Generated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

ramasat commented Feb 9, 2026 •

edited

Loading