From a757174196c4aac66d6a22a724a28ce59c5da2f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Ko=C5=82odziej?= Date: Mon, 3 Jun 2024 09:42:05 +0200 Subject: [PATCH] docs: add warning for dropping custom room_id soon (#119) --- docs/getting_started/installation.md | 4 ++-- docs/getting_started/room.md | 6 +++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.md index dbf209c2..81aba09d 100644 --- a/docs/getting_started/installation.md +++ b/docs/getting_started/installation.md @@ -187,14 +187,14 @@ Example log with and without this option: ```json - {"time":"2024-02-20T17:32:32.448Z","severity":"info","message":"Initialize room","metadata":{"room_id":"40"}} + {"time":"2024-02-20T17:32:32.448Z","severity":"info","message":"Initialize room","metadata":{"room_id":"da2e-4a75-95ff-776bad2caf04-666973686a616d4031302e302e302e31"}} ``` ``` - 17:32:32.448 room_id=40 [info] Initialize room + 17:32:32.448 room_id=da2e-4a75-95ff-776bad2caf04-666973686a616d4031302e302e302e31 [info] Initialize room ``` diff --git a/docs/getting_started/room.md b/docs/getting_started/room.md index 41bcdea6..e3a611bd 100644 --- a/docs/getting_started/room.md +++ b/docs/getting_started/room.md @@ -6,9 +6,13 @@ The holder for peers and components. **Optional** +:::caution + Support for custom ID will be dropped soon in favor of IDs generated by the server. + * `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. It may contain only alphanumeric characters, hyphens and underscores. +::: * `maxPeers` (integer 1.., default: null) - Maximum number of peers allowed in the room. If set to null (default), the number of peers is unlimited.