opencode/yao
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update MFA endpoint naming in API documentation and routing

Browse source 
- Renamed 2FA references to MFA in the user management API documentation and routing structure for consistency and clarity.
- Adjusted README to reflect the new endpoint paths for TOTP and SMS MFA functionalities.
This commit is contained in:
Max 2025-09-17 10:01:54 +08:00
parent 88efa1bc99
commit c5ea4dbfe8
2 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
openapi/user/README.md
View file

@ -42,18 +42,18 @@ This module provides comprehensive user management APIs including authentication
| Method | Endpoint | Auth | Description |
| ------ | ------------------------------------------ | -------- | ---------------------------------------- |
| GET | `/user/2fa/totp` | Required | Get TOTP QR code and setup info |
| POST | `/user/2fa/totp/enable` | Required | Enable TOTP with verification |
| POST | `/user/2fa/totp/disable` | Required | Disable TOTP with verification |
| POST | `/user/2fa/totp/verify` | Required | Verify TOTP code |
| GET | `/user/2fa/totp/recovery-codes` | Required | Get TOTP recovery codes |
| POST | `/user/2fa/totp/recovery-codes/regenerate` | Required | Regenerate recovery codes |
| POST | `/user/2fa/totp/reset` | Required | Reset TOTP (requires email verification) |
| GET | `/user/2fa/sms` | Required | Get SMS MFA status |
| POST | `/user/2fa/sms/enable` | Required | Enable SMS MFA |
| POST | `/user/2fa/sms/disable` | Required | Disable SMS MFA |
| POST | `/user/2fa/sms/verification-code` | Required | Send SMS verification code |
| POST | `/user/2fa/sms/verify` | Required | Verify SMS code |
| GET | `/user/mfa/totp` | Required | Get TOTP QR code and setup info |
| POST | `/user/mfa/totp/enable` | Required | Enable TOTP with verification |
| POST | `/user/mfa/totp/disable` | Required | Disable TOTP with verification |
| POST | `/user/mfa/totp/verify` | Required | Verify TOTP code |
| GET | `/user/mfa/totp/recovery-codes` | Required | Get TOTP recovery codes |
| POST | `/user/mfa/totp/recovery-codes/regenerate` | Required | Regenerate recovery codes |
| POST | `/user/mfa/totp/reset` | Required | Reset TOTP (requires email verification) |
| GET | `/user/mfa/sms` | Required | Get SMS MFA status |
| POST | `/user/mfa/sms/enable` | Required | Enable SMS MFA |
| POST | `/user/mfa/sms/disable` | Required | Disable SMS MFA |
| POST | `/user/mfa/sms/verification-code` | Required | Send SMS verification code |
| POST | `/user/mfa/sms/verify` | Required | Verify SMS code |
### OAuth & Third-Party Integration

2
openapi/user/user.go
View file

@ -202,7 +202,7 @@ func attachAccount(group *gin.RouterGroup, oauth types.OAuth) {
// MFA settings
func attachMFA(group *gin.RouterGroup, oauth types.OAuth) {
mfa := group.Group("/2fa")
mfa := group.Group("/mfa")
mfa.Use(oauth.Guard)
// TOTP Management