-
Notifications
You must be signed in to change notification settings - Fork 1
SDK Deprecation message Authentication #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds an SDK deprecation/compatibility payload to the peer authentication response so clients can be informed when their SDK version is up-to-date, deprecated, or unsupported.
Changes:
- Introduces
PeerMessage.SdkDeprecationmessage andStatusenum inpeer_notifications.proto. - Extends
PeerMessage.Authenticatedwith a newsdk_deprecationfield. - Regenerates Elixir protobuf modules and updates generated protocol documentation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| fishjam_protos/lib/fishjam/peer_notifications.pb.ex | Adds generated Elixir modules for SdkDeprecation and wires the new field into Authenticated. |
| fishjam/peer_notifications.proto | Defines the new SdkDeprecation message/enum and adds it to Authenticated. |
| doc/docs.md | Updates the generated protocol docs/TOC to include SdkDeprecation and the new field. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Status status = 1; | ||
| string message = 2; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What will be sent in the message? Which version is supported?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
message displayed to sdk user
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
support for version is defined in PR to fishtank https://github.com/fishjam-cloud/fishtank/pull/49
Description
Describe your changes.
Motivation and Context
Why is this change required? What problem does it solve? If it fixes an open
issue, please link to the issue here.
Documentation impact