Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7780aa69c0 | ||
|
|
d198796fde | ||
|
|
43c94b68b0 | ||
|
|
ac60b2c795 |
Generated
+314
-319
File diff suppressed because it is too large
Load Diff
+3
-2
@@ -11,8 +11,9 @@ members = [
|
||||
|
||||
[patch.crates-io]
|
||||
redis23 = { package = "redis", version = "0.23.3", git = "https://github.com/revoltchat/redis-rs", rev = "523b2937367e17bd0073722bf6e23d06042cb4e4" }
|
||||
#authifier = { package = "authifier", version = "1.0.10", path = "../authifier/crates/authifier" }
|
||||
#rocket_authifier = { package = "rocket_authifier", version = "1.0.10", path = "../authifier/crates/rocket_authifier" }
|
||||
authifier = { package = "authifier", version = "1.0.10", path = "../authifier/crates/authifier" }
|
||||
rocket_authifier = { package = "rocket_authifier", version = "1.0.10", path = "../authifier/crates/rocket_authifier" }
|
||||
iso8601-timestamp = { path = "../iso8601-timestamp" }
|
||||
|
||||
# I'm 99% sure this is overloading the GitHub worker
|
||||
# hence builds have been failing since, let's just
|
||||
|
||||
@@ -15,7 +15,7 @@ use crate::{CoalescionServiceConfig, Error};
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
#[allow(clippy::type_complexity)]
|
||||
/// # Coalescion service
|
||||
/// Coalescion service
|
||||
///
|
||||
/// See module description for example usage.
|
||||
pub struct CoalescionService<Id: Hash + Clone + Eq> {
|
||||
|
||||
@@ -38,6 +38,3 @@ sentry-anyhow = { version = "0.38.1", optional = true }
|
||||
|
||||
# Core
|
||||
revolt-result = { version = "0.8.9", path = "../result", optional = true }
|
||||
|
||||
# Authifier
|
||||
authifier = "1.0.15"
|
||||
@@ -74,8 +74,6 @@ max_concurrent_connections = 50
|
||||
# How long to ring devices for when calling in dms/groups, in seconds
|
||||
call_ring_duration = 30
|
||||
|
||||
[api.sso]
|
||||
|
||||
[api.livekit.nodes]
|
||||
|
||||
[api.users]
|
||||
|
||||
@@ -5,7 +5,6 @@ use config::{Config, File, FileFormat};
|
||||
use futures_locks::RwLock;
|
||||
use once_cell::sync::Lazy;
|
||||
use serde::Deserialize;
|
||||
use authifier::config::SSO;
|
||||
|
||||
#[cfg(feature = "sentry")]
|
||||
pub use sentry::{capture_error, capture_message, Level};
|
||||
@@ -230,7 +229,6 @@ pub struct Api {
|
||||
pub workers: ApiWorkers,
|
||||
pub livekit: ApiLiveKit,
|
||||
pub users: ApiUsers,
|
||||
pub sso: SSO,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
|
||||
@@ -15,7 +15,7 @@ mongodb = ["dep:mongodb", "bson", "authifier/database-mongodb"]
|
||||
# ... Other
|
||||
tasks = ["isahc", "linkify", "url-escape"]
|
||||
async-std-runtime = ["async-std", "authifier/async-std-runtime"]
|
||||
rocket-impl = ["rocket", "schemars", "revolt_okapi", "revolt_rocket_okapi", "authifier/rocket_impl"]
|
||||
rocket-impl = ["rocket"]
|
||||
axum-impl = ["axum"]
|
||||
redis-is-patched = ["revolt-presence/redis-is-patched"]
|
||||
voice = ["livekit-api", "livekit-protocol", "livekit-runtime"]
|
||||
@@ -47,7 +47,7 @@ ulid = "1.0.0"
|
||||
nanoid = "0.4.0"
|
||||
base64 = "0.21.3"
|
||||
once_cell = "1.17"
|
||||
indexmap = "1.9.1"
|
||||
indexmap = "2.12.0"
|
||||
decancer = "1.6.2"
|
||||
deadqueue = "0.2.4"
|
||||
linkify = { optional = true, version = "0.8.1" }
|
||||
@@ -59,7 +59,7 @@ isahc = { optional = true, version = "1.7", features = ["json"] }
|
||||
serde_json = "1"
|
||||
revolt_optional_struct = "0.2.0"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
iso8601-timestamp = { version = "0.2.10", features = ["serde", "bson"] }
|
||||
iso8601-timestamp = { version = "0.4.0", features = ["serde", "bson"] }
|
||||
|
||||
# Events
|
||||
redis-kiss = { version = "0.1.4" }
|
||||
@@ -82,15 +82,15 @@ async-recursion = "1.0.4"
|
||||
async-std = { version = "1.8.0", features = ["attributes"], optional = true }
|
||||
|
||||
# Axum Impl
|
||||
axum = { version = "0.7.5", optional = true }
|
||||
axum = { version = "0.8.6", optional = true }
|
||||
|
||||
# Rocket Impl
|
||||
schemars = { version = "0.8.8", optional = true }
|
||||
rocket = { version = "0.5.1", default-features = false, features = [
|
||||
"json",
|
||||
], optional = true }
|
||||
revolt_okapi = { version = "0.9.1", optional = true }
|
||||
revolt_rocket_okapi = { version = "0.10.0", optional = true }
|
||||
|
||||
# Openapi Schema
|
||||
utoipa = { version = "5.4.0", optional = true }
|
||||
|
||||
# Authifier
|
||||
authifier = { version = "1.0.15" }
|
||||
@@ -99,6 +99,6 @@ authifier = { version = "1.0.15" }
|
||||
amqprs = { version = "1.7.0" }
|
||||
|
||||
# Voice
|
||||
livekit-api = { version = "0.4.4", optional = true}
|
||||
livekit-protocol = { version = "0.4.0", optional = true }
|
||||
livekit-runtime = { version = "0.3.1", features = ["tokio"], optional = true }
|
||||
livekit-api = { version = "=0.4.4", optional = true}
|
||||
livekit-protocol = { version = "=0.4.0", optional = true }
|
||||
livekit-runtime = { version = "=0.3.1", features = ["tokio"], optional = true }
|
||||
|
||||
@@ -209,8 +209,6 @@ impl Database {
|
||||
} else {
|
||||
EmailVerificationConfig::Disabled
|
||||
},
|
||||
sso: config.api.sso.clone(),
|
||||
server_url: Some(config.hosts.api.parse().expect("Failed to parse API host url.")),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
@@ -246,7 +244,6 @@ impl Database {
|
||||
event_channel: Some(crate::tasks::authifier_relay::sender()),
|
||||
#[cfg(not(feature = "tasks"))]
|
||||
event_channel: None,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,6 +25,10 @@ pub use mongodb;
|
||||
#[macro_use]
|
||||
extern crate bson;
|
||||
|
||||
#[cfg(feature = "utoipa")]
|
||||
#[macro_use]
|
||||
extern crate utoipa;
|
||||
|
||||
#[cfg(not(feature = "async-std-runtime"))]
|
||||
compile_error!("async-std-runtime feature must be enabled.");
|
||||
|
||||
@@ -60,7 +64,7 @@ macro_rules! database_derived {
|
||||
macro_rules! auto_derived {
|
||||
( $( $item:item )+ ) => {
|
||||
$(
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
|
||||
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
|
||||
$item
|
||||
)+
|
||||
};
|
||||
@@ -68,8 +72,8 @@ macro_rules! auto_derived {
|
||||
|
||||
macro_rules! auto_derived_partial {
|
||||
( $item:item, $name:expr ) => {
|
||||
#[derive(OptionalStruct, Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
|
||||
#[optional_derive(Serialize, Deserialize, Debug, Clone, Default, Eq, PartialEq)]
|
||||
#[derive(OptionalStruct, Serialize, Deserialize, Debug, Clone, PartialEq)]
|
||||
#[optional_derive(Serialize, Deserialize, Debug, Clone, Default, PartialEq)]
|
||||
#[optional_name = $name]
|
||||
#[opt_skip_serializing_none]
|
||||
#[opt_some_priority]
|
||||
|
||||
@@ -14,7 +14,7 @@ auto_derived!(
|
||||
}
|
||||
|
||||
/// Composite primary key consisting of channel and user id
|
||||
#[derive(Hash)]
|
||||
#[derive(Hash, Eq)]
|
||||
pub struct ChannelCompositeKey {
|
||||
/// Channel Id
|
||||
pub channel: String,
|
||||
|
||||
@@ -247,7 +247,7 @@ impl AbstractMessages for ReferenceDb {
|
||||
let mut messages = self.messages.lock().await;
|
||||
if let Some(message) = messages.get_mut(id) {
|
||||
if let Some(users) = message.reactions.get_mut(emoji) {
|
||||
users.remove(&user.to_string());
|
||||
users.swap_remove(&user.to_string());
|
||||
}
|
||||
|
||||
Ok(())
|
||||
@@ -260,7 +260,7 @@ impl AbstractMessages for ReferenceDb {
|
||||
async fn clear_reaction(&self, id: &str, emoji: &str) -> Result<()> {
|
||||
let mut messages = self.messages.lock().await;
|
||||
if let Some(message) = messages.get_mut(id) {
|
||||
message.reactions.remove(emoji);
|
||||
message.reactions.swap_remove(emoji);
|
||||
Ok(())
|
||||
} else {
|
||||
Err(create_error!(NotFound))
|
||||
|
||||
@@ -55,7 +55,7 @@ auto_derived_partial!(
|
||||
|
||||
auto_derived!(
|
||||
/// Composite primary key consisting of server and user id
|
||||
#[derive(Hash, Default)]
|
||||
#[derive(Hash, Default, Eq)]
|
||||
pub struct MemberCompositeKey {
|
||||
/// Server Id
|
||||
pub server: String,
|
||||
|
||||
@@ -4,7 +4,6 @@ use revolt_result::{create_error, Error, Result};
|
||||
|
||||
use crate::{Database, User};
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl<S> FromRequestParts<S> for User
|
||||
where
|
||||
Database: FromRef<S>,
|
||||
|
||||
@@ -4,8 +4,6 @@ mod model;
|
||||
mod ops;
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
mod rocket;
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
mod schema;
|
||||
|
||||
pub use model::*;
|
||||
pub use ops::*;
|
||||
|
||||
@@ -15,7 +15,7 @@ use serde_json::json;
|
||||
use ulid::Ulid;
|
||||
|
||||
auto_derived_partial!(
|
||||
/// # User
|
||||
/// User
|
||||
pub struct User {
|
||||
/// Unique Id
|
||||
#[serde(rename = "_id")]
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
use revolt_okapi::openapi3::{SecurityScheme, SecuritySchemeData};
|
||||
use revolt_rocket_okapi::{
|
||||
gen::OpenApiGenerator,
|
||||
request::{OpenApiFromRequest, RequestHeaderInput},
|
||||
};
|
||||
|
||||
use crate::User;
|
||||
|
||||
impl OpenApiFromRequest<'_> for User {
|
||||
fn from_request_input(
|
||||
_gen: &mut OpenApiGenerator,
|
||||
_name: String,
|
||||
_required: bool,
|
||||
) -> revolt_rocket_okapi::Result<RequestHeaderInput> {
|
||||
let mut requirements = schemars::Map::new();
|
||||
requirements.insert("Session Token".to_owned(), vec![]);
|
||||
|
||||
Ok(RequestHeaderInput::Security(
|
||||
"Session Token".to_owned(),
|
||||
SecurityScheme {
|
||||
data: SecuritySchemeData::ApiKey {
|
||||
name: "x-session-token".to_owned(),
|
||||
location: "header".to_owned(),
|
||||
},
|
||||
description: Some("Used to authenticate as a user.".to_owned()),
|
||||
extensions: schemars::Map::new(),
|
||||
},
|
||||
requirements,
|
||||
))
|
||||
}
|
||||
}
|
||||
@@ -17,7 +17,7 @@ use super::DelayedTask;
|
||||
use crate::Channel::TextChannel;
|
||||
|
||||
/// Enumeration of possible events
|
||||
#[derive(Debug, Eq, PartialEq)]
|
||||
#[derive(Debug, PartialEq)]
|
||||
pub enum AckEvent {
|
||||
/// Add mentions for a channel
|
||||
ProcessMessage {
|
||||
|
||||
@@ -10,16 +10,16 @@ use once_cell::sync::Lazy;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct IdempotencyKey {
|
||||
key: String,
|
||||
}
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
#[cfg_attr(feature = "utoipa", into_params(names("Idempotency-Key"), parameter_in=Header))]
|
||||
pub struct IdempotencyKey(String);
|
||||
|
||||
static TOKEN_CACHE: Lazy<Mutex<lru::LruCache<String, ()>>> =
|
||||
Lazy::new(|| Mutex::new(lru::LruCache::new(NonZeroUsize::new(1000).unwrap())));
|
||||
|
||||
impl IdempotencyKey {
|
||||
pub fn unchecked_from_string(key: String) -> Self {
|
||||
Self { key }
|
||||
Self(key)
|
||||
}
|
||||
|
||||
// Backwards compatibility.
|
||||
@@ -32,56 +32,56 @@ impl IdempotencyKey {
|
||||
}
|
||||
|
||||
cache.put(v.clone(), ());
|
||||
self.key = v;
|
||||
self.0 = v;
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn into_key(self) -> String {
|
||||
self.key
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
use revolt_rocket_okapi::{
|
||||
gen::OpenApiGenerator,
|
||||
request::{OpenApiFromRequest, RequestHeaderInput},
|
||||
revolt_okapi::openapi3::{Parameter, ParameterValue},
|
||||
};
|
||||
// #[cfg(feature = "rocket-impl")]
|
||||
// use revolt_rocket_okapi::{
|
||||
// gen::OpenApiGenerator,
|
||||
// request::{OpenApiFromRequest, RequestHeaderInput},
|
||||
// revolt_okapi::openapi3::{Parameter, ParameterValue},
|
||||
// };
|
||||
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
use schemars::schema::{InstanceType, SchemaObject, SingleOrVec};
|
||||
// #[cfg(feature = "rocket-impl")]
|
||||
// use schemars::schema::{InstanceType, SchemaObject, SingleOrVec};
|
||||
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
impl OpenApiFromRequest<'_> for IdempotencyKey {
|
||||
fn from_request_input(
|
||||
_gen: &mut OpenApiGenerator,
|
||||
_name: String,
|
||||
_required: bool,
|
||||
) -> revolt_rocket_okapi::Result<RequestHeaderInput> {
|
||||
Ok(RequestHeaderInput::Parameter(Parameter {
|
||||
name: "Idempotency-Key".to_string(),
|
||||
description: Some("Unique key to prevent duplicate requests".to_string()),
|
||||
allow_empty_value: false,
|
||||
required: false,
|
||||
deprecated: false,
|
||||
extensions: schemars::Map::new(),
|
||||
location: "header".to_string(),
|
||||
value: ParameterValue::Schema {
|
||||
allow_reserved: false,
|
||||
example: None,
|
||||
examples: None,
|
||||
explode: None,
|
||||
style: None,
|
||||
schema: SchemaObject {
|
||||
instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
|
||||
..Default::default()
|
||||
},
|
||||
},
|
||||
}))
|
||||
}
|
||||
}
|
||||
// #[cfg(feature = "rocket-impl")]
|
||||
// impl OpenApiFromRequest<'_> for IdempotencyKey {
|
||||
// fn from_request_input(
|
||||
// _gen: &mut OpenApiGenerator,
|
||||
// _name: String,
|
||||
// _required: bool,
|
||||
// ) -> revolt_rocket_okapi::Result<RequestHeaderInput> {
|
||||
// Ok(RequestHeaderInput::Parameter(Parameter {
|
||||
// name: "Idempotency-Key".to_string(),
|
||||
// description: Some("Unique key to prevent duplicate requests".to_string()),
|
||||
// allow_empty_value: false,
|
||||
// required: false,
|
||||
// deprecated: false,
|
||||
// extensions: schemars::Map::new(),
|
||||
// location: "header".to_string(),
|
||||
// value: ParameterValue::Schema {
|
||||
// allow_reserved: false,
|
||||
// example: None,
|
||||
// examples: None,
|
||||
// explode: None,
|
||||
// style: None,
|
||||
// schema: SchemaObject {
|
||||
// instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
|
||||
// ..Default::default()
|
||||
// },
|
||||
// },
|
||||
// }))
|
||||
// }
|
||||
// }
|
||||
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
use rocket::{
|
||||
@@ -110,18 +110,16 @@ impl<'r> FromRequest<'r> for IdempotencyKey {
|
||||
));
|
||||
}
|
||||
|
||||
let idempotency = IdempotencyKey { key };
|
||||
let idempotency = IdempotencyKey(key);
|
||||
let mut cache = TOKEN_CACHE.lock().await;
|
||||
if cache.get(&idempotency.key).is_some() {
|
||||
if cache.get(&idempotency.0).is_some() {
|
||||
return Outcome::Error((Status::Conflict, create_error!(DuplicateNonce)));
|
||||
}
|
||||
|
||||
cache.put(idempotency.key.clone(), ());
|
||||
cache.put(idempotency.0.clone(), ());
|
||||
return Outcome::Success(idempotency);
|
||||
}
|
||||
|
||||
Outcome::Success(IdempotencyKey {
|
||||
key: ulid::Ulid::new().to_string(),
|
||||
})
|
||||
Outcome::Success(IdempotencyKey(ulid::Ulid::new().to_string()))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,5 +5,7 @@ pub mod idempotency;
|
||||
pub mod permissions;
|
||||
pub mod reference;
|
||||
pub mod test_fixtures;
|
||||
#[cfg(feature = "utoipa")]
|
||||
pub mod utoipa;
|
||||
|
||||
pub use funcs::*;
|
||||
|
||||
@@ -3,11 +3,6 @@ use std::str::FromStr;
|
||||
use revolt_result::Result;
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
use rocket::request::FromParam;
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
use schemars::{
|
||||
schema::{InstanceType, Schema, SchemaObject, SingleOrVec},
|
||||
JsonSchema,
|
||||
};
|
||||
|
||||
use crate::{
|
||||
Bot, Channel, Database, Emoji, Invite, Member, Message, Server, ServerBan, User, Webhook,
|
||||
@@ -112,17 +107,3 @@ impl<'r> FromParam<'r> for Reference<'r> {
|
||||
Ok(Reference::from_unchecked(param))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rocket-impl")]
|
||||
impl<'a> JsonSchema for Reference<'a> {
|
||||
fn schema_name() -> String {
|
||||
"Id".to_string()
|
||||
}
|
||||
|
||||
fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> Schema {
|
||||
Schema::Object(SchemaObject {
|
||||
instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
|
||||
..Default::default()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
use utoipa::{
|
||||
openapi::{
|
||||
schema::SchemaType,
|
||||
security::{ApiKey, ApiKeyValue, SecurityScheme},
|
||||
ObjectBuilder, OpenApi, RefOr, Schema, Type,
|
||||
},
|
||||
Modify, PartialSchema, ToSchema,
|
||||
};
|
||||
|
||||
use crate::util::reference::Reference;
|
||||
|
||||
pub struct TokenSecurity;
|
||||
|
||||
impl Modify for TokenSecurity {
|
||||
fn modify(&self, openapi: &mut OpenApi) {
|
||||
let components = openapi.components.get_or_insert_default();
|
||||
|
||||
components.add_security_scheme(
|
||||
"Session-Token",
|
||||
SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::new(
|
||||
"X-Session-Token".to_string(),
|
||||
))),
|
||||
);
|
||||
|
||||
components.add_security_scheme(
|
||||
"Bot-Token",
|
||||
SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::new("X-Bot-Ticket".to_string()))),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
impl ToSchema for Reference<'_> {
|
||||
fn name() -> std::borrow::Cow<'static, str> {
|
||||
std::borrow::Cow::Borrowed("Reference")
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialSchema for Reference<'_> {
|
||||
fn schema() -> RefOr<Schema> {
|
||||
RefOr::T(
|
||||
ObjectBuilder::new()
|
||||
.description(Some("An id referencing a stoat model."))
|
||||
.schema_type(SchemaType::Type(Type::String))
|
||||
.examples(["01FD58YK5W7QRV5H3D64KTQYX3"])
|
||||
.build()
|
||||
.into(),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -10,22 +10,22 @@ description = "Revolt Backend: API Models"
|
||||
|
||||
[features]
|
||||
serde = ["dep:serde", "revolt-permissions/serde", "indexmap/serde"]
|
||||
schemas = ["dep:schemars", "revolt-permissions/schemas"]
|
||||
utoipa = ["dep:utoipa"]
|
||||
validator = ["dep:validator"]
|
||||
rocket = ["dep:rocket"]
|
||||
partials = ["dep:revolt_optional_struct", "serde", "schemas", "utoipa"]
|
||||
partials = ["dep:revolt_optional_struct", "serde", "utoipa"]
|
||||
|
||||
default = ["serde", "partials", "rocket"]
|
||||
|
||||
[dependencies]
|
||||
# Core
|
||||
revolt-config = { version = "0.8.9", path = "../config" }
|
||||
revolt-permissions = { version = "0.8.9", path = "../permissions" }
|
||||
revolt-permissions = { version = "0.8.9", path = "../permissions", features = [
|
||||
"utoipa",
|
||||
] }
|
||||
|
||||
# Utility
|
||||
regex = "1.11"
|
||||
indexmap = "1.9.3"
|
||||
indexmap = "2.12.0"
|
||||
once_cell = "1.17.1"
|
||||
num_enum = "0.6.1"
|
||||
|
||||
@@ -35,11 +35,10 @@ rocket = { optional = true, version = "0.5.0-rc.2", default-features = false }
|
||||
# Serialisation
|
||||
revolt_optional_struct = { version = "0.2.0", optional = true }
|
||||
serde = { version = "1", features = ["derive"], optional = true }
|
||||
iso8601-timestamp = { version = "0.2.11", features = ["schema", "bson"] }
|
||||
iso8601-timestamp = { version = "0.4.0", features = ["utoipa", "bson"] }
|
||||
|
||||
# Spec Generation
|
||||
schemars = { version = "0.8.8", optional = true, features = ["indexmap1"] }
|
||||
utoipa = { version = "4.2.3", optional = true }
|
||||
utoipa = { version = "5.4.0", features = ["indexmap"], optional = true }
|
||||
|
||||
# Validation
|
||||
validator = { version = "0.16.0", optional = true, features = ["derive"] }
|
||||
|
||||
@@ -2,10 +2,6 @@
|
||||
#[macro_use]
|
||||
extern crate serde;
|
||||
|
||||
#[cfg(feature = "schemas")]
|
||||
#[macro_use]
|
||||
extern crate schemars;
|
||||
|
||||
#[cfg(feature = "utoipa")]
|
||||
#[macro_use]
|
||||
extern crate utoipa;
|
||||
@@ -21,9 +17,8 @@ macro_rules! auto_derived {
|
||||
( $( $item:item )+ ) => {
|
||||
$(
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
$item
|
||||
)+
|
||||
};
|
||||
@@ -32,19 +27,8 @@ macro_rules! auto_derived {
|
||||
#[cfg(feature = "partials")]
|
||||
macro_rules! auto_derived_partial {
|
||||
( $item:item, $name:expr ) => {
|
||||
#[derive(
|
||||
OptionalStruct, Debug, Clone, Eq, PartialEq, Serialize, Deserialize, JsonSchema,
|
||||
)]
|
||||
#[optional_derive(
|
||||
Debug,
|
||||
Clone,
|
||||
Eq,
|
||||
PartialEq,
|
||||
Serialize,
|
||||
Deserialize,
|
||||
JsonSchema,
|
||||
Default
|
||||
)]
|
||||
#[derive(OptionalStruct, Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
|
||||
#[optional_derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema, Default)]
|
||||
#[optional_name = $name]
|
||||
#[opt_skip_serializing_none]
|
||||
#[opt_some_priority]
|
||||
@@ -55,7 +39,7 @@ macro_rules! auto_derived_partial {
|
||||
#[cfg(not(feature = "partials"))]
|
||||
macro_rules! auto_derived_partial {
|
||||
( $item:item, $name:expr ) => {
|
||||
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
|
||||
$item
|
||||
};
|
||||
}
|
||||
|
||||
@@ -86,10 +86,10 @@ auto_derived!(
|
||||
/// Information for the webhook
|
||||
#[cfg_attr(feature = "validator", derive(Validate))]
|
||||
pub struct CreateWebhookBody {
|
||||
#[validate(length(min = 1, max = 32))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 32)))]
|
||||
pub name: String,
|
||||
|
||||
#[validate(length(min = 1, max = 128))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 128)))]
|
||||
pub avatar: Option<String>,
|
||||
}
|
||||
);
|
||||
|
||||
@@ -271,6 +271,7 @@ auto_derived!(
|
||||
|
||||
/// Options when deleting a channel
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsChannelDelete {
|
||||
/// Whether to not send a leave message
|
||||
pub leave_silently: Option<bool>,
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
auto_derived!(
|
||||
/// hCaptcha Configuration
|
||||
pub struct CaptchaFeature {
|
||||
/// Whether captcha is enabled
|
||||
pub enabled: bool,
|
||||
/// Client key used for solving captcha
|
||||
pub key: String,
|
||||
}
|
||||
|
||||
/// Generic Service Configuration
|
||||
pub struct Feature {
|
||||
/// Whether the service is enabled
|
||||
pub enabled: bool,
|
||||
/// URL pointing to the service
|
||||
pub url: String,
|
||||
}
|
||||
|
||||
/// # Information about a livekit node
|
||||
pub struct VoiceNode {
|
||||
pub name: String,
|
||||
pub lat: f64,
|
||||
pub lon: f64,
|
||||
pub public_url: String,
|
||||
}
|
||||
|
||||
/// # Voice Server Configuration
|
||||
pub struct VoiceFeature {
|
||||
/// Whether voice is enabled
|
||||
pub enabled: bool,
|
||||
/// All livekit nodes
|
||||
pub nodes: Vec<VoiceNode>,
|
||||
}
|
||||
/// Feature Configuration
|
||||
pub struct RevoltFeatures {
|
||||
/// hCaptcha configuration
|
||||
pub captcha: CaptchaFeature,
|
||||
/// Whether email verification is enabled
|
||||
pub email: bool,
|
||||
/// Whether this server is invite only
|
||||
pub invite_only: bool,
|
||||
/// File server service configuration
|
||||
pub autumn: Feature,
|
||||
/// Proxy service configuration
|
||||
pub january: Feature,
|
||||
/// Voice server configuration
|
||||
pub livekit: VoiceFeature,
|
||||
}
|
||||
|
||||
/// Build Information
|
||||
pub struct BuildInformation {
|
||||
/// Commit Hash
|
||||
pub commit_sha: String,
|
||||
/// Commit Timestamp
|
||||
pub commit_timestamp: String,
|
||||
/// Git Semver
|
||||
pub semver: String,
|
||||
/// Git Origin URL
|
||||
pub origin_url: String,
|
||||
/// Build Timestamp
|
||||
pub timestamp: String,
|
||||
}
|
||||
|
||||
/// Server Configuration
|
||||
pub struct RevoltConfig {
|
||||
/// Revolt API Version
|
||||
pub revolt: String,
|
||||
/// Features enabled on this Revolt node
|
||||
pub features: RevoltFeatures,
|
||||
/// WebSocket URL
|
||||
pub ws: String,
|
||||
/// URL pointing to the client serving this node
|
||||
pub app: String,
|
||||
/// Web Push VAPID public key
|
||||
pub vapid: String,
|
||||
/// Build information
|
||||
pub build: BuildInformation,
|
||||
}
|
||||
);
|
||||
@@ -46,7 +46,7 @@ auto_derived!(
|
||||
#[cfg_attr(feature = "validator", derive(Validate))]
|
||||
pub struct DataCreateEmoji {
|
||||
/// Server name
|
||||
#[validate(length(min = 1, max = 32), regex = "RE_EMOJI")]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 32), regex = "RE_EMOJI"))]
|
||||
pub name: String,
|
||||
/// Parent information
|
||||
pub parent: EmojiParent,
|
||||
|
||||
@@ -141,17 +141,17 @@ auto_derived!(
|
||||
pub struct Masquerade {
|
||||
/// Replace the display name shown on this message
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[validate(length(min = 1, max = 32))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 32)))]
|
||||
pub name: Option<String>,
|
||||
/// Replace the avatar shown on this message (URL to image file)
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[validate(length(min = 1, max = 256))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 256)))]
|
||||
pub avatar: Option<String>,
|
||||
/// Replace the display role colour shown on this message
|
||||
///
|
||||
/// Must have `ManageRole` permission to use
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[validate(length(min = 1, max = 128), regex = "RE_COLOUR")]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 128), regex = "RE_COLOUR"))]
|
||||
pub colour: Option<String>,
|
||||
}
|
||||
|
||||
@@ -281,6 +281,7 @@ auto_derived!(
|
||||
/// Options for querying messages
|
||||
#[cfg_attr(feature = "validator", derive(Validate))]
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsQueryMessages {
|
||||
/// Maximum number of messages to fetch
|
||||
///
|
||||
@@ -353,12 +354,13 @@ auto_derived!(
|
||||
)]
|
||||
pub struct OptionsBulkDelete {
|
||||
/// Message IDs
|
||||
#[validate(length(min = 1, max = 100))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 100)))]
|
||||
pub ids: Vec<String>,
|
||||
}
|
||||
|
||||
/// Options for removing reaction
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsUnreact {
|
||||
/// Remove a specific user's reaction
|
||||
pub user_id: Option<String>,
|
||||
|
||||
@@ -3,6 +3,7 @@ mod channel_invites;
|
||||
mod channel_unreads;
|
||||
mod channel_webhooks;
|
||||
mod channels;
|
||||
mod config;
|
||||
mod embeds;
|
||||
mod emojis;
|
||||
mod files;
|
||||
@@ -20,6 +21,7 @@ pub use channel_invites::*;
|
||||
pub use channel_unreads::*;
|
||||
pub use channel_webhooks::*;
|
||||
pub use channels::*;
|
||||
pub use config::*;
|
||||
pub use embeds::*;
|
||||
pub use emojis::*;
|
||||
pub use files::*;
|
||||
|
||||
@@ -116,6 +116,7 @@ auto_derived!(
|
||||
|
||||
/// Options for fetching all members
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsFetchAllMembers {
|
||||
/// Whether to exclude offline users
|
||||
pub exclude_offline: Option<bool>,
|
||||
|
||||
@@ -198,6 +198,7 @@ auto_derived!(
|
||||
|
||||
/// Options when fetching server
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsFetchServer {
|
||||
/// Whether to include channels
|
||||
pub include_channels: Option<bool>,
|
||||
@@ -284,6 +285,7 @@ auto_derived!(
|
||||
|
||||
/// Options when leaving a server
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsServerDelete {
|
||||
/// Whether to not send a leave message
|
||||
pub leave_silently: Option<bool>,
|
||||
|
||||
@@ -17,6 +17,7 @@ auto_derived!(
|
||||
|
||||
/// Additional options for inserting settings
|
||||
#[cfg_attr(feature = "rocket", derive(FromForm))]
|
||||
#[cfg_attr(feature = "utoipa", derive(IntoParams))]
|
||||
pub struct OptionsSetSettings {
|
||||
/// Timestamp of settings change.
|
||||
///
|
||||
|
||||
@@ -142,7 +142,7 @@ auto_derived!(
|
||||
#[cfg_attr(feature = "validator", derive(Validate))]
|
||||
pub struct UserStatus {
|
||||
/// Custom status text
|
||||
#[validate(length(min = 0, max = 128))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 0, max = 128)))]
|
||||
#[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
|
||||
pub text: Option<String>,
|
||||
/// Current presence option
|
||||
@@ -155,7 +155,7 @@ auto_derived!(
|
||||
#[cfg_attr(feature = "validator", derive(Validate))]
|
||||
pub struct UserProfile {
|
||||
/// Text content on user's profile
|
||||
#[validate(length(min = 0, max = 2000))]
|
||||
#[cfg_attr(feature = "validator", validate(length(min = 0, max = 2000)))]
|
||||
#[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
|
||||
pub content: Option<String>,
|
||||
/// Background visible on user's profile
|
||||
|
||||
@@ -11,10 +11,8 @@ description = "Revolt Backend: Permission Logic"
|
||||
[features]
|
||||
bson = ["dep:bson"]
|
||||
serde = ["dep:serde"]
|
||||
schemas = ["dep:schemars"]
|
||||
try-from-primitive = ["dep:num_enum"]
|
||||
|
||||
|
||||
[dev-dependencies]
|
||||
# Async
|
||||
async-std = { version = "1.8.0", features = ["attributes"] }
|
||||
@@ -36,4 +34,4 @@ serde = { version = "1", features = ["derive"], optional = true }
|
||||
bson = { version = "2.1.0", optional = true }
|
||||
|
||||
# Spec Generation
|
||||
schemars = { version = "0.8.8", optional = true }
|
||||
utoipa = { version = "5.4.0", optional = true }
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
#[cfg(feature = "schemas")]
|
||||
use schemars::JsonSchema;
|
||||
#[cfg(feature = "utoipa")]
|
||||
use utoipa::ToSchema;
|
||||
|
||||
/// Representation of a single permission override
|
||||
#[derive(Debug, Clone, Eq, PartialEq, Default)]
|
||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
pub struct Override {
|
||||
/// Allow bit flags
|
||||
pub allow: u64,
|
||||
@@ -15,7 +15,7 @@ pub struct Override {
|
||||
/// Data permissions Field - contains both allow and deny
|
||||
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
pub struct DataPermissionsField {
|
||||
pub permissions: Override,
|
||||
}
|
||||
@@ -23,7 +23,7 @@ pub struct DataPermissionsField {
|
||||
/// Data permissions Value - contains allow
|
||||
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
|
||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
pub struct DataPermissionsValue {
|
||||
pub permissions: u64,
|
||||
}
|
||||
@@ -31,7 +31,7 @@ pub struct DataPermissionsValue {
|
||||
/// Data permissions Poly - can contain either Value or Field
|
||||
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
#[cfg_attr(feature = "serde", serde(untagged))]
|
||||
pub enum DataPermissionPoly {
|
||||
Value {
|
||||
@@ -48,7 +48,7 @@ pub enum DataPermissionPoly {
|
||||
/// as it appears on models and in the database
|
||||
#[derive(Debug, Clone, Copy, Default, Eq, PartialEq)]
|
||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
pub struct OverrideField {
|
||||
/// Allow bit flags
|
||||
pub a: i64,
|
||||
|
||||
@@ -4,20 +4,22 @@ version = "0.8.9"
|
||||
edition = "2024"
|
||||
|
||||
[features]
|
||||
rocket = ["dep:rocket", "dep:revolt_rocket_okapi", "revolt-database/rocket-impl"]
|
||||
rocket = [
|
||||
"dep:rocket",
|
||||
"revolt-database/rocket-impl",
|
||||
]
|
||||
axum = ["dep:axum", "revolt-database/axum-impl"]
|
||||
|
||||
default = ["rocket", "axum"]
|
||||
|
||||
[dependencies]
|
||||
revolt-database = { version = "0.8.9", path = "../database"}
|
||||
revolt-database = { version = "0.8.9", path = "../database" }
|
||||
revolt-result = { version = "0.8.9", path = "../result" }
|
||||
revolt-config = { version = "0.8.9", path = "../config" }
|
||||
|
||||
rocket = { version = "0.5.1", optional = true }
|
||||
revolt_rocket_okapi = { version = "0.10.0", optional = true }
|
||||
|
||||
axum = { version = "0.7.5", optional = true, features = ["macros"] }
|
||||
axum = { version = "0.8.6", optional = true, features = ["macros"] }
|
||||
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
authifier = { version = "1.0.15" }
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
use std::net::SocketAddr;
|
||||
|
||||
use async_trait::async_trait;
|
||||
use axum::{
|
||||
Json, RequestPartsExt, Router,
|
||||
body::Body,
|
||||
@@ -44,7 +43,6 @@ async fn to_real_ip(parts: &Parts) -> String {
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<S: Send + Sync> FromRequestParts<S> for Ratelimiter
|
||||
where
|
||||
Database: FromRef<S>,
|
||||
@@ -82,7 +80,6 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<S: Send + Sync> FromRequestParts<S> for RatelimitInformation
|
||||
where
|
||||
Database: FromRef<S>,
|
||||
|
||||
@@ -8,9 +8,6 @@ use rocket::serde::json::Json;
|
||||
use rocket::{Data, Request, Response, State};
|
||||
use revolt_config::config;
|
||||
|
||||
use revolt_rocket_okapi::r#gen::OpenApiGenerator;
|
||||
use revolt_rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput};
|
||||
|
||||
use authifier::models::Session;
|
||||
|
||||
use crate::ratelimiter::RequestKind;
|
||||
@@ -78,16 +75,6 @@ impl<'r> FromRequest<'r> for Ratelimiter {
|
||||
}
|
||||
}
|
||||
|
||||
impl OpenApiFromRequest<'_> for Ratelimiter {
|
||||
fn from_request_input(
|
||||
_gen: &mut OpenApiGenerator,
|
||||
_name: String,
|
||||
_required: bool,
|
||||
) -> revolt_rocket_okapi::Result<RequestHeaderInput> {
|
||||
Ok(RequestHeaderInput::None)
|
||||
}
|
||||
}
|
||||
|
||||
/// Attach ratelimiter to the Rocket application
|
||||
pub struct RatelimitFairing;
|
||||
|
||||
|
||||
@@ -10,11 +10,9 @@ description = "Revolt Backend: Result and Error types"
|
||||
|
||||
[features]
|
||||
serde = ["dep:serde"]
|
||||
schemas = ["dep:schemars"]
|
||||
utoipa = ["dep:utoipa"]
|
||||
rocket = ["dep:rocket", "dep:serde_json"]
|
||||
axum = ["dep:axum", "dep:serde_json"]
|
||||
okapi = ["dep:revolt_rocket_okapi", "dep:revolt_okapi", "schemas"]
|
||||
sentry = ["dep:sentry"]
|
||||
|
||||
default = ["serde", "sentry"]
|
||||
@@ -25,17 +23,14 @@ serde_json = { version = "1", optional = true }
|
||||
serde = { version = "1", features = ["derive"], optional = true }
|
||||
|
||||
# Spec Generation
|
||||
schemars = { version = "0.8.8", optional = true }
|
||||
utoipa = { version = "4.2.3", optional = true }
|
||||
utoipa = { version = "5.4.0", optional = true }
|
||||
|
||||
# Rocket
|
||||
rocket = { optional = true, version = "0.5.0-rc.2", default-features = false }
|
||||
revolt_rocket_okapi = { version = "0.10.0", optional = true }
|
||||
revolt_okapi = { version = "0.9.1", optional = true }
|
||||
|
||||
# utilities
|
||||
log = "0.4"
|
||||
# Axum
|
||||
axum = { version = "0.7.5", optional = true }
|
||||
axum = { version = "0.8.6", optional = true }
|
||||
|
||||
sentry = { version = "0.31.5", optional = true }
|
||||
sentry = { version = "0.31.5", optional = true }
|
||||
|
||||
@@ -5,13 +5,10 @@ use std::fmt::Display;
|
||||
#[macro_use]
|
||||
extern crate serde;
|
||||
|
||||
#[cfg(feature = "schemas")]
|
||||
#[macro_use]
|
||||
extern crate schemars;
|
||||
|
||||
#[cfg(feature = "utoipa")]
|
||||
#[macro_use]
|
||||
extern crate utoipa;
|
||||
mod utoipa_impl;
|
||||
#[cfg(feature = "utoipa")]
|
||||
pub use crate::utoipa_impl::*;
|
||||
|
||||
#[cfg(feature = "rocket")]
|
||||
pub mod rocket;
|
||||
@@ -19,16 +16,12 @@ pub mod rocket;
|
||||
#[cfg(feature = "axum")]
|
||||
pub mod axum;
|
||||
|
||||
#[cfg(feature = "okapi")]
|
||||
pub mod okapi;
|
||||
|
||||
/// Result type with custom Error
|
||||
pub type Result<T, E = Error> = std::result::Result<T, E>;
|
||||
|
||||
/// Error information
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct Error {
|
||||
/// Type of error and additional information
|
||||
@@ -50,8 +43,7 @@ impl std::error::Error for Error {}
|
||||
/// Possible error types
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[cfg_attr(feature = "serde", serde(tag = "type"))]
|
||||
#[cfg_attr(feature = "schemas", derive(JsonSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(ToSchema))]
|
||||
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
|
||||
#[derive(Debug, Clone)]
|
||||
pub enum ErrorType {
|
||||
/// This error was not labeled :(
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
use revolt_okapi::openapi3::SchemaObject;
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3;
|
||||
use schemars::schema::Schema;
|
||||
|
||||
use crate::Error;
|
||||
|
||||
impl revolt_rocket_okapi::response::OpenApiResponderInner for Error {
|
||||
fn responses(
|
||||
gen: &mut revolt_rocket_okapi::gen::OpenApiGenerator,
|
||||
) -> std::result::Result<openapi3::Responses, revolt_rocket_okapi::OpenApiError> {
|
||||
let mut content = revolt_okapi::Map::new();
|
||||
|
||||
let settings = schemars::gen::SchemaSettings::default().with(|s| {
|
||||
s.option_nullable = true;
|
||||
s.option_add_null_type = false;
|
||||
s.definitions_path = "#/components/schemas/".to_string();
|
||||
});
|
||||
|
||||
let mut schema_generator = settings.into_generator();
|
||||
let schema = schema_generator.root_schema_for::<Error>();
|
||||
|
||||
let definitions = gen.schema_generator().definitions_mut();
|
||||
for (key, value) in schema.definitions {
|
||||
definitions.insert(key, value);
|
||||
}
|
||||
|
||||
definitions.insert("Error".to_string(), Schema::Object(schema.schema));
|
||||
|
||||
content.insert(
|
||||
"application/json".to_string(),
|
||||
openapi3::MediaType {
|
||||
schema: Some(SchemaObject {
|
||||
reference: Some("#/components/schemas/Error".to_string()),
|
||||
..Default::default()
|
||||
}),
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
|
||||
Ok(openapi3::Responses {
|
||||
default: Some(openapi3::RefOr::Object(openapi3::Response {
|
||||
content,
|
||||
description: "An error occurred.".to_string(),
|
||||
..Default::default()
|
||||
})),
|
||||
..Default::default()
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
use utoipa::{Modify, openapi::{Content, OpenApi, Ref, RefOr, ResponseBuilder}};
|
||||
|
||||
pub struct ErrorAddon;
|
||||
|
||||
impl Modify for ErrorAddon {
|
||||
fn modify(&self, utoipa: &mut OpenApi) {
|
||||
let response = ResponseBuilder::new()
|
||||
.description("An error occurred")
|
||||
.content(
|
||||
"application/json",
|
||||
Content::new(Some(RefOr::Ref(Ref::from_schema_name("Error")))),
|
||||
)
|
||||
.build();
|
||||
|
||||
for path in utoipa.paths.paths.values_mut() {
|
||||
if let Some(route) = path.get.as_mut() {
|
||||
route
|
||||
.responses
|
||||
.responses
|
||||
.insert("default".to_string(), RefOr::T(response.clone()));
|
||||
};
|
||||
|
||||
if let Some(route) = path.delete.as_mut() {
|
||||
route
|
||||
.responses
|
||||
.responses
|
||||
.insert("default".to_string(), RefOr::T(response.clone()));
|
||||
};
|
||||
|
||||
if let Some(route) = path.patch.as_mut() {
|
||||
route
|
||||
.responses
|
||||
.responses
|
||||
.insert("default".to_string(), RefOr::T(response.clone()));
|
||||
};
|
||||
|
||||
if let Some(route) = path.post.as_mut() {
|
||||
route
|
||||
.responses
|
||||
.responses
|
||||
.insert("default".to_string(), RefOr::T(response.clone()));
|
||||
};
|
||||
|
||||
if let Some(route) = path.put.as_mut() {
|
||||
route
|
||||
.responses
|
||||
.responses
|
||||
.insert("default".to_string(), RefOr::T(response.clone()));
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -38,5 +38,5 @@ pretty_env_logger = "0.4.0"
|
||||
serde_json = "1"
|
||||
revolt_optional_struct = "0.2.0"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
iso8601-timestamp = { version = "0.2.10", features = ["serde", "bson"] }
|
||||
iso8601-timestamp = { version = "0.4.0", features = ["serde", "bson"] }
|
||||
base64 = "0.22.1"
|
||||
|
||||
@@ -40,9 +40,9 @@ revolt-database = { path = "../../core/database", features = ["voice"] }
|
||||
revolt-permissions = { path = "../../core/permissions" }
|
||||
|
||||
# Voice
|
||||
livekit-api = "0.4.4"
|
||||
livekit-protocol = "0.4.0"
|
||||
livekit-runtime = { version = "0.3.1", features = ["tokio"] }
|
||||
livekit-api = "=0.4.4"
|
||||
livekit-protocol = "=0.4.0"
|
||||
livekit-runtime = { version = "=0.3.1", features = ["tokio"] }
|
||||
|
||||
# RabbitMQ
|
||||
amqprs = { version = "1.7.0" }
|
||||
|
||||
+10
-9
@@ -35,7 +35,7 @@ nanoid = "0.4.0"
|
||||
serde_json = "1.0.57"
|
||||
serde = { version = "1.0.115", features = ["derive"] }
|
||||
validator = { version = "0.16", features = ["derive"] }
|
||||
iso8601-timestamp = { version = "0.2.11", features = [] }
|
||||
iso8601-timestamp = { version = "0.4.0", features = [] }
|
||||
|
||||
# async
|
||||
futures = "0.3.8"
|
||||
@@ -55,13 +55,13 @@ lettre = "0.10.0-alpha.4"
|
||||
|
||||
rocket = { version = "0.5.1", default-features = false, features = ["json"] }
|
||||
rocket_cors = { git = "https://github.com/lawliet89/rocket_cors", rev = "072d90359b23e9b291df6b672c07c93de9c46011" }
|
||||
rocket_empty = { version = "0.1.1", features = ["schema"] }
|
||||
rocket_empty = { version = "0.1.1" }
|
||||
rocket_authifier = { version = "1.0.15" }
|
||||
rocket_prometheus = "0.10.0-rc.3"
|
||||
|
||||
# spec generation
|
||||
schemars = "0.8.8"
|
||||
revolt_rocket_okapi = { version = "0.10.0", features = ["swagger"] }
|
||||
utoipa = { version = "5.4.0", features = ["rocket_extras"] }
|
||||
utoipa-scalar = { version = "0.3.0", features = ["rocket"] }
|
||||
|
||||
# rabbit
|
||||
amqprs = { version = "1.7.0" }
|
||||
@@ -72,21 +72,22 @@ revolt-config = { path = "../core/config" }
|
||||
revolt-database = { path = "../core/database", features = [
|
||||
"rocket-impl",
|
||||
"redis-is-patched",
|
||||
"utoipa",
|
||||
"voice",
|
||||
] }
|
||||
revolt-models = { path = "../core/models", features = [
|
||||
"schemas",
|
||||
"utoipa",
|
||||
"validator",
|
||||
"rocket",
|
||||
] }
|
||||
revolt-presence = { path = "../core/presence" }
|
||||
revolt-result = { path = "../core/result", features = ["rocket", "okapi"] }
|
||||
revolt-permissions = { path = "../core/permissions", features = ["schemas"] }
|
||||
revolt-result = { path = "../core/result", features = ["rocket", "utoipa"] }
|
||||
revolt-permissions = { path = "../core/permissions", features = ["utoipa"] }
|
||||
revolt-ratelimits = { path = "../core/ratelimits", features = ["rocket"] }
|
||||
|
||||
# voice
|
||||
livekit-api = "0.4.4"
|
||||
livekit-protocol = "0.4.0"
|
||||
livekit-api = "=0.4.4"
|
||||
livekit-protocol = "=0.4.0"
|
||||
|
||||
[build-dependencies]
|
||||
vergen = "7.5.0"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#[macro_use]
|
||||
extern crate rocket;
|
||||
#[macro_use]
|
||||
extern crate revolt_rocket_okapi;
|
||||
extern crate utoipa;
|
||||
#[macro_use]
|
||||
extern crate serde_json;
|
||||
|
||||
@@ -15,6 +15,8 @@ use revolt_ratelimits::rocket as ratelimiter;
|
||||
use rocket::{Build, Rocket};
|
||||
use rocket_cors::{AllowedOrigins, CorsOptions};
|
||||
use rocket_prometheus::PrometheusMetrics;
|
||||
use utoipa::OpenApi;
|
||||
use utoipa_scalar::{Scalar, Servable};
|
||||
use std::net::Ipv4Addr;
|
||||
use std::str::FromStr;
|
||||
|
||||
@@ -75,31 +77,6 @@ pub async fn web() -> Rocket<Build> {
|
||||
.to_cors()
|
||||
.expect("Failed to create CORS.");
|
||||
|
||||
// Configure Swagger
|
||||
let swagger = revolt_rocket_okapi::swagger_ui::make_swagger_ui(
|
||||
&revolt_rocket_okapi::swagger_ui::SwaggerUIConfig {
|
||||
url: "/openapi.json".to_owned(),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.into();
|
||||
|
||||
let swagger_0_8 = revolt_rocket_okapi::swagger_ui::make_swagger_ui(
|
||||
&revolt_rocket_okapi::swagger_ui::SwaggerUIConfig {
|
||||
url: "/0.8/openapi.json".to_owned(),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.into();
|
||||
|
||||
let swagger_0_8 = revolt_rocket_okapi::swagger_ui::make_swagger_ui(
|
||||
&revolt_rocket_okapi::swagger_ui::SwaggerUIConfig {
|
||||
url: "/0.8/openapi.json".to_owned(),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.into();
|
||||
|
||||
// Voice handler
|
||||
let voice_client = VoiceClient::new(config.api.livekit.nodes.clone());
|
||||
// Configure Rabbit
|
||||
@@ -143,8 +120,7 @@ pub async fn web() -> Rocket<Build> {
|
||||
.mount("/metrics", prometheus)
|
||||
.mount("/", rocket_cors::catch_all_options_routes())
|
||||
.mount("/", ratelimiter::routes())
|
||||
.mount("/swagger/", swagger)
|
||||
.mount("/0.8/swagger/", swagger_0_8)
|
||||
.mount("/", Scalar::with_url("/scalar", routes::ApiDoc::openapi()))
|
||||
.manage(authifier)
|
||||
.manage(db)
|
||||
.manage(amqp)
|
||||
|
||||
@@ -5,10 +5,16 @@ use rocket::serde::json::Json;
|
||||
use rocket::State;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Create Bot
|
||||
/// Create Bot
|
||||
///
|
||||
/// Create a new Revolt bot.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = v0::BotWithUserResponse),
|
||||
),
|
||||
)]
|
||||
#[post("/create", data = "<info>")]
|
||||
pub async fn create_bot(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -3,10 +3,16 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Delete Bot
|
||||
/// Delete Bot
|
||||
///
|
||||
/// Delete a bot by its id.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>")]
|
||||
pub async fn delete_bot(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -6,10 +6,16 @@ use rocket::State;
|
||||
use rocket::serde::json::Json;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Edit Bot
|
||||
/// Edit Bot
|
||||
///
|
||||
/// Edit bot details by its id.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = v0::BotWithUserResponse),
|
||||
),
|
||||
)]
|
||||
#[patch("/<target>", data = "<data>")]
|
||||
pub async fn edit_bot(
|
||||
db: &State<Database>,
|
||||
@@ -60,15 +66,8 @@ pub async fn edit_bot(
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
bot.update(
|
||||
db,
|
||||
partial,
|
||||
remove
|
||||
.into_iter()
|
||||
.map(|v| v.into())
|
||||
.collect(),
|
||||
)
|
||||
.await?;
|
||||
bot.update(db, partial, remove.into_iter().map(|v| v.into()).collect())
|
||||
.await?;
|
||||
|
||||
Ok(Json(v0::BotWithUserResponse {
|
||||
bot: bot.into(),
|
||||
|
||||
@@ -3,10 +3,16 @@ use revolt_models::v0::FetchBotResponse;
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Bot
|
||||
/// Fetch Bot
|
||||
///
|
||||
/// Fetch details of a bot you own by its id.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = FetchBotResponse),
|
||||
),
|
||||
)]
|
||||
#[get("/<bot>")]
|
||||
pub async fn fetch_bot(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -5,10 +5,16 @@ use revolt_result::Result;
|
||||
use rocket::serde::json::Json;
|
||||
use rocket::State;
|
||||
|
||||
/// # Fetch Owned Bots
|
||||
/// Fetch Owned Bots
|
||||
///
|
||||
/// Fetch all of the bots that you have control over.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = OwnedBotsResponse),
|
||||
),
|
||||
)]
|
||||
#[get("/@me")]
|
||||
pub async fn fetch_owned_bots(db: &State<Database>, user: User) -> Result<Json<OwnedBotsResponse>> {
|
||||
let mut bots = db.fetch_bots_by_user(&user.id).await?;
|
||||
|
||||
@@ -5,10 +5,16 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::serde::json::Json;
|
||||
use rocket::State;
|
||||
|
||||
/// # Fetch Public Bot
|
||||
/// Fetch Public Bot
|
||||
///
|
||||
/// Fetch details of a public (or owned) bot by its id.
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = []), ()),
|
||||
responses(
|
||||
(status = 200, body = PublicBot),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>/invite")]
|
||||
pub async fn fetch_public_bot(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -11,10 +11,16 @@ use rocket::State;
|
||||
use rocket::serde::json::Json;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Invite Bot
|
||||
/// Invite Bot
|
||||
///
|
||||
/// Invite a bot to a server or group by its id.`
|
||||
#[openapi(tag = "Bots")]
|
||||
#[utoipa::path(
|
||||
tag = "Bots",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = v0::BotWithUserResponse),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/invite", data = "<dest>")]
|
||||
pub async fn invite_bot(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod create;
|
||||
@@ -9,8 +8,22 @@ mod fetch_owned;
|
||||
mod fetch_public;
|
||||
mod invite;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
create::create_bot,
|
||||
invite::invite_bot,
|
||||
fetch_public::fetch_public_bot,
|
||||
fetch::fetch_bot,
|
||||
fetch_owned::fetch_owned_bots,
|
||||
edit::edit_bot,
|
||||
delete::delete_bot,
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![
|
||||
create::create_bot,
|
||||
invite::invite_bot,
|
||||
fetch_public::fetch_public_bot,
|
||||
|
||||
@@ -7,10 +7,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Acknowledge Message
|
||||
/// Acknowledge Message
|
||||
///
|
||||
/// Lets the server and all other clients know that we've seen this message id in this channel.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("message" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204)
|
||||
)
|
||||
)]
|
||||
#[put("/<target>/ack/<message>")]
|
||||
pub async fn ack(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -9,10 +9,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Close Channel
|
||||
/// Close Channel
|
||||
///
|
||||
/// Deletes a server channel, leaves a group or closes a group.
|
||||
#[openapi(tag = "Channel Information")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Information",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
v0::OptionsChannelDelete,
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>?<options..>")]
|
||||
pub async fn delete(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -9,10 +9,19 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
use validator::Validate;
|
||||
|
||||
/// # Edit Channel
|
||||
/// Edit Channel
|
||||
///
|
||||
/// Edit a channel object by its id.
|
||||
#[openapi(tag = "Channel Information")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Information",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Channel),
|
||||
),
|
||||
)]
|
||||
#[patch("/<target>", data = "<data>")]
|
||||
pub async fn edit(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,19 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::Result;
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Channel
|
||||
/// Fetch Channel
|
||||
///
|
||||
/// Fetch channel by its id.
|
||||
#[openapi(tag = "Channel Information")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Information",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Channel),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>")]
|
||||
pub async fn fetch(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Add Member to Group
|
||||
/// Add Member to Group
|
||||
///
|
||||
/// Adds another user to the group.
|
||||
#[openapi(tag = "Groups")]
|
||||
#[utoipa::path(
|
||||
tag = "Groups",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("group_id" = Reference, Path),
|
||||
("member_id" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[put("/<group_id>/recipients/<member_id>")]
|
||||
pub async fn add_member(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -6,10 +6,16 @@ use rocket::serde::json::Json;
|
||||
use rocket::State;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Create Group
|
||||
/// Create Group
|
||||
///
|
||||
/// Create a new group channel.
|
||||
#[openapi(tag = "Groups")]
|
||||
#[utoipa::path(
|
||||
tag = "Groups",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = v0::Channel),
|
||||
),
|
||||
)]
|
||||
#[post("/create", data = "<data>")]
|
||||
pub async fn create_group(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -9,10 +9,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Remove Member from Group
|
||||
/// Remove Member from Group
|
||||
///
|
||||
/// Removes a user from the group.
|
||||
#[openapi(tag = "Groups")]
|
||||
#[utoipa::path(
|
||||
tag = "Groups",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("member" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/recipients/<member>")]
|
||||
pub async fn remove_member(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,12 +8,21 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Create Invite
|
||||
/// Create Invite
|
||||
///
|
||||
/// Creates an invite to this channel.
|
||||
///
|
||||
/// Channel must be a `TextChannel`.
|
||||
#[openapi(tag = "Channel Invites")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Invites",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Invite),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/invites")]
|
||||
pub async fn create_invite(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -7,12 +7,21 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Group Members
|
||||
/// Fetch Group Members
|
||||
///
|
||||
/// Retrieves all users who are part of this group.
|
||||
///
|
||||
/// This may not return full user information if users are not friends but have mutual connections.
|
||||
#[openapi(tag = "Groups")]
|
||||
#[utoipa::path(
|
||||
tag = "Groups",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = Vec<v0::User>),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>/members")]
|
||||
pub async fn fetch_members(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -10,14 +10,23 @@ use rocket::{serde::json::Json, State};
|
||||
use rocket_empty::EmptyResponse;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Bulk Delete Messages
|
||||
/// Bulk Delete Messages
|
||||
///
|
||||
/// Delete multiple messages you've sent or one you have permission to delete.
|
||||
///
|
||||
/// This will always require `ManageMessages` permission regardless of whether you own the message or not.
|
||||
///
|
||||
/// Messages must have been sent within the past 1 week.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/messages/bulk", data = "<options>", rank = 1)]
|
||||
pub async fn bulk_delete_messages(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -7,12 +7,22 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Remove All Reactions from Message
|
||||
/// Remove All Reactions from Message
|
||||
///
|
||||
/// Remove your own, someone else's or all of a given reaction.
|
||||
///
|
||||
/// Requires `ManageMessages` permission.
|
||||
#[openapi(tag = "Interactions")]
|
||||
#[utoipa::path(
|
||||
tag = "Interactions",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/messages/<msg>/reactions")]
|
||||
pub async fn clear_reactions(
|
||||
db: &State<Database>,
|
||||
@@ -37,7 +47,7 @@ pub async fn clear_reactions(
|
||||
reactions: Some(Default::default()),
|
||||
..Default::default()
|
||||
},
|
||||
vec![]
|
||||
vec![],
|
||||
)
|
||||
.await
|
||||
.map(|_| EmptyResponse)
|
||||
|
||||
@@ -7,10 +7,20 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Delete Message
|
||||
/// Delete Message
|
||||
///
|
||||
/// Delete a message you've sent or one you have permission to delete.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/messages/<msg>", rank = 2)]
|
||||
pub async fn delete(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -10,10 +10,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
use validator::Validate;
|
||||
|
||||
/// # Edit Message
|
||||
/// Edit Message
|
||||
///
|
||||
/// Edits a message that you've previously sent.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Message),
|
||||
),
|
||||
)]
|
||||
#[patch("/<target>/messages/<msg>", data = "<edit>")]
|
||||
pub async fn edit(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -7,10 +7,20 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Message
|
||||
/// Fetch Message
|
||||
///
|
||||
/// Retrieves a message by its id.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Message),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>/messages/<msg>")]
|
||||
pub async fn fetch(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Pins a message
|
||||
/// Pins a message
|
||||
///
|
||||
/// Pins a message by its id.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/messages/<msg>/pin")]
|
||||
pub async fn message_pin(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,20 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
use validator::Validate;
|
||||
|
||||
/// # Fetch Messages
|
||||
/// Fetch Messages
|
||||
///
|
||||
/// Fetch multiple messages.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
v0::OptionsQueryMessages,
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::BulkMessageResponse),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>/messages?<options..>")]
|
||||
pub async fn query(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -7,10 +7,21 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Add Reaction to Message
|
||||
/// Add Reaction to Message
|
||||
///
|
||||
/// React to a given message.
|
||||
#[openapi(tag = "Interactions")]
|
||||
#[utoipa::path(
|
||||
tag = "Interactions",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
("emoji" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[put("/<target>/messages/<msg>/reactions/<emoji>")]
|
||||
pub async fn react_message(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,19 @@ use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
use validator::Validate;
|
||||
|
||||
/// # Search for Messages
|
||||
/// Search for Messages
|
||||
///
|
||||
/// This route searches for messages within the given parameters.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::BulkMessageResponse),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/search", data = "<options>")]
|
||||
pub async fn search(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -12,10 +12,20 @@ use rocket::serde::json::Json;
|
||||
use rocket::State;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Send Message
|
||||
/// Send Message
|
||||
///
|
||||
/// Sends a message to the given channel.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(IdempotencyKey),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Message),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/messages", data = "<data>")]
|
||||
pub async fn message_send(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -1,14 +1,27 @@
|
||||
use revolt_database::{util::{permissions::DatabasePermissionQuery, reference::Reference}, Channel, Database, FieldsMessage, PartialMessage, SystemMessage, User, AMQP};
|
||||
use revolt_database::{
|
||||
util::{permissions::DatabasePermissionQuery, reference::Reference},
|
||||
Channel, Database, FieldsMessage, PartialMessage, SystemMessage, User, AMQP,
|
||||
};
|
||||
use revolt_models::v0::MessageAuthor;
|
||||
use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Unpins a message
|
||||
/// Unpins a message
|
||||
///
|
||||
/// Unpins a message by its id.
|
||||
#[openapi(tag = "Messaging")]
|
||||
#[utoipa::path(
|
||||
tag = "Messaging",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/messages/<msg>/pin")]
|
||||
pub async fn message_unpin(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,12 +8,24 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Remove Reaction(s) to Message
|
||||
/// Remove Reaction(s) to Message
|
||||
///
|
||||
/// Remove your own, someone else's or all of a given reaction.
|
||||
///
|
||||
/// Requires `ManageMessages` if changing others' reactions.
|
||||
#[openapi(tag = "Interactions")]
|
||||
#[utoipa::path(
|
||||
tag = "Interactions",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("msg" = Reference, Path),
|
||||
("emoji" = Reference, Path),
|
||||
v0::OptionsUnreact,
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>/messages/<msg>/reactions/<emoji>?<options..>")]
|
||||
pub async fn unreact_message(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod channel_ack;
|
||||
@@ -29,8 +28,42 @@ mod voice_stop_ring;
|
||||
mod webhook_create;
|
||||
mod webhook_fetch_all;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
channel_ack::ack,
|
||||
channel_fetch::fetch,
|
||||
members_fetch::fetch_members,
|
||||
channel_delete::delete,
|
||||
channel_edit::edit,
|
||||
invite_create::create_invite,
|
||||
message_send::message_send,
|
||||
message_query::query,
|
||||
message_search::search,
|
||||
message_pin::message_pin,
|
||||
message_fetch::fetch,
|
||||
message_edit::edit,
|
||||
message_bulk_delete::bulk_delete_messages,
|
||||
message_delete::delete,
|
||||
message_unpin::message_unpin,
|
||||
group_create::create_group,
|
||||
group_add_member::add_member,
|
||||
group_remove_member::remove_member,
|
||||
voice_join::call,
|
||||
voice_stop_ring::stop_ring,
|
||||
permissions_set::set_role_permissions,
|
||||
permissions_set_default::set_default_channel_permissions,
|
||||
message_react::react_message,
|
||||
message_unreact::unreact_message,
|
||||
message_clear_reactions::clear_reactions,
|
||||
webhook_create::create_webhook,
|
||||
webhook_fetch_all::fetch_webhooks,
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![
|
||||
channel_ack::ack,
|
||||
channel_fetch::fetch,
|
||||
members_fetch::fetch_members,
|
||||
|
||||
@@ -6,12 +6,22 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission, Overr
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Set Role Permission
|
||||
/// Set Role Permission
|
||||
///
|
||||
/// Sets permissions for the specified role in this channel.
|
||||
///
|
||||
/// Channel must be a `TextChannel`.
|
||||
#[openapi(tag = "Channel Permissions")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Permissions",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("role_id" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Channel),
|
||||
),
|
||||
)]
|
||||
#[put("/<target>/permissions/<role_id>", data = "<data>", rank = 2)]
|
||||
pub async fn set_role_permissions(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -6,12 +6,21 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Set Default Permission
|
||||
/// Set Default Permission
|
||||
///
|
||||
/// Sets permissions for the default role in this channel.
|
||||
///
|
||||
/// Channel must be a `Group` or `TextChannel`.
|
||||
#[openapi(tag = "Channel Permissions")]
|
||||
#[utoipa::path(
|
||||
tag = "Channel Permissions",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Channel),
|
||||
),
|
||||
)]
|
||||
#[put("/<target>/permissions/default", data = "<data>", rank = 1)]
|
||||
pub async fn set_default_channel_permissions(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -13,10 +13,19 @@ use revolt_result::{create_error, Result};
|
||||
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Join Call
|
||||
/// Join Call
|
||||
///
|
||||
/// Asks the voice server for a token to join the call.
|
||||
#[openapi(tag = "Voice")]
|
||||
#[utoipa::path(
|
||||
tag = "Voice",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::DataJoinCall),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/join_call", data = "<data>")]
|
||||
pub async fn call(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,12 +8,23 @@ use revolt_result::{create_error, Result, ToRevoltError};
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Stop Ring
|
||||
/// Stop Ring
|
||||
///
|
||||
/// Stops ringing a specific user in a dm call.
|
||||
/// You must be in the call to use this endpoint, returns NotConnected otherwise.
|
||||
/// Only valid in DM/Group channels, will return NoEffect in servers.
|
||||
/// Returns NotFound if the user is not in the dm/group channel
|
||||
#[openapi(tag = "Voice")]
|
||||
#[utoipa::path(
|
||||
tag = "Voice",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
("target_user." = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[put("/<target>/end_ring/<target_user>")]
|
||||
pub async fn stop_ring(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -11,10 +11,19 @@ use rocket::{serde::json::Json, State};
|
||||
use ulid::Ulid;
|
||||
use validator::Validate;
|
||||
|
||||
/// # Creates a webhook
|
||||
/// Creates a webhook
|
||||
///
|
||||
/// Creates a webhook which 3rd party platforms can use to send messages
|
||||
#[openapi(tag = "Webhooks")]
|
||||
#[utoipa::path(
|
||||
tag = "Webhooks",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Webhook),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>/webhooks", data = "<data>")]
|
||||
pub async fn create_webhook(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -7,10 +7,19 @@ use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
|
||||
use revolt_result::Result;
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Gets all webhooks
|
||||
/// Gets all webhooks
|
||||
///
|
||||
/// Gets all webhooks inside the channel
|
||||
#[openapi(tag = "Webhooks")]
|
||||
#[utoipa::path(
|
||||
tag = "Webhooks",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = Vec<Webhook>),
|
||||
),
|
||||
)]
|
||||
#[get("/<channel_id>/webhooks")]
|
||||
pub async fn fetch_webhooks(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
use revolt_config::config;
|
||||
use revolt_database::{util::permissions::DatabasePermissionQuery, Database, Emoji, File, User};
|
||||
use revolt_database::{Database, Emoji, File, User, util::{permissions::DatabasePermissionQuery, reference::Reference}};
|
||||
use revolt_models::v0;
|
||||
use revolt_permissions::{calculate_server_permissions, ChannelPermission};
|
||||
use revolt_result::{create_error, Result};
|
||||
@@ -7,10 +7,19 @@ use validator::Validate;
|
||||
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Create New Emoji
|
||||
/// Create New Emoji
|
||||
///
|
||||
/// Create an emoji by its Autumn upload id.
|
||||
#[openapi(tag = "Emojis")]
|
||||
#[utoipa::path(
|
||||
tag = "Emojis",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("id" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Emoji),
|
||||
),
|
||||
)]
|
||||
#[put("/emoji/<id>", data = "<data>")]
|
||||
pub async fn create_emoji(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -8,10 +8,19 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Delete Emoji
|
||||
/// Delete Emoji
|
||||
///
|
||||
/// Delete an emoji by its id.
|
||||
#[openapi(tag = "Emojis")]
|
||||
#[utoipa::path(
|
||||
tag = "Emojis",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("emoji_id" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/emoji/<emoji_id>")]
|
||||
pub async fn delete_emoji(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -4,10 +4,19 @@ use revolt_result::Result;
|
||||
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Emoji
|
||||
/// Fetch Emoji
|
||||
///
|
||||
/// Fetch an emoji by its id.
|
||||
#[openapi(tag = "Emojis")]
|
||||
#[utoipa::path(
|
||||
tag = "Emojis",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("emoji_id" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::Emoji),
|
||||
),
|
||||
)]
|
||||
#[get("/emoji/<emoji_id>")]
|
||||
pub async fn fetch_emoji(db: &State<Database>, emoji_id: Reference<'_>) -> Result<Json<v0::Emoji>> {
|
||||
emoji_id
|
||||
|
||||
@@ -1,12 +1,21 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod emoji_create;
|
||||
mod emoji_delete;
|
||||
mod emoji_fetch;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
emoji_create::create_emoji,
|
||||
emoji_delete::delete_emoji,
|
||||
emoji_fetch::fetch_emoji
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![
|
||||
emoji_create::create_emoji,
|
||||
emoji_delete::delete_emoji,
|
||||
emoji_fetch::fetch_emoji
|
||||
|
||||
@@ -7,10 +7,19 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Delete Invite
|
||||
/// Delete Invite
|
||||
///
|
||||
/// Delete an invite by its id.
|
||||
#[openapi(tag = "Invites")]
|
||||
#[utoipa::path(
|
||||
tag = "Invites",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[delete("/<target>")]
|
||||
pub async fn delete(db: &State<Database>, user: User, target: Reference<'_>) -> Result<EmptyResponse> {
|
||||
let invite = target.as_invite(db).await?;
|
||||
|
||||
@@ -3,10 +3,19 @@ use revolt_models::v0;
|
||||
use revolt_result::Result;
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Fetch Invite
|
||||
/// Fetch Invite
|
||||
///
|
||||
/// Fetch an invite by its id.
|
||||
#[openapi(tag = "Invites")]
|
||||
#[utoipa::path(
|
||||
tag = "Invites",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::InviteResponse),
|
||||
),
|
||||
)]
|
||||
#[get("/<target>")]
|
||||
pub async fn fetch(db: &State<Database>, target: Reference<'_>) -> Result<Json<v0::InviteResponse>> {
|
||||
Ok(Json(match target.as_invite(db).await? {
|
||||
|
||||
@@ -3,10 +3,19 @@ use revolt_models::v0::{self, InviteJoinResponse};
|
||||
use revolt_result::{create_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
|
||||
/// # Join Invite
|
||||
/// Join Invite
|
||||
///
|
||||
/// Join an invite by its ID
|
||||
#[openapi(tag = "Invites")]
|
||||
#[utoipa::path(
|
||||
tag = "Invites",
|
||||
security(("Session-Token" = [])),
|
||||
params(
|
||||
("target" = Reference, Path),
|
||||
),
|
||||
responses(
|
||||
(status = 200, body = v0::InviteJoinResponse),
|
||||
),
|
||||
)]
|
||||
#[post("/<target>")]
|
||||
pub async fn join(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -1,12 +1,22 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod invite_delete;
|
||||
mod invite_fetch;
|
||||
mod invite_join;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
invite_fetch::fetch,
|
||||
invite_join::join,
|
||||
invite_delete::delete
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![
|
||||
invite_fetch::fetch,
|
||||
invite_join::join,
|
||||
invite_delete::delete
|
||||
|
||||
+313
-349
@@ -1,8 +1,14 @@
|
||||
use revolt_config::Settings;
|
||||
use revolt_rocket_okapi::{revolt_okapi::openapi3::OpenApi, settings::OpenApiSettings};
|
||||
use revolt_database::util::{utoipa::TokenSecurity, reference::Reference};
|
||||
use revolt_result::ErrorAddon;
|
||||
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,362 +25,320 @@ 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(),
|
||||
"/auth/sso" => rocket_authifier::routes::sso::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(),
|
||||
"/auth/sso" => rocket_authifier::routes::sso::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(),
|
||||
"/auth/sso" => rocket_authifier::routes::sso::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(),
|
||||
"/auth/sso" => rocket_authifier::routes::sso::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"
|
||||
}),
|
||||
);
|
||||
),
|
||||
components(
|
||||
schemas(
|
||||
Reference,
|
||||
)
|
||||
),
|
||||
modifiers(
|
||||
&Extensions,
|
||||
|
||||
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"
|
||||
]
|
||||
}
|
||||
]),
|
||||
);
|
||||
// TODO: merge these together when authifier is moved into the backend
|
||||
&SecurityAddon,
|
||||
&TokenSecurity,
|
||||
|
||||
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()
|
||||
&ErrorAddon,
|
||||
),
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
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(),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,18 +15,24 @@ use validator::Validate;
|
||||
/// Block lookalike characters
|
||||
pub static RE_USERNAME: Lazy<Regex> = Lazy::new(|| Regex::new(r"^(\p{L}|[\d_.-])+$").unwrap());
|
||||
|
||||
/// # New User Data
|
||||
#[derive(Validate, Serialize, Deserialize, JsonSchema)]
|
||||
/// New User Data
|
||||
#[derive(Validate, Serialize, Deserialize, ToSchema)]
|
||||
pub struct DataOnboard {
|
||||
/// New username which will be used to identify the user on the platform
|
||||
#[validate(length(min = 2, max = 32), regex = "RE_USERNAME")]
|
||||
username: String,
|
||||
}
|
||||
|
||||
/// # Complete Onboarding
|
||||
/// Complete Onboarding
|
||||
///
|
||||
/// This sets a new username, completes onboarding and allows a user to start using Revolt.
|
||||
#[openapi(tag = "Onboarding")]
|
||||
#[utoipa::path(
|
||||
tag = "Onboarding",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = v0::User),
|
||||
),
|
||||
)]
|
||||
#[post("/complete", data = "<data>")]
|
||||
pub async fn complete(
|
||||
db: &State<Database>,
|
||||
|
||||
@@ -4,17 +4,23 @@ use revolt_database::User;
|
||||
use rocket::serde::json::Json;
|
||||
use serde::Serialize;
|
||||
|
||||
/// # Onboarding Status
|
||||
#[derive(Serialize, JsonSchema)]
|
||||
/// Onboarding Status
|
||||
#[derive(Serialize, ToSchema)]
|
||||
pub struct DataHello {
|
||||
/// Whether onboarding is required
|
||||
onboarding: bool,
|
||||
}
|
||||
|
||||
/// # Check Onboarding Status
|
||||
/// Check Onboarding Status
|
||||
///
|
||||
/// This will tell you whether the current account requires onboarding or whether you can continue to send requests as usual. You may skip calling this if you're restoring an existing session.
|
||||
#[openapi(tag = "Onboarding")]
|
||||
#[utoipa::path(
|
||||
tag = "Onboarding",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 200, body = DataHello),
|
||||
),
|
||||
)]
|
||||
#[get("/hello")]
|
||||
pub async fn hello(_session: Session, user: Option<User>) -> Json<DataHello> {
|
||||
Json(DataHello {
|
||||
|
||||
@@ -1,9 +1,17 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod complete;
|
||||
mod hello;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![hello::hello, complete::complete]
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
hello::hello, complete::complete
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![hello::hello, complete::complete]
|
||||
}
|
||||
|
||||
@@ -4,10 +4,16 @@ use revolt_result::Result;
|
||||
use rocket::State;
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Acknowledge Policy Changes
|
||||
/// Acknowledge Policy Changes
|
||||
///
|
||||
/// Accept/acknowledge changes to platform policy.
|
||||
#[openapi(tag = "Policy")]
|
||||
#[utoipa::path(
|
||||
tag = "Policy",
|
||||
security(("Session-Token" = []), ("Bot-Token" = [])),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[post("/acknowledge")]
|
||||
pub async fn acknowledge_policy_changes(db: &State<Database>, user: User) -> Result<EmptyResponse> {
|
||||
db.acknowledge_policy_changes(&user.id).await?;
|
||||
|
||||
@@ -1,10 +1,18 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod acknowledge_policy_changes;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
acknowledge_policy_changes::acknowledge_policy_changes
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![
|
||||
// Policy
|
||||
acknowledge_policy_changes::acknowledge_policy_changes,
|
||||
]
|
||||
|
||||
@@ -1,9 +1,17 @@
|
||||
use revolt_rocket_okapi::revolt_okapi::openapi3::OpenApi;
|
||||
use rocket::Route;
|
||||
|
||||
mod subscribe;
|
||||
mod unsubscribe;
|
||||
|
||||
pub fn routes() -> (Vec<Route>, OpenApi) {
|
||||
openapi_get_routes_spec![subscribe::subscribe, unsubscribe::unsubscribe]
|
||||
#[derive(OpenApi)]
|
||||
#[openapi(
|
||||
paths(
|
||||
subscribe::subscribe,
|
||||
unsubscribe::unsubscribe
|
||||
)
|
||||
)]
|
||||
pub struct ApiDoc;
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![subscribe::subscribe, unsubscribe::unsubscribe]
|
||||
}
|
||||
|
||||
@@ -6,12 +6,18 @@ use revolt_result::{create_database_error, Result};
|
||||
use rocket::{serde::json::Json, State};
|
||||
use rocket_empty::EmptyResponse;
|
||||
|
||||
/// # Push Subscribe
|
||||
/// Push Subscribe
|
||||
///
|
||||
/// Create a new Web Push subscription.
|
||||
///
|
||||
/// If an existing subscription exists on this session, it will be removed.
|
||||
#[openapi(tag = "Web Push")]
|
||||
#[utoipa::path(
|
||||
tag = "Web Push",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[post("/subscribe", data = "<data>")]
|
||||
pub async fn subscribe(
|
||||
authifier: &State<Authifier>,
|
||||
|
||||
@@ -5,10 +5,16 @@ use rocket_empty::EmptyResponse;
|
||||
|
||||
use rocket::State;
|
||||
|
||||
/// # Unsubscribe
|
||||
/// Unsubscribe
|
||||
///
|
||||
/// Remove the Web Push subscription associated with the current session.
|
||||
#[openapi(tag = "Web Push")]
|
||||
#[utoipa::path(
|
||||
tag = "Web Push",
|
||||
security(("Session-Token" = [])),
|
||||
responses(
|
||||
(status = 204),
|
||||
),
|
||||
)]
|
||||
#[post("/unsubscribe")]
|
||||
pub async fn unsubscribe(
|
||||
authifier: &State<Authifier>,
|
||||
|
||||
@@ -1,119 +1,37 @@
|
||||
use revolt_config::config;
|
||||
use revolt_models::v0;
|
||||
use revolt_result::Result;
|
||||
use rocket::serde::json::Json;
|
||||
use serde::Serialize;
|
||||
|
||||
/// # hCaptcha Configuration
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct CaptchaFeature {
|
||||
/// Whether captcha is enabled
|
||||
pub enabled: bool,
|
||||
/// Client key used for solving captcha
|
||||
pub key: String,
|
||||
}
|
||||
|
||||
/// # Generic Service Configuration
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct Feature {
|
||||
/// Whether the service is enabled
|
||||
pub enabled: bool,
|
||||
/// URL pointing to the service
|
||||
pub url: String,
|
||||
}
|
||||
|
||||
/// # Information about a livekit node
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct VoiceNode {
|
||||
pub name: String,
|
||||
pub lat: f64,
|
||||
pub lon: f64,
|
||||
pub public_url: String,
|
||||
}
|
||||
|
||||
/// # Voice Server Configuration
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct VoiceFeature {
|
||||
/// Whether voice is enabled
|
||||
pub enabled: bool,
|
||||
/// All livekit nodes
|
||||
pub nodes: Vec<VoiceNode>,
|
||||
}
|
||||
|
||||
/// # Feature Configuration
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct RevoltFeatures {
|
||||
/// hCaptcha configuration
|
||||
pub captcha: CaptchaFeature,
|
||||
/// Whether email verification is enabled
|
||||
pub email: bool,
|
||||
/// Whether this server is invite only
|
||||
pub invite_only: bool,
|
||||
/// File server service configuration
|
||||
pub autumn: Feature,
|
||||
/// Proxy service configuration
|
||||
pub january: Feature,
|
||||
/// Voice server configuration
|
||||
pub livekit: VoiceFeature,
|
||||
}
|
||||
|
||||
/// # Build Information
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct BuildInformation {
|
||||
/// Commit Hash
|
||||
pub commit_sha: String,
|
||||
/// Commit Timestamp
|
||||
pub commit_timestamp: String,
|
||||
/// Git Semver
|
||||
pub semver: String,
|
||||
/// Git Origin URL
|
||||
pub origin_url: String,
|
||||
/// Build Timestamp
|
||||
pub timestamp: String,
|
||||
}
|
||||
|
||||
/// # Server Configuration
|
||||
#[derive(Serialize, JsonSchema, Debug)]
|
||||
pub struct RevoltConfig {
|
||||
/// Revolt API Version
|
||||
pub revolt: String,
|
||||
/// Features enabled on this Revolt node
|
||||
pub features: RevoltFeatures,
|
||||
/// WebSocket URL
|
||||
pub ws: String,
|
||||
/// URL pointing to the client serving this node
|
||||
pub app: String,
|
||||
/// Web Push VAPID public key
|
||||
pub vapid: String,
|
||||
/// Build information
|
||||
pub build: BuildInformation,
|
||||
}
|
||||
|
||||
/// # Query Node
|
||||
/// Query Node
|
||||
///
|
||||
/// Fetch the server configuration for this Revolt instance.
|
||||
#[openapi(tag = "Core")]
|
||||
#[utoipa::path(
|
||||
tag = "Core",
|
||||
responses((status = 200, body = v0::RevoltConfig))
|
||||
)]
|
||||
#[get("/")]
|
||||
pub async fn root() -> Result<Json<RevoltConfig>> {
|
||||
pub async fn root() -> Result<Json<v0::RevoltConfig>> {
|
||||
let config = config().await;
|
||||
|
||||
Ok(Json(RevoltConfig {
|
||||
Ok(Json(v0::RevoltConfig {
|
||||
revolt: env!("CARGO_PKG_VERSION").to_string(),
|
||||
features: RevoltFeatures {
|
||||
captcha: CaptchaFeature {
|
||||
features: v0::RevoltFeatures {
|
||||
captcha: v0::CaptchaFeature {
|
||||
enabled: !config.api.security.captcha.hcaptcha_key.is_empty(),
|
||||
key: config.api.security.captcha.hcaptcha_sitekey.clone(),
|
||||
},
|
||||
email: !config.api.smtp.host.is_empty(),
|
||||
invite_only: config.api.registration.invite_only,
|
||||
autumn: Feature {
|
||||
autumn: v0::Feature {
|
||||
enabled: !config.hosts.autumn.is_empty(),
|
||||
url: config.hosts.autumn.clone(),
|
||||
},
|
||||
january: Feature {
|
||||
january: v0::Feature {
|
||||
enabled: !config.hosts.january.is_empty(),
|
||||
url: config.hosts.january.clone(),
|
||||
},
|
||||
livekit: VoiceFeature {
|
||||
livekit: v0::VoiceFeature {
|
||||
enabled: !config.hosts.livekit.is_empty(),
|
||||
nodes: config
|
||||
.api
|
||||
@@ -121,7 +39,7 @@ pub async fn root() -> Result<Json<RevoltConfig>> {
|
||||
.nodes
|
||||
.iter()
|
||||
.filter(|(_, node)| !node.private)
|
||||
.map(|(name, value)| VoiceNode {
|
||||
.map(|(name, value)| v0::VoiceNode {
|
||||
name: name.clone(),
|
||||
lat: value.lat,
|
||||
lon: value.lon,
|
||||
@@ -138,7 +56,7 @@ pub async fn root() -> Result<Json<RevoltConfig>> {
|
||||
ws: config.hosts.events,
|
||||
app: config.hosts.app,
|
||||
vapid: config.pushd.vapid.public_key,
|
||||
build: BuildInformation {
|
||||
build: v0::BuildInformation {
|
||||
commit_sha: option_env!("VERGEN_GIT_SHA")
|
||||
.unwrap_or_else(|| "<failed to generate>")
|
||||
.to_string(),
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user