docs(proto): spell out the monitor-restart clearing emission on AlarmSnapshotStatus

This commit is contained in:
Joseph Doherty
2026-08-18 05:19:31 -04:00
parent fab600d3b0
commit 312e072070
2 changed files with 8 additions and 2 deletions
@@ -29318,7 +29318,10 @@ namespace ZB.MOM.WW.MxGateway.Contracts.Proto {
/// Feed-level snapshot-completeness status. Emitted once on StreamAlarms open /// Feed-level snapshot-completeness status. Emitted once on StreamAlarms open
/// (after the initial provider_status frame, before the cached active_alarm /// (after the initial provider_status frame, before the cached active_alarm
/// frames) so late joiners learn the current verdict, and again on every change /// frames) so late joiners learn the current verdict, and again on every change
/// of the truncation verdict observed at reconcile. Mirrors the per-record /// of the truncation verdict — when a reconcile reports a different verdict, and
/// when the gateway's alarm monitor restarts and drops a truncated verdict with
/// the cache generation it described (feed subscribers outlive that monitor
/// session, so they are sent the clearing frame). Mirrors the per-record
/// ActiveAlarmSnapshot.from_truncated_snapshot caveat at feed level so live /// ActiveAlarmSnapshot.from_truncated_snapshot caveat at feed level so live
/// consumers can reason about completeness without polling QueryActiveAlarms. /// consumers can reason about completeness without polling QueryActiveAlarms.
/// </summary> /// </summary>
@@ -1035,7 +1035,10 @@ message AlarmProviderStatus {
// Feed-level snapshot-completeness status. Emitted once on StreamAlarms open // Feed-level snapshot-completeness status. Emitted once on StreamAlarms open
// (after the initial provider_status frame, before the cached active_alarm // (after the initial provider_status frame, before the cached active_alarm
// frames) so late joiners learn the current verdict, and again on every change // frames) so late joiners learn the current verdict, and again on every change
// of the truncation verdict observed at reconcile. Mirrors the per-record // of the truncation verdict — when a reconcile reports a different verdict, and
// when the gateway's alarm monitor restarts and drops a truncated verdict with
// the cache generation it described (feed subscribers outlive that monitor
// session, so they are sent the clearing frame). Mirrors the per-record
// ActiveAlarmSnapshot.from_truncated_snapshot caveat at feed level so live // ActiveAlarmSnapshot.from_truncated_snapshot caveat at feed level so live
// consumers can reason about completeness without polling QueryActiveAlarms. // consumers can reason about completeness without polling QueryActiveAlarms.
message AlarmSnapshotStatus { message AlarmSnapshotStatus {