chore(doc): implement remainder of documentation

src/routes/invites/invite_delete.rs

@@ -3,6 +3,10 @@ use revolt_quark::{
     perms, Db, EmptyResponse, Permission, Ref, Result,
 };
 
+/// # Delete Invite
+///
+/// Delete an invite by its id.
+#[openapi(tag = "Invites")]
 #[delete("/<target>")]
 pub async fn req(db: &Db, user: User, target: Ref) -> Result<EmptyResponse> {
     let invite = target.as_invite(db).await?;

src/routes/invites/invite_fetch.rs

@@ -4,37 +4,59 @@ use revolt_quark::{Db, Ref, Result};
 use rocket::serde::json::Json;
 use serde::Serialize;
 
+/// # Invite
 #[allow(clippy::large_enum_variant)]
-#[derive(Serialize, Debug, Clone)]
+#[derive(Serialize, Debug, Clone, JsonSchema)]
 #[serde(tag = "type")]
 pub enum InviteResponse {
+    /// Server channel invite
     Server {
+        /// Id of the server
         server_id: String,
+        /// Name of the server
         server_name: String,
+        /// Attachment for server icon
         #[serde(skip_serializing_if = "Option::is_none")]
         server_icon: Option<File>,
+        /// Attachment for server banner
         #[serde(skip_serializing_if = "Option::is_none")]
         server_banner: Option<File>,
+        /// Id of server channel
         channel_id: String,
+        /// Name of server channel
         channel_name: String,
+        /// Description of server channel
         #[serde(skip_serializing_if = "Option::is_none")]
         channel_description: Option<String>,
+        /// Name of user who created the invite
         user_name: String,
+        /// Avatar of the user who created the invite
         #[serde(skip_serializing_if = "Option::is_none")]
         user_avatar: Option<File>,
+        /// Number of members in this server
         member_count: i64,
     },
+    /// Group channel invite
     Group {
+        /// Id of group channel
         channel_id: String,
+        /// Name of group channel
         channel_name: String,
+        /// Description of group channel
         #[serde(skip_serializing_if = "Option::is_none")]
         channel_description: Option<String>,
+        /// Name of user who created the invite
         user_name: String,
+        /// Avatar of the user who created the invite
         #[serde(skip_serializing_if = "Option::is_none")]
         user_avatar: Option<File>,
     },
 }
 
+/// # Fetch Invite
+///
+/// Fetch an invite by its id.
+#[openapi(tag = "Invites")]
 #[get("/<target>")]
 pub async fn req(db: &Db, target: Ref) -> Result<Json<InviteResponse>> {
     Ok(Json(match target.as_invite(db).await? {

src/routes/invites/invite_join.rs

@@ -7,6 +7,10 @@ use rocket::serde::json::Value;
 
 use crate::util::variables::MAX_SERVER_COUNT;
 
+/// # Join Invite
+///
+/// Join an invite by its ID.
+#[openapi(tag = "Invites")]
 #[post("/<target>")]
 pub async fn req(db: &Db, user: User, target: Ref) -> Result<Value> {
     if user.bot.is_some() {

src/routes/invites/mod.rs

@@ -1,9 +1,10 @@
 use rocket::Route;
+use rocket_okapi::okapi::openapi3::OpenApi;
 
 mod invite_delete;
 mod invite_fetch;
 mod invite_join;
 
-pub fn routes() -> Vec<Route> {
-    routes![invite_fetch::req, invite_join::req, invite_delete::req]
+pub fn routes() -> (Vec<Route>, OpenApi) {
+    openapi_get_routes_spec![invite_fetch::req, invite_join::req, invite_delete::req]
 }