tailcfg: document peer node capability

Updates tailscale/corp#17516 Signed-off-by: Claire Wang <claire@tailscale.com>
tailscale · Mar 8, 2024 · 53e0a6a · 53e0a6a
1 parent 74e33b9
commit 53e0a6a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tailcfg/tailcfg.go b/tailcfg/tailcfg.go
@@ -326,6 +326,9 @@ type Node struct {
 	//    "https://tailscale.com/cap/file-sharing"
 	//
 	// Deprecated: use CapMap instead.
+	// CapMap and Capabilities are both ways for control to send metadata about a peer node.
+	// By accessing a self node's peers - a self node can check the peer's capabilities.
+	// Capabilities can be used to label information about a peer.
 	Capabilities []NodeCapability `json:",omitempty"`
 
 	// CapMap is a map of capabilities to their optional argument/data values.