From 322894e4e9fa1b07905718dbca0ff789fafef799 Mon Sep 17 00:00:00 2001
From: kozabrada123 <59031733+kozabrada123@users.noreply.github.com>
Date: Mon, 10 Jul 2023 17:22:31 +0200
Subject: [PATCH] UrlBundle slightly better docs

---
 src/lib.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 77425b8..5b14544 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -18,9 +18,18 @@ pub mod voice;
 #[derive(Clone, Default, Debug, PartialEq, Eq)]
 /// A URLBundle is a struct which bundles together the API-, Gateway- and CDN-URLs of a Spacebar
 /// instance.
+/// # Notes
+/// All the urls can be found on the /api/policies/instance/domains endpoint of a spacebar server
 pub struct UrlBundle {
+    /// The api's url.
+    /// Ex: `https://old.server.spacebar.chat/api`
     pub api: String,
+    /// The gateway websocket url.
+    /// Note that because this is a websocket url, it will always start with `wss://`
+    /// Ex: `wss://gateway.old.server.spacebar.chat`
     pub wss: String,
+    /// The CDN's url.
+    /// Ex: `https://cdn.old.server.spacebar.chat`
     pub cdn: String,
 }