Skip to content

Commit a05eed2

Browse files
committed
docs: updated README doc for new endpoint implementation
1 parent c4ab64e commit a05eed2

1 file changed

Lines changed: 58 additions & 9 deletions

File tree

README.md

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,17 +107,18 @@ export class AppModule implements OnModuleInit {
107107
108108
## API Routes
109109

110-
### Local Auth Routes (Public)
110+
### Local Auth Routes
111111

112112
```
113-
POST /api/auth/register
114-
POST /api/auth/verify-email
115-
POST /api/auth/resend-verification
116-
POST /api/auth/login
117-
POST /api/auth/refresh-token
118-
POST /api/auth/forgot-password
119-
POST /api/auth/reset-password
120-
DELETE /api/auth/account (protected)
113+
POST /api/auth/register | Register new user (public)
114+
POST /api/auth/verify-email | Verify email with token (public)
115+
POST /api/auth/resend-verification | Resend verification email (public)
116+
POST /api/auth/login | Login with credentials (public)
117+
POST /api/auth/refresh-token | Refresh access token (public)
118+
POST /api/auth/forgot-password | Request password reset (public)
119+
POST /api/auth/reset-password | Reset password with token (public)
120+
GET /api/auth/me | Get current user profile (protected)
121+
DELETE /api/auth/account | Delete own account (protected)
121122
```
122123

123124
### OAuth Routes - Mobile Exchange (Public)
@@ -321,6 +322,54 @@ Content-Type: application/json
321322
}
322323
```
323324

325+
### Get Current User Profile
326+
327+
**Request:**
328+
329+
```json
330+
GET /api/auth/me
331+
Authorization: Bearer access-token
332+
```
333+
334+
**Response:**
335+
336+
```json
337+
{
338+
"ok": true,
339+
"data": {
340+
"_id": "507f1f77bcf86cd799439011",
341+
"fullname": {
342+
"fname": "Test",
343+
"lname": "User"
344+
},
345+
"username": "test-user",
346+
"email": "user@example.com",
347+
"avatar": "https://example.com/avatar.jpg",
348+
"phoneNumber": "+1234567890",
349+
"jobTitle": "Software Engineer",
350+
"company": "Ciscode",
351+
"isVerified": true,
352+
"isBanned": false,
353+
"roles": [
354+
{
355+
"_id": "507f1f77bcf86cd799439012",
356+
"name": "user",
357+
"permissions": [
358+
{
359+
"_id": "507f1f77bcf86cd799439013",
360+
"name": "read:profile"
361+
}
362+
]
363+
}
364+
],
365+
"createdAt": "2026-01-28T10:00:00.000Z",
366+
"updatedAt": "2026-01-28T10:00:00.000Z"
367+
}
368+
}
369+
```
370+
371+
**Note:** Sensitive fields like `password` and `passwordChangedAt` are automatically excluded from the response.
372+
324373
### Delete Account
325374

326375
**Request:**

0 commit comments

Comments
 (0)