This repository has been archived by the owner on Nov 13, 2024. It is now read-only.
docs: add warning for dropping custom room_id soon #119
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
Rados13
approved these changes
Jun 3, 2024
| * `roomId` (string, default: null) - Custom ID used for identifying the room within Fishjam. | ||
| Must be unique across all rooms. If not provided, a random UUID will be generated. | ||
| Must be unique across all rooms. If not provided, a random UUID will be generated. |
There was a problem hiding this comment.
Shouldn't we inform readers that room won't work correctly if roomId is not unique across all rooms?
There was a problem hiding this comment.
Well isn't that actually stated here that: Must be unique across all rooms ?
There was a problem hiding this comment.
tbh: I wouldn't put much attention to it since it will be dropped soon I just added caution for now.
There was a problem hiding this comment.
IMO it isn't clear. It could also be mentioned that if you send the same room as on another node, you will receive an error.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fishjam-dev/fishjam#206