forked from jmug/stoatchat
chore: update everything to work with utoipa
This commit is contained in:
Zomatree
+304
-346
@@ -1,8 +1,13 @@
|
||||
use revolt_config::Settings;
|
||||
use revolt_rocket_okapi::{revolt_okapi::openapi3::OpenApi, settings::OpenApiSettings};
|
||||
use revolt_database::{util::utoipa::TokenSecurity};
|
||||
pub use rocket::http::Status;
|
||||
pub use rocket::response::Redirect;
|
||||
use rocket::{Build, Rocket};
|
||||
use rocket_authifier::SecurityAddon;
|
||||
use utoipa::{
|
||||
openapi::{extensions::ExtensionsBuilder, OpenApi},
|
||||
Modify,
|
||||
};
|
||||
|
||||
mod bots;
|
||||
mod channels;
|
||||
@@ -19,358 +24,311 @@ mod users;
|
||||
mod webhooks;
|
||||
|
||||
pub fn mount(config: Settings, mut rocket: Rocket<Build>) -> Rocket<Build> {
|
||||
let settings = OpenApiSettings::default();
|
||||
rocket = rocket
|
||||
.mount("/", routes![root::root])
|
||||
.mount("/users", users::routes())
|
||||
.mount("/bots", bots::routes())
|
||||
.mount("/channels", channels::routes())
|
||||
.mount("/servers", servers::routes())
|
||||
.mount("/invites", invites::routes())
|
||||
.mount("/custom", customisation::routes())
|
||||
.mount("/safety", safety::routes())
|
||||
.mount("/auth/account", rocket_authifier::routes::account::routes())
|
||||
.mount("/auth/session", rocket_authifier::routes::session::routes())
|
||||
.mount("/auth/mfa", rocket_authifier::routes::mfa::routes())
|
||||
.mount("/onboard", onboard::routes())
|
||||
.mount("/policy", policy::routes())
|
||||
.mount("/push", push::routes())
|
||||
.mount("/sync", sync::routes());
|
||||
|
||||
if config.features.webhooks_enabled {
|
||||
mount_endpoints_and_merged_docs! {
|
||||
rocket, "/".to_owned(), settings,
|
||||
"/" => (vec![], custom_openapi_spec()),
|
||||
"" => openapi_get_routes_spec![root::root],
|
||||
"/users" => users::routes(),
|
||||
"/bots" => bots::routes(),
|
||||
"/channels" => channels::routes(),
|
||||
"/servers" => servers::routes(),
|
||||
"/invites" => invites::routes(),
|
||||
"/custom" => customisation::routes(),
|
||||
"/safety" => safety::routes(),
|
||||
"/auth/account" => rocket_authifier::routes::account::routes(),
|
||||
"/auth/session" => rocket_authifier::routes::session::routes(),
|
||||
"/auth/mfa" => rocket_authifier::routes::mfa::routes(),
|
||||
"/onboard" => onboard::routes(),
|
||||
"/policy" => policy::routes(),
|
||||
"/push" => push::routes(),
|
||||
"/sync" => sync::routes(),
|
||||
"/webhooks" => webhooks::routes()
|
||||
};
|
||||
} else {
|
||||
mount_endpoints_and_merged_docs! {
|
||||
rocket, "/".to_owned(), settings,
|
||||
"/" => (vec![], custom_openapi_spec()),
|
||||
"" => openapi_get_routes_spec![root::root],
|
||||
"/users" => users::routes(),
|
||||
"/bots" => bots::routes(),
|
||||
"/channels" => channels::routes(),
|
||||
"/servers" => servers::routes(),
|
||||
"/invites" => invites::routes(),
|
||||
"/custom" => customisation::routes(),
|
||||
"/safety" => safety::routes(),
|
||||
"/auth/account" => rocket_authifier::routes::account::routes(),
|
||||
"/auth/session" => rocket_authifier::routes::session::routes(),
|
||||
"/auth/mfa" => rocket_authifier::routes::mfa::routes(),
|
||||
"/onboard" => onboard::routes(),
|
||||
"/policy" => policy::routes(),
|
||||
"/push" => push::routes(),
|
||||
"/sync" => sync::routes()
|
||||
};
|
||||
}
|
||||
|
||||
if config.features.webhooks_enabled {
|
||||
mount_endpoints_and_merged_docs! {
|
||||
rocket, "/0.8".to_owned(), settings,
|
||||
"/" => (vec![], custom_openapi_spec()),
|
||||
"" => openapi_get_routes_spec![root::root],
|
||||
"/users" => users::routes(),
|
||||
"/bots" => bots::routes(),
|
||||
"/channels" => channels::routes(),
|
||||
"/servers" => servers::routes(),
|
||||
"/invites" => invites::routes(),
|
||||
"/custom" => customisation::routes(),
|
||||
"/safety" => safety::routes(),
|
||||
"/auth/account" => rocket_authifier::routes::account::routes(),
|
||||
"/auth/session" => rocket_authifier::routes::session::routes(),
|
||||
"/auth/mfa" => rocket_authifier::routes::mfa::routes(),
|
||||
"/onboard" => onboard::routes(),
|
||||
"/push" => push::routes(),
|
||||
"/sync" => sync::routes(),
|
||||
"/webhooks" => webhooks::routes()
|
||||
};
|
||||
} else {
|
||||
mount_endpoints_and_merged_docs! {
|
||||
rocket, "/0.8".to_owned(), settings,
|
||||
"/" => (vec![], custom_openapi_spec()),
|
||||
"" => openapi_get_routes_spec![root::root],
|
||||
"/users" => users::routes(),
|
||||
"/bots" => bots::routes(),
|
||||
"/channels" => channels::routes(),
|
||||
"/servers" => servers::routes(),
|
||||
"/invites" => invites::routes(),
|
||||
"/custom" => customisation::routes(),
|
||||
"/safety" => safety::routes(),
|
||||
"/auth/account" => rocket_authifier::routes::account::routes(),
|
||||
"/auth/session" => rocket_authifier::routes::session::routes(),
|
||||
"/auth/mfa" => rocket_authifier::routes::mfa::routes(),
|
||||
"/onboard" => onboard::routes(),
|
||||
"/push" => push::routes(),
|
||||
"/sync" => sync::routes()
|
||||
};
|
||||
}
|
||||
rocket = rocket.mount("/webhooks", webhooks::routes());
|
||||
};
|
||||
|
||||
rocket
|
||||
}
|
||||
|
||||
fn custom_openapi_spec() -> OpenApi {
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::*;
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
info(
|
||||
title = "Stoat API",
|
||||
description = "Open source user-first chat platform.",
|
||||
terms_of_service = "https://stoat.chat/terms",
|
||||
contact(
|
||||
name = "Stoat Support",
|
||||
url = "https://stoat.chat",
|
||||
email = "contact@stoat.chat",
|
||||
),
|
||||
license(
|
||||
name = "AGPLv3",
|
||||
url = "https://github.com/stoatchat/stoatchat/blob/master/LICENSE",
|
||||
),
|
||||
),
|
||||
servers(
|
||||
(
|
||||
description = "Stoat Production",
|
||||
url = "https://stoat.chat/api",
|
||||
),
|
||||
(
|
||||
description = "Stoat Production",
|
||||
url = "https://api.stoat.chat"
|
||||
)
|
||||
),
|
||||
external_docs(
|
||||
url = "https://developers.stoat.chat",
|
||||
description = "Revolt Developer Documentation",
|
||||
),
|
||||
tags(
|
||||
(
|
||||
name = "Core",
|
||||
description = "Use in your applications to determine information about the Revolt node"
|
||||
),
|
||||
(
|
||||
name = "User Information",
|
||||
description = "Query and fetch users on Revolt"
|
||||
),
|
||||
(
|
||||
name = "Direct Messaging",
|
||||
description = "Direct message other users on Revolt"
|
||||
),
|
||||
(
|
||||
name = "Relationships",
|
||||
description = "Manage your friendships and block list on the platform"
|
||||
),
|
||||
(
|
||||
name = "Bots",
|
||||
description = "Create and edit bots"
|
||||
),
|
||||
(
|
||||
name = "Channel Information",
|
||||
description = "Query and fetch channels on Revolt"
|
||||
),
|
||||
(
|
||||
name = "Channel Invites",
|
||||
description = "Create and manage invites for channels"
|
||||
),
|
||||
(
|
||||
name = "Channel Permissions",
|
||||
description = "Manage permissions for channels"
|
||||
),
|
||||
(
|
||||
name = "Messaging",
|
||||
description = "Send and manipulate messages"
|
||||
),
|
||||
(
|
||||
name = "Groups",
|
||||
description = "Create, invite users and manipulate groups"
|
||||
),
|
||||
(
|
||||
name = "Voice",
|
||||
description = "Join and talk with other users"
|
||||
),
|
||||
(
|
||||
name = "Server Information",
|
||||
description = "Query and fetch servers on Revolt"
|
||||
),
|
||||
(
|
||||
name = "Server Members",
|
||||
description = "Find and edit server members"
|
||||
),
|
||||
(
|
||||
name = "Server Permissions",
|
||||
description = "Manage permissions for servers"
|
||||
),
|
||||
(
|
||||
name = "Invites",
|
||||
description = "View, join and delete invites"
|
||||
),
|
||||
(
|
||||
name = "Account",
|
||||
description = "Manage your account"
|
||||
),
|
||||
(
|
||||
name = "Session",
|
||||
description = "Create and manage sessions"
|
||||
),
|
||||
(
|
||||
name = "MFA",
|
||||
description = "Multi-factor Authentication"
|
||||
),
|
||||
(
|
||||
name = "Onboarding",
|
||||
description = "After signing up to Revolt, users must pick a unique username"
|
||||
),
|
||||
(
|
||||
name = "Sync",
|
||||
description = "Upload and retrieve any JSON data between clients"
|
||||
),
|
||||
(
|
||||
name = "Web Push",
|
||||
description = "Subscribe to and receive Revolt push notifications while offline"
|
||||
),
|
||||
(
|
||||
name = "Webhooks",
|
||||
description = "Send messages from 3rd party services"
|
||||
),
|
||||
),
|
||||
paths(
|
||||
root::root,
|
||||
),
|
||||
nest(
|
||||
(
|
||||
path = "/users",
|
||||
api = users::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/bots",
|
||||
api = bots::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/channels",
|
||||
api = channels::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/servers",
|
||||
api = servers::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/invites",
|
||||
api = invites::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/custom",
|
||||
api = customisation::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/safety",
|
||||
api = safety::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/auth/account",
|
||||
api = rocket_authifier::routes::account::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/auth/session",
|
||||
api = rocket_authifier::routes::session::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/auth/mfa",
|
||||
api = rocket_authifier::routes::mfa::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/onboard",
|
||||
api = onboard::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/policy",
|
||||
api = policy::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/push",
|
||||
api = push::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/sync",
|
||||
api = sync::ApiDoc,
|
||||
),
|
||||
(
|
||||
path = "/webhooks",
|
||||
api = webhooks::ApiDoc,
|
||||
),
|
||||
|
||||
let mut extensions = schemars::Map::new();
|
||||
extensions.insert(
|
||||
"x-logo".to_owned(),
|
||||
json!({
|
||||
"url": "https://revolt.chat/header.png",
|
||||
"altText": "Revolt Header"
|
||||
}),
|
||||
);
|
||||
),
|
||||
modifiers(
|
||||
&Extensions,
|
||||
&SecurityAddon,
|
||||
&TokenSecurity,
|
||||
),
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
extensions.insert(
|
||||
"x-tagGroups".to_owned(),
|
||||
json!([
|
||||
{
|
||||
"name": "Revolt",
|
||||
"tags": [
|
||||
"Core"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Users",
|
||||
"tags": [
|
||||
"User Information",
|
||||
"Direct Messaging",
|
||||
"Relationships"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Bots",
|
||||
"tags": [
|
||||
"Bots"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Channels",
|
||||
"tags": [
|
||||
"Channel Information",
|
||||
"Channel Invites",
|
||||
"Channel Permissions",
|
||||
"Messaging",
|
||||
"Interactions",
|
||||
"Groups",
|
||||
"Voice",
|
||||
"Webhooks",
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Servers",
|
||||
"tags": [
|
||||
"Server Information",
|
||||
"Server Members",
|
||||
"Server Permissions"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Invites",
|
||||
"tags": [
|
||||
"Invites"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Customisation",
|
||||
"tags": [
|
||||
"Emojis"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Platform Administration",
|
||||
"tags": [
|
||||
"Admin",
|
||||
"User Safety"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Authentication",
|
||||
"tags": [
|
||||
"Account",
|
||||
"Session",
|
||||
"Onboarding",
|
||||
"MFA"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Miscellaneous",
|
||||
"tags": [
|
||||
"Sync",
|
||||
"Web Push"
|
||||
]
|
||||
}
|
||||
]),
|
||||
);
|
||||
|
||||
OpenApi {
|
||||
openapi: OpenApi::default_version(),
|
||||
info: Info {
|
||||
title: "Revolt API".to_owned(),
|
||||
description: Some("Open source user-first chat platform.".to_owned()),
|
||||
terms_of_service: Some("https://revolt.chat/terms".to_owned()),
|
||||
contact: Some(Contact {
|
||||
name: Some("Revolt Support".to_owned()),
|
||||
url: Some("https://revolt.chat".to_owned()),
|
||||
email: Some("contact@revolt.chat".to_owned()),
|
||||
..Default::default()
|
||||
}),
|
||||
license: Some(License {
|
||||
name: "AGPLv3".to_owned(),
|
||||
url: Some("https://github.com/revoltchat/delta/blob/master/LICENSE".to_owned()),
|
||||
..Default::default()
|
||||
}),
|
||||
version: env!("CARGO_PKG_VERSION").to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
servers: vec![
|
||||
Server {
|
||||
url: "https://api.revolt.chat".to_owned(),
|
||||
description: Some("Revolt Production".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Server {
|
||||
url: "https://revolt.chat/api".to_owned(),
|
||||
description: Some("Revolt Staging".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Server {
|
||||
url: "http://local.revolt.chat:14702".to_owned(),
|
||||
description: Some("Local Revolt Environment".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Server {
|
||||
url: "http://local.revolt.chat:14702/0.8".to_owned(),
|
||||
description: Some("Local Revolt Environment (v0.8)".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
],
|
||||
external_docs: Some(ExternalDocs {
|
||||
url: "https://developers.revolt.chat".to_owned(),
|
||||
description: Some("Revolt Developer Documentation".to_owned()),
|
||||
..Default::default()
|
||||
}),
|
||||
extensions,
|
||||
tags: vec![
|
||||
Tag {
|
||||
name: "Core".to_owned(),
|
||||
description: Some(
|
||||
"Use in your applications to determine information about the Revolt node"
|
||||
.to_owned(),
|
||||
),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "User Information".to_owned(),
|
||||
description: Some("Query and fetch users on Revolt".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Direct Messaging".to_owned(),
|
||||
description: Some("Direct message other users on Revolt".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Relationships".to_owned(),
|
||||
description: Some(
|
||||
"Manage your friendships and block list on the platform".to_owned(),
|
||||
),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Bots".to_owned(),
|
||||
description: Some("Create and edit bots".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Channel Information".to_owned(),
|
||||
description: Some("Query and fetch channels on Revolt".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Channel Invites".to_owned(),
|
||||
description: Some("Create and manage invites for channels".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Channel Permissions".to_owned(),
|
||||
description: Some("Manage permissions for channels".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Messaging".to_owned(),
|
||||
description: Some("Send and manipulate messages".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Groups".to_owned(),
|
||||
description: Some("Create, invite users and manipulate groups".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Voice".to_owned(),
|
||||
description: Some("Join and talk with other users".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Server Information".to_owned(),
|
||||
description: Some("Query and fetch servers on Revolt".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Server Members".to_owned(),
|
||||
description: Some("Find and edit server members".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Server Permissions".to_owned(),
|
||||
description: Some("Manage permissions for servers".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Invites".to_owned(),
|
||||
description: Some("View, join and delete invites".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Account".to_owned(),
|
||||
description: Some("Manage your account".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Session".to_owned(),
|
||||
description: Some("Create and manage sessions".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "MFA".to_owned(),
|
||||
description: Some("Multi-factor Authentication".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Onboarding".to_owned(),
|
||||
description: Some(
|
||||
"After signing up to Revolt, users must pick a unique username".to_owned(),
|
||||
),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Sync".to_owned(),
|
||||
description: Some("Upload and retrieve any JSON data between clients".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Web Push".to_owned(),
|
||||
description: Some(
|
||||
"Subscribe to and receive Revolt push notifications while offline".to_owned(),
|
||||
),
|
||||
..Default::default()
|
||||
},
|
||||
Tag {
|
||||
name: "Webhooks".to_owned(),
|
||||
description: Some("Send messages from 3rd party services".to_owned()),
|
||||
..Default::default()
|
||||
},
|
||||
],
|
||||
..Default::default()
|
||||
struct Extensions;
|
||||
impl Modify for Extensions {
|
||||
fn modify(&self, utoipa: &mut OpenApi) {
|
||||
utoipa.extensions = Some(
|
||||
ExtensionsBuilder::new()
|
||||
.add(
|
||||
"tagGroups",
|
||||
json!([
|
||||
{
|
||||
"name": "Revolt",
|
||||
"tags": [
|
||||
"Core"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Users",
|
||||
"tags": [
|
||||
"User Information",
|
||||
"Direct Messaging",
|
||||
"Relationships"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Bots",
|
||||
"tags": [
|
||||
"Bots"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Channels",
|
||||
"tags": [
|
||||
"Channel Information",
|
||||
"Channel Invites",
|
||||
"Channel Permissions",
|
||||
"Messaging",
|
||||
"Interactions",
|
||||
"Groups",
|
||||
"Voice",
|
||||
"Webhooks",
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Servers",
|
||||
"tags": [
|
||||
"Server Information",
|
||||
"Server Members",
|
||||
"Server Permissions"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Invites",
|
||||
"tags": [
|
||||
"Invites"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Customisation",
|
||||
"tags": [
|
||||
"Emojis"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Platform Administration",
|
||||
"tags": [
|
||||
"Admin",
|
||||
"User Safety"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Authentication",
|
||||
"tags": [
|
||||
"Account",
|
||||
"Session",
|
||||
"Onboarding",
|
||||
"MFA"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Miscellaneous",
|
||||
"tags": [
|
||||
"Sync",
|
||||
"Web Push"
|
||||
]
|
||||
}
|
||||
]),
|
||||
)
|
||||
.build(),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user