docs: fix description of WatchResponse.canceled

[myrat92]

see description in #18413

[k8s-ci-robot]

Hi @myrat92. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.81%. Comparing base (981061a) to head (3d735d5).
Report is 10 commits behind head on main.

❗ Current head 3d735d5 differs from pull request most recent head 4155d8b

Please upload reports for the commit 4155d8b to get more accurate results.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Files with missing lines	Coverage Δ
server/storage/wal/repair.go	56.14% <100.00%> (ø)

... and 17 files with indirect coverage changes

@@            Coverage Diff             @@
##             main   #18580      +/-   ##
==========================================
+ Coverage   68.73%   68.81%   +0.07%     
==========================================
  Files         420      420              
  Lines       35474    35474              
==========================================
+ Hits        24382    24410      +28     
+ Misses       9666     9648      -18     
+ Partials     1426     1416      -10     

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 981061a...4155d8b. Read the comment docs.

[myrat92]

cc pls @jmhbnz

[jmhbnz]

Thanks @myrat92 this lines up with

etcd/client/v3/watch.go

Lines 54 to 56 in 6c1fe4a

	// Watch watches on a key or prefix. The watched events will be returned
	// through the returned channel. If revisions waiting to be sent over the
	// watch are compacted, then the watch will be canceled by the server, the

/ok-to-test

We should ensure website docs pages also reflect this, I think some of them may auto generate:

• https://etcd.io/docs/v3.6/learning/api/#watch-streams
• https://etcd.io/docs/v3.6/dev-guide/api_reference_v3/

@serathius, @ahrtr can you please also take a look at this, thanks!

[ahrtr]

The Documentation/dev-guide/apispec/swagger/rpc.swagger.json is automatically generated based on proto file

etcd/api/etcdserverpb/rpc.proto

Lines 839 to 841 in 6c1fe4a

	// canceled is set to true if the response is for a cancel watch request.
	// No further events will be sent to the canceled watcher.
	bool canceled = 4;

Refer to https://github.com/etcd-io/etcd/blob/main/scripts/genproto.sh

[myrat92]

Thanks @ahrtr @jmhbnz , I used proto file to automatically generate the rpc.swagger.json

[jmhbnz]

LGTM

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahrtr, jmhbnz, myrat92

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [ahrtr,jmhbnz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment