Skip to content

Commit fa93c02

Browse files
committed
improve comments
1 parent 0c543b8 commit fa93c02

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

config/email_template.config.js

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@
66
const config = require('config')
77

88
module.exports = {
9-
/* Report a general issue for a team.
10-
*
11-
* - projectId: the project ID. Example: 123412
12-
* - projectName: the project name. Example: "TaaS API Misc Updates"
13-
* - reportText: the body of reported issue. Example: "I have issue with ... \n ... Thank you in advance!"
9+
/**
10+
* List all the kind of emails which could be sent by the endpoint `POST /taas-teams/email` inside `teamTemplates`.
1411
*/
1512
teamTemplates: {
13+
/* Report a general issue for a team.
14+
*
15+
* - projectId: the project ID. Example: 123412
16+
* - projectName: the project name. Example: "TaaS API Misc Updates"
17+
* - reportText: the body of reported issue. Example: "I have issue with ... \n ... Thank you in advance!"
18+
*/
1619
'team-issue-report': {
1720
subject: 'Issue Reported on TaaS Team {{projectName}} ({{projectId}}).',
1821
body: 'Project Name: {{projectName}}' + '\n' +
@@ -103,6 +106,10 @@ module.exports = {
103106
sendgridTemplateId: config.INTERVIEW_INVITATION_SENDGRID_TEMPLATE_ID
104107
}
105108
},
109+
110+
/**
111+
* List all kind of emails which could be send as Email Notifications by scheduler, API endpoints or anything else.
112+
*/
106113
notificationEmailTemplates: {
107114
'taas.notification.candidates-available-for-review': {
108115
subject: 'Topcoder - {{teamName}} has job candidates available for review',

0 commit comments

Comments
 (0)