Skip to content

feat(shield-sea-orm): add utoipa feature #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2025
Merged

feat(shield-sea-orm): add utoipa feature #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions examples/sea-orm/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,6 @@ sea-orm-migration = { workspace = true, features = [
] }
shield-sea-orm = { path = "../../packages/storage/shield-sea-orm", features = [
"all-providers",
"utoipa",
] }
tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
3 changes: 3 additions & 0 deletions packages/storage/shield-sea-orm/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ version.workspace = true

[dependencies]
async-trait.workspace = true
chrono.workspace = true
sea-orm.workspace = true
sea-orm-migration.workspace = true
serde = { workspace = true, features = ["derive"] }
Expand All @@ -20,6 +21,7 @@ shield = { path = "../../core/shield", version = "0.0.4" }
# shield-oauth = { path = "../../providers/shield-oauth", version = "0.0.2", optional = true }
shield-oidc = { path = "../../providers/shield-oidc", version = "0.0.4", optional = true }
# shield-webauthn = { path = "../../providers/shield-webauthn", version = "0.0.2", optional = true }
utoipa = { workspace = true, optional = true }

[features]
default = []
Expand All @@ -39,3 +41,4 @@ provider-email = []
provider-oauth = []
provider-oidc = ["dep:shield-oidc"]
# provider-webauthn = ["dep:shield-webauthn"]
utoipa = ["dep:utoipa", "shield/utoipa"]
9 changes: 5 additions & 4 deletions packages/storage/shield-sea-orm/src/entities/email_address.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = EmailAddress))]
#[sea_orm(table_name = "email_address")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
#[sea_orm(unique)]
pub email: String,
pub is_primary: bool,
pub is_verified: bool,
pub verification_token: Option<String>,
pub verification_token_expired_at: Option<DateTimeWithTimeZone>,
pub verified_at: Option<DateTimeWithTimeZone>,
pub verification_token_expired_at: Option<chrono::DateTime<chrono::FixedOffset>>,
pub verified_at: Option<chrono::DateTime<chrono::FixedOffset>>,
#[cfg(feature = "entity")]
pub entity_id: Uuid,
#[cfg(not(feature = "entity"))]
Expand Down
7 changes: 4 additions & 3 deletions packages/storage/shield-sea-orm/src/entities/email_auth_token.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = EmailAuthToken))]
#[sea_orm(table_name = "email_auth_token")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
pub email: String,
pub token: String,
pub expired_at: DateTimeWithTimeZone,
pub expired_at: chrono::DateTime<chrono::FixedOffset>,
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
Expand Down
5 changes: 3 additions & 2 deletions packages/storage/shield-sea-orm/src/entities/entity.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = Entity))]
#[sea_orm(table_name = "entity")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
#[sea_orm(column_type = "Text")]
pub name: String,
}
Expand Down
8 changes: 6 additions & 2 deletions packages/storage/shield-sea-orm/src/entities/oauth_provider.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(
rs_type = "String",
db_type = "Enum",
Expand All @@ -19,6 +20,7 @@ pub enum OauthProviderPkceCodeChallenge {
}

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(
rs_type = "String",
db_type = "Enum",
Expand All @@ -30,6 +32,7 @@ pub enum OauthProviderType {
}

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(
rs_type = "String",
db_type = "Enum",
Expand All @@ -43,12 +46,13 @@ pub enum OauthProviderVisibility {
}

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = OauthProvider))]
#[sea_orm(table_name = "oauth_provider")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
pub name: String,
pub slug: Option<String>,
pub r#type: OauthProviderType,
Expand Down
7 changes: 4 additions & 3 deletions packages/storage/shield-sea-orm/src/entities/oauth_provider_connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = OauthProviderConnection))]
#[sea_orm(table_name = "oauth_provider_connection")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
pub identifier: String,
#[sea_orm(column_type = "Text")]
pub token_type: String,
#[sea_orm(column_type = "Text")]
pub access_token: String,
#[sea_orm(column_type = "Text", nullable)]
pub refresh_token: Option<String>,
pub expired_at: Option<DateTimeWithTimeZone>,
pub expired_at: Option<chrono::DateTime<chrono::FixedOffset>>,
#[sea_orm(column_type = "Text", nullable)]
pub scopes: Option<String>,
pub provider_id: Uuid,
Expand Down
8 changes: 6 additions & 2 deletions packages/storage/shield-sea-orm/src/entities/oidc_provider.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(
rs_type = "String",
db_type = "Enum",
Expand All @@ -19,13 +20,15 @@ pub enum OidcProviderPkceCodeChallenge {
}

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(rs_type = "String", db_type = "Enum", enum_name = "oidc_provider_type")]
pub enum OidcProviderType {
#[sea_orm(string_value = "custom")]
Custom,
}

#[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[sea_orm(
rs_type = "String",
db_type = "Enum",
Expand All @@ -39,12 +42,13 @@ pub enum OidcProviderVisibility {
}

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = OidcProvider))]
#[sea_orm(table_name = "oidc_provider")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
pub name: String,
pub slug: Option<String>,
pub r#type: OidcProviderType,
Expand Down
7 changes: 4 additions & 3 deletions packages/storage/shield-sea-orm/src/entities/oidc_provider_connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = OidcProviderConnection))]
#[sea_orm(table_name = "oidc_provider_connection")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
pub identifier: String,
#[sea_orm(column_type = "Text")]
pub token_type: String,
Expand All @@ -19,7 +20,7 @@ pub struct Model {
pub refresh_token: Option<String>,
#[sea_orm(column_type = "Text", nullable)]
pub id_token: Option<String>,
pub expired_at: Option<DateTimeWithTimeZone>,
pub expired_at: Option<chrono::DateTime<chrono::FixedOffset>>,
#[sea_orm(column_type = "Text", nullable)]
pub scopes: Option<String>,
pub provider_id: Uuid,
Expand Down
5 changes: 3 additions & 2 deletions packages/storage/shield-sea-orm/src/entities/user.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ use sea_orm::entity::prelude::*;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema), schema(as = User))]
#[sea_orm(table_name = "user")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
pub id: Uuid,
pub created_at: DateTimeWithTimeZone,
pub updated_at: DateTimeWithTimeZone,
pub created_at: chrono::DateTime<chrono::FixedOffset>,
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
#[cfg(not(feature = "entity"))]
#[sea_orm(column_type = "Text")]
pub name: String,
Expand Down