docs: add warning for dropping custom room_id soon (#119)

fishjam-dev · Jun 3, 2024 · a757174 · a757174
1 parent 982008a
commit a757174
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.md
@@ -187,14 +187,14 @@ Example log with and without this option:
   <TabItem value="json-log-on" label="true" default>
 
   ```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"}}
   ```
 
   </TabItem>
   <TabItem value="json-log-off" label="false" default>
 
   ```
-  17:32:32.448 room_id=40 [info] Initialize room
+  17:32:32.448 room_id=da2e-4a75-95ff-776bad2caf04-666973686a616d4031302e302e302e31 [info] Initialize room
   ```
 
   </TabItem>

diff --git 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.