Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(infra): correct the import result restartRequired and warnings

Yudhi Armyndharis138c8aad9b0b
diff --git a/src/modules/infra/dto/infra-response.dto.ts b/src/modules/infra/dto/infra-response.dto.ts
index 46ded8897..275c12ebe 100644
--- a/src/modules/infra/dto/infra-response.dto.ts
+++ b/src/modules/infra/dto/infra-response.dto.ts
@@ -504,8 +504,9 @@ export class InfraImportDataResponseDto {
@ApiProperty({
type: [String],
description:
- 'Why the restore was rolled back (per-row failures, or a backup with no rows). Non-empty only when ' +
- '`imported` is false; non-fatal messages are in `notices`.',
+ 'Why the restore was rolled back (per-row failures, a failed session ownership restore, chat-state re-key ' +
+ 'or restored-row cleanup, or a backup with no rows). Non-empty only when `imported` is false; non-fatal ' +
+ 'messages are in `notices`.',
example: [],
})
warnings!: string[];
@@ -516,8 +517,9 @@ export class InfraImportDataResponseDto {
@ApiProperty({
description:
'True when an engine may still be writing into the restored tables (orphans left running by `force`, a ' +
- 'failed `stopOrphans` teardown, sessions held by another node, or plugin bindings not re-applied). Restart ' +
- 'to reconcile. Can be true even when `imported` is false.',
+ 'failed `stopOrphans` teardown, sessions held by another node; restart to reconcile), or when plugin ' +
+ 'instance bindings could not be re-synced after the commit (a restart does not repair this; follow the ' +
+ 'manual check named in `notices`). Can be true even when `imported` is false.',
example: false,
})
restartRequired!: boolean;
diff --git a/src/modules/infra/infra-data.service.ts b/src/modules/infra/infra-data.service.ts
index 288c00d3c..37006af50 100644
--- a/src/modules/infra/infra-data.service.ts
+++ b/src/modules/infra/infra-data.service.ts
@@ -260,7 +260,9 @@ export interface InfraImportDataResult {
/**
* True when an engine may still be writing into the restored tables, from any of three causes:
* orphans deliberately left running (`force`), a `stopOrphans` teardown that failed, or sessions
- * held by another node, which this request has no channel to stop. Restart to reconcile.
+ * held by another node, which this request has no channel to stop. Restart to reconcile those.
+ * Also true when the post-commit plugin binding re-sync failed; a restart does not repair that
+ * one, so its notice names the manual check instead.
*/
restartRequired: boolean;
/** Session ids with a running engine that the restored data no longer contains. */