You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: subscription/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
|-------|--------|-------------|
7
7
|[/subscription](#post-subscription)| POST | Subscribe a user |
8
8
|[/subscription](#put-subscription)| PUT | Unsubscribe a user |
9
-
|[/subscription/send-email](#get-subscriptionsend-email)| GET | Send a test email |
9
+
|[/subscription/notify](#get-subscriptionnotify)| GET | Send a test email |
10
10
11
11
## POST /subscription
12
12
@@ -76,7 +76,7 @@ Unsubscribe a user from notifications.
76
76
}
77
77
```
78
78
79
-
## GET /subscription/send-email
79
+
## GET /subscription/notify
80
80
81
81
Send a test email. This endpoint is for development and testing purposes only.
82
82
@@ -116,7 +116,7 @@ Send a test email. This endpoint is for development and testing purposes only.
116
116
## Notes
117
117
118
118
1. All routes require authentication.
119
-
2. The `/subscription/send-email` route is restricted to users with the SUPERUSER role.
119
+
2. The `/subscription/notify` route is restricted to users with the SUPERUSER role.
120
120
3. Error handling for authentication and authorization failures is not explicitly defined in the provided code, but would typically result in 401 (Unauthorized) or 403 (Forbidden) responses.
121
121
4. The email sending functionality uses nodemailer and requires proper configuration of SMTP credentials.
122
122
5. The API uses Express.js and includes middleware for authentication and role-based authorization.
0 commit comments