docs(user-api): Document additions

Author: Archasion

src/users/mod.rs

@@ -15,6 +15,16 @@ pub(crate) fn routes() -> Vec<Route> {
     routes![me]
 }
 
+/// Get the authorized user's information
+///
+/// # Possible Responses
+///
+/// - `200 OK` with a serialized [`UserInfoResponse`] struct.
+/// - `401 Unauthorized`
+///   - If the session cookie is missing.
+///   - If the session is not found in the database.
+/// - `404 Not Found` if the user has no account links.
+/// - `500 Internal Server Error` if the user has no primary account link.
 #[get("/@me")]
 async fn me(conn: DbConn, session: Session) -> ApiResult<Json<UserInfoResponse>> {
     // Account links associated with the Discord ID

src/users/types.rs

@@ -1,23 +1,30 @@
 use rocket::serde::Serialize;
 use std::collections::HashSet;
 
+/// The response for the `GET /@me` route.
 #[derive(Serialize, Debug)]
 #[serde(crate = "rocket::serde")]
-pub(crate) struct UserInfoResponse {
-    pub(crate) user: User,
-    pub(crate) linked_accounts: UserLinkedAccounts,
+pub(super) struct UserInfoResponse {
+    pub(super) user: User,
+    pub(super) linked_accounts: UserLinkedAccounts,
 }
 
+/// The user's primary account link.
 #[derive(Serialize, Debug)]
 #[serde(crate = "rocket::serde")]
-pub(crate) struct User {
-    pub(crate) discord_uid: String,
-    pub(crate) roblox_uid: String,
+pub(super) struct User {
+    /// The user's Discord ID.
+    pub(super) discord_uid: String,
+    /// The user's Roblox ID.
+    pub(super) roblox_uid: String,
 }
 
+/// The user's account links (verification history).
 #[derive(Serialize, Default, Debug)]
 #[serde(crate = "rocket::serde")]
-pub(crate) struct UserLinkedAccounts {
-    pub(crate) discord: HashSet<String>,
-    pub(crate) roblox: HashSet<String>,
+pub(super) struct UserLinkedAccounts {
+    /// All Discord IDs associated with the user.
+    pub(super) discord: HashSet<String>,
+    /// All Roblox IDs associated with the user.
+    pub(super) roblox: HashSet<String>,
 }