Merge pull request #18580 from myrat92/fix-issue-184113

docs: fix description of WatchResponse.canceled
etcd-io · Sep 24, 2024 · 6619b9f · 6619b9f
2 parents c79c7d5 + 4155d8b
commit 6619b9f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/Documentation/dev-guide/apispec/swagger/rpc.swagger.json b/Documentation/dev-guide/apispec/swagger/rpc.swagger.json
@@ -2982,7 +2982,7 @@
         },
         "canceled": {
           "type": "boolean",
-          "description": "canceled is set to true if the response is for a cancel watch request.\nNo further events will be sent to the canceled watcher."
+          "description": "canceled is set to true if the response is for a cancel watch request\nor if the start_revision has already been compacted.\nNo further events will be sent to the canceled watcher."
         },
         "compact_revision": {
           "type": "string",

diff --git a/api/etcdserverpb/rpc.pb.go b/api/etcdserverpb/rpc.pb.go
diff --git a/api/etcdserverpb/rpc.proto b/api/etcdserverpb/rpc.proto
@@ -836,7 +836,8 @@ message WatchResponse {
   // All events sent to the created watcher will attach with the same watch_id.
   bool created = 3;
 
-  // canceled is set to true if the response is for a cancel watch request.
+  // canceled is set to true if the response is for a cancel watch request
+  // or if the start_revision has already been compacted.
   // No further events will be sent to the canceled watcher.
   bool canceled = 4;