numinnex commented on code in PR #3834:
URL: https://github.com/apache/iggy/pull/3834#discussion_r3735202124


##########
foreign/go/README.md:
##########
@@ -10,7 +10,10 @@
 
 Official Go client SDK for [Apache Iggy](https://iggy.apache.org) message 
streaming.
 
-The client currently supports TCP protocols with blocking implementation.
+The client speaks the VSR wire protocol over TCP, with or without TLS, in a
+blocking implementation. VSR is the only protocol it supports: there is no

Review Comment:
   **warning — the API break has no migration note**
   
   The README covers the VSR-only stance and the delivery semantics, but 
nothing tells an existing user what will stop compiling:
   
   - `Client.SendMessages` changed from `error` to `(*SendMessagesResponse, 
error)`.
   - `SyncConsumerGroup` was added to the `iggcon.Client` interface, which 
breaks every external implementor, mock and wrapper at compile time.
   - `contracts.Version` went `0.8.1-edge.2` → `0.9.0-edge.1` 
(`contracts/version.go:20`).
   
   There is no Go SDK CHANGELOG (only `foreign/node/CHANGELOG.md`), so this 
file is the only surface a user will find.
   
   Suggested fix: add a "Breaking changes in 0.9.0" section listing both 
signature changes, with a one-line before/after for `SendMessages`.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to