Function backend::routes::user::user_sign_up[][src]

pub async fn user_sign_up(
    db: Connection<PgDb>,
    kvdb: Connection<RedisDb>,
    user_info: Json<UserInfo<'_>>
) -> (Status, Result<Json<UserResponse>, Json<ErrorResponse>>)
Expand description

User Sign-up

Sign up a user.

Parameters

  • Connection<PgDb>: Postgres connection
  • Connection<RedisDb>: Redis connection
  • Json<UserInfo>: Json of UserInfo, including username, password, email, verification code

Returns

  • Status: HTTP status
  • Json<UserResponse>: Json of UserResponse, including burrow_id of user’s assigned default burrow

Errors

  • ErrorResponse: Error message
    • ErrorCode::EmailInvalid
    • ErrorCode::EmailDuplicate
    • ErrorCode::EmptyField
    • ErrorCode::UsernameDuplicate
    • ErrorCode::CredentialInvalid
    • ErrorCode::DatabaseErr