Skip to content

Commit 3ccb059

Browse files
committed
fix: change API name to notify
1 parent ad5ebe3 commit 3ccb059

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

subscription/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
|-------|--------|-------------|
77
| [/subscription](#post-subscription) | POST | Subscribe a user |
88
| [/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 |
1010

1111
## POST /subscription
1212

@@ -76,7 +76,7 @@ Unsubscribe a user from notifications.
7676
}
7777
```
7878

79-
## GET /subscription/send-email
79+
## GET /subscription/notify
8080

8181
Send a test email. This endpoint is for development and testing purposes only.
8282

@@ -116,7 +116,7 @@ Send a test email. This endpoint is for development and testing purposes only.
116116
## Notes
117117

118118
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.
120120
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.
121121
4. The email sending functionality uses nodemailer and requires proper configuration of SMTP credentials.
122122
5. The API uses Express.js and includes middleware for authentication and role-based authorization.

0 commit comments

Comments
 (0)