From c70459b10ce107611b9d478add26db372361baf2 Mon Sep 17 00:00:00 2001 From: Tom Date: Sun, 7 Jun 2026 16:56:00 -0700 Subject: [PATCH] fix: openapi using old naming (#777) * fix: openapi using old naming Signed-off-by: IAmTomahawkx * fix: remove january openapi security header Signed-off-by: IAmTomahawkx * fix(docs): more Revolt usage Signed-off-by: IAmTomahawkx --------- Signed-off-by: IAmTomahawkx --- crates/delta/src/routes/mod.rs | 98 ++++++++--------------------- crates/services/january/src/main.rs | 40 +++++------- 2 files changed, 42 insertions(+), 96 deletions(-) diff --git a/crates/delta/src/routes/mod.rs b/crates/delta/src/routes/mod.rs index cf1c4ace..768531fc 100644 --- a/crates/delta/src/routes/mod.rs +++ b/crates/delta/src/routes/mod.rs @@ -64,47 +64,6 @@ pub fn mount(config: Settings, mut rocket: Rocket) -> Rocket { }; } - if config.features.webhooks_enabled { - mount_endpoints_and_merged_docs! { - rocket, "/0.8".to_owned(), settings, - "/" => (vec![], custom_openapi_spec()), - "" => openapi_get_routes_spec![root::root], - "/users" => users::routes(), - "/bots" => bots::routes(), - "/channels" => channels::routes(), - "/servers" => servers::routes(), - "/invites" => invites::routes(), - "/custom" => customisation::routes(), - "/safety" => safety::routes(), - "/auth/account" => rocket_authifier::routes::account::routes(), - "/auth/session" => rocket_authifier::routes::session::routes(), - "/auth/mfa" => rocket_authifier::routes::mfa::routes(), - "/onboard" => onboard::routes(), - "/push" => push::routes(), - "/sync" => sync::routes(), - "/webhooks" => webhooks::routes() - }; - } else { - mount_endpoints_and_merged_docs! { - rocket, "/0.8".to_owned(), settings, - "/" => (vec![], custom_openapi_spec()), - "" => openapi_get_routes_spec![root::root], - "/users" => users::routes(), - "/bots" => bots::routes(), - "/channels" => channels::routes(), - "/servers" => servers::routes(), - "/invites" => invites::routes(), - "/custom" => customisation::routes(), - "/safety" => safety::routes(), - "/auth/account" => rocket_authifier::routes::account::routes(), - "/auth/session" => rocket_authifier::routes::session::routes(), - "/auth/mfa" => rocket_authifier::routes::mfa::routes(), - "/onboard" => onboard::routes(), - "/push" => push::routes(), - "/sync" => sync::routes() - }; - } - rocket } @@ -115,8 +74,8 @@ fn custom_openapi_spec() -> OpenApi { extensions.insert( "x-logo".to_owned(), json!({ - "url": "https://revolt.chat/header.png", - "altText": "Revolt Header" + "url": "https://stoat.chat/header.png", + "altText": "Stoat Header" }), ); @@ -124,7 +83,7 @@ fn custom_openapi_spec() -> OpenApi { "x-tagGroups".to_owned(), json!([ { - "name": "Revolt", + "name": "Stoat", "tags": [ "Core" ] @@ -205,18 +164,21 @@ fn custom_openapi_spec() -> OpenApi { OpenApi { openapi: OpenApi::default_version(), info: Info { - title: "Revolt API".to_owned(), + title: "Stoat API".to_owned(), description: Some("Open source user-first chat platform.".to_owned()), - terms_of_service: Some("https://revolt.chat/terms".to_owned()), + terms_of_service: Some("https://stoat.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()), + name: Some("Stoat".to_owned()), + url: Some("https://stoat.chat".to_owned()), + email: Some("contact@stoat.chat".to_owned()), ..Default::default() }), license: Some(License { name: "AGPLv3".to_owned(), - url: Some("https://github.com/stoatchat/stoatchat/blob/main/crates/delta/LICENSE".to_owned()), + url: Some( + "https://github.com/stoatchat/stoatchat/blob/main/crates/delta/LICENSE" + .to_owned(), + ), ..Default::default() }), version: env!("CARGO_PKG_VERSION").to_string(), @@ -224,29 +186,19 @@ fn custom_openapi_spec() -> OpenApi { }, servers: vec![ Server { - url: "https://api.revolt.chat".to_owned(), - description: Some("Revolt Production".to_owned()), + url: "https://api.stoat.chat".to_owned(), + description: Some("Stoat 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()), + url: "https://beta.stoat.chat/api".to_owned(), + description: Some("Stoat Beta".to_owned()), ..Default::default() }, ], external_docs: Some(ExternalDocs { - url: "https://developers.revolt.chat".to_owned(), - description: Some("Revolt Developer Documentation".to_owned()), + url: "https://developers.stoat.chat".to_owned(), + description: Some("Stoat Developer Documentation".to_owned()), ..Default::default() }), extensions, @@ -254,19 +206,19 @@ fn custom_openapi_spec() -> OpenApi { Tag { name: "Core".to_owned(), description: Some( - "Use in your applications to determine information about the Revolt node" + "Use in your applications to determine information about the Stoat node" .to_owned(), ), ..Default::default() }, Tag { name: "User Information".to_owned(), - description: Some("Query and fetch users on Revolt".to_owned()), + description: Some("Query and fetch users on Stoat".to_owned()), ..Default::default() }, Tag { name: "Direct Messaging".to_owned(), - description: Some("Direct message other users on Revolt".to_owned()), + description: Some("Direct message other users on Stoat".to_owned()), ..Default::default() }, Tag { @@ -283,7 +235,7 @@ fn custom_openapi_spec() -> OpenApi { }, Tag { name: "Channel Information".to_owned(), - description: Some("Query and fetch channels on Revolt".to_owned()), + description: Some("Query and fetch channels on Stoat".to_owned()), ..Default::default() }, Tag { @@ -313,7 +265,7 @@ fn custom_openapi_spec() -> OpenApi { }, Tag { name: "Server Information".to_owned(), - description: Some("Query and fetch servers on Revolt".to_owned()), + description: Some("Query and fetch servers on Stoat".to_owned()), ..Default::default() }, Tag { @@ -349,7 +301,7 @@ fn custom_openapi_spec() -> OpenApi { Tag { name: "Onboarding".to_owned(), description: Some( - "After signing up to Revolt, users must pick a unique username".to_owned(), + "After signing up to Stoat, users must pick a unique username".to_owned(), ), ..Default::default() }, @@ -361,7 +313,7 @@ fn custom_openapi_spec() -> OpenApi { Tag { name: "Web Push".to_owned(), description: Some( - "Subscribe to and receive Revolt push notifications while offline".to_owned(), + "Subscribe to and receive Stoat push notifications while offline".to_owned(), ), ..Default::default() }, diff --git a/crates/services/january/src/main.rs b/crates/services/january/src/main.rs index b905b87d..e203ce28 100644 --- a/crates/services/january/src/main.rs +++ b/crates/services/january/src/main.rs @@ -21,32 +21,26 @@ async fn main() -> Result<(), std::io::Error> { // Configure API schema #[derive(OpenApi)] #[openapi( - modifiers(&SecurityAddon), - paths( - api::root, - api::proxy, - api::embed - ), - components( - schemas( - api::RootResponse, - revolt_result::Error, - revolt_result::ErrorType, - revolt_models::v0::ImageSize, - revolt_models::v0::Image, - revolt_models::v0::Video, - revolt_models::v0::TwitchType, - revolt_models::v0::LightspeedType, - revolt_models::v0::BandcampType, - revolt_models::v0::Special, - revolt_models::v0::WebsiteMetadata, - revolt_models::v0::Text, - revolt_models::v0::Embed - ) - ) + paths(api::root, api::proxy, api::embed), + components(schemas( + api::RootResponse, + revolt_result::Error, + revolt_result::ErrorType, + revolt_models::v0::ImageSize, + revolt_models::v0::Image, + revolt_models::v0::Video, + revolt_models::v0::TwitchType, + revolt_models::v0::LightspeedType, + revolt_models::v0::BandcampType, + revolt_models::v0::Special, + revolt_models::v0::WebsiteMetadata, + revolt_models::v0::Text, + revolt_models::v0::Embed + )) )] struct ApiDoc; + #[allow(dead_code)] struct SecurityAddon; impl Modify for SecurityAddon {