-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added documentation for notification (#21)
- Loading branch information
1 parent
8161bed
commit 98d5ef0
Showing
7 changed files
with
391 additions
and
643 deletions.
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
docs/notifications-service/apis/notification-controller-send-notification.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: notification-controller-send-notification | ||
title: "Send Notification" | ||
description: "Send Notification" | ||
sidebar_label: "Send Notification" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJzVWFtv6joW/iuRn2YkOIWWS+FpoCSFthBK6I2qQiZZEENip7YDpIj/PnISaCi0mq3Ze44mb0nW/fKtZW8QC4BjSRjtOKiOekySKbHjD1eMSs48D/hYAHWyv1AOBZhjHyRwgeqvG0SxD6iOQgG846Ac4vAeEg4OqkseQg4RiuroPQQeoRwStgs+RvUNklGg2ITkhM7QdvuWcIKQTeZEiuKrIJtRCVSqXzgIvNSgs7lgVH07Es0mc7ClMpgrVyUBof4ScR9CCBnCCWMeYOUarLEfeIDqU+wJyCEHhM1JEDteRy2YEgqadEFb4UhbucBBW4FGARxNMk3FSqOZYGlom5q9lsc+Z9Qh/VHvDdFXhVcJq8amsdKsaCV5AdHPUk3amErgDSmBOgA6jZPqHOm5heg7HRwCD9vgA5XiVGy/RCii2Ce2luXSpoxrEvzAwxI0iWcia+MGbWAJVPawD1tUR222UqEMBWgPHU0y5inyjaquHckNc6nWYqC+2yzkAoZEej9xqxRgW+o+Jp4iE2EQMC7/lVrxl818tN3mECgCZdOhVzHfYWIdkJjEwrHnmdO4EX4uOw42kIDs4rgPwGuitXhgzFtuJw1zjlXjEAm+ONU322zHvR6oUVJUZHYutIYm2r5tcygIhXvsZj8U7p/z0jkn7sPFU9A0gMHzk/sMhQujXG/0G7XixOgN6eDjfTo1r+e3T+1uFEzn7XU73y5Ky6zmq495wPOPwotgftjI+90WJSWvdt2YDfLRhHfd/Kw4jSruo7mgvDB0zeakKuVk/E5tYpVdRwzvL1m/PR/dCVypLMw756Nbc8noZlrs4GVtUtCXz0NZ+v1hVyHdR10kkg6DbnWtPxfz4vlFqVypXtYKv981q2ulnn2h3+HrJ/IlSLVrr7T8knhkBGanTEsyBT6pK7GVFlAnrmIVU6trHQwlBf+h72MeKcsUDGd/awbjWsPzNOlyAO01tuNMWXEmfPF2jGKfbzF4rVygGqYa+IGMtAlzIo0IBTIKSZfYS4bJfq6ks2OP+2ioW8M0CMnLuGcOO8ZLER3j68YDzOkJsMu07UHCX5FNBhU5er4qGf3STc0oPhj9+cXtpVz5gdeZycUHNK/xotpt33hO57L37lOv1Rnlw4fb9arcLD95vU7vadFoVidO3/BZNDnHhuxFKFOzXzTWatVqqVQuFwox0R42v5AdIJoqExewE68NG/W2z+ivplJP6+h/mDWTDkHIzAA9ytvBFNPVizYAn1AHuBpBP6T1vwif6oVfjV4/6b4/G7wHSx98Bs8w7jo9fWzpltUxe+OB3u30WvpgfFEYdzu9cVM3zIF+KqgChCCM7qJm2QSo/WMvjEe4uzbYWq6r7cD2rLtFOLSjMgT35l2t1WrKF6McXp3fLK1Ou+8V3Ze2i/PMrt4/zkhx8bhY36/mD20SmSU2mKzer/XR4Cm6fpmJeb6rIC3ba6O58/z+/HS9TKZY6VTv/SeNlkP2epoPaTgOgvPL9/Vt4+X2w3dn6XDUceDfTcyAGVdVod+1SG81Gnxcji5e3Kdx6XnoNi+GL5NRxbjsmf3HOR+ZD7i/dPSby+/K5hfhUxWE1bX+Npz8ve12GtLK5UqlUq1Uy4XjoG3TmSgCRkUyjc4LheNZfrz/i9C2QYhp6HmR0l06xdahS+wRRxskxx9FVz5FR6gETrGnCeBL4Bpwzni8t8ZLdf31YITmlTVqvn7ZN75mF+WQD9Jl6gwYMBGvF1i6qI7Osq6cxeJyKNGttL3lkDp6DT4PbfrnUv99kncnnR2ufndC+Tnjf98x4Qe8PrHHf49U/xf78Lftkt0sVQUSOmXxLnlimTvCjaELhwDT6He0LEkOqRpLiIt/FdJVEtsyxTBVpz6OcSu9fThV1gdK92uuKsOzwMMkPt6GPM5kUvGviB5K2LWQq/qi/oo2mwkW8MC97VZ9Ti411ILuEIEnqm5PXhxsPq8u0D8G6ar8Tw3lTtuUdMb+PiUFToTUFckSc6I0qf7bo1RsQsJ1lSjKD5XgT96j+xIla9/2fTPG3Ul67+IzR/FwvFJtiFdKdw6x2JmkFtS3DfIwnYV4pmgTmer5N73IUNg= | ||
sidebar_class_name: "post api-method" | ||
info_path: docs/notifications-service/apis/notification | ||
custom_edit_url: null | ||
--- | ||
|
||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
import ParamsDetails from "@theme/ParamsDetails"; | ||
import RequestSchema from "@theme/RequestSchema"; | ||
import StatusCodes from "@theme/StatusCodes"; | ||
import OperationTabs from "@theme/OperationTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Heading from "@theme/Heading"; | ||
|
||
<Heading | ||
as={"h1"} | ||
className={"openapi__heading"} | ||
children={"Send Notification"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"post"} | ||
path={"/notification/send"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Send Notification | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isQueue":{"type":"boolean","example":false,"description":"Define the way where we need to send notification "},"context":{"type":"string","example":"EVENT","description":"Context of the notification"},"key":{"type":"string","example":"OnAfterAttendeeEnrolled","description":"Key of the notification"},"replacements":{"type":"object","description":"Dynamic replacements for template tags","example":{"{eventName}":"How to use UI tools","{userName}":"John Doe","{courseTitle}":"How to use UI tools","{contactEmail}":"[email protected]"}},"email":{"description":"Email notification details","allOf":[{"type":"object","properties":{"receipients":{"example":["[email protected]"],"type":"array","items":{"type":"string"}}},"required":["receipients"],"title":"EmailDTO"}]},"push":{"description":"Push notification details","allOf":[{"type":"object","properties":{"receipients":{"example":["d2ihU3WpBFeoeXWhXe03F5:APA91bFNTnRzqffOGjKWHMypfjHxH-H1tSO7-7V-eajz0YsomuA-mMDni4l9GAgR-ybrMh-g1fy6hVOknr0ThOBb7ttb_qnciS5hdsTQ8oPHjZLsa66kOLdzM9hiZJf1Iav9b0EvXTt4"],"type":"array","items":{"type":"string"}}},"required":["receipients"],"title":"PushDTO"}]},"sms":{"description":"SMS notification details","allOf":[{"type":"object","properties":{"receipients":{"example":["1234567890"],"type":"array","items":{"type":"string"}}},"required":["receipients"],"title":"SMSDTO"}]}},"required":["isQueue","context","key","email","push","sms"],"title":"NotificationDto"},"examples":{"SendEmailPushSMSNotification":{"summary":"Send Notification For All three [email/push/sms]","description":"Description for when an empty body is used","value":{"isQueue":false,"context":"TEST","key":"TEST_NOTIFY1","replacements":{"{learnerName}":"John Doe"},"push":{"receipients":["ciR6tZXC4FP4J9F1UFPj3K8twmplIgtkzeBGak7MHJldI8NqmnlDIZ-uUKxw5B5WlNINWkAB7bdPFmoyb2aFtNy"]},"sms":{"receipients":["9977445500"]},"email":{"receipients":["example.com"]}},"headers":{}},"SendEmailNotification":{"summary":"Send Notification For Email","description":"Description for when an empty body is used","value":{"isQueue":false,"context":"TEST","key":"OnTestEnrolled","replacements":{"{eventName}":"Event Reminder","{learnerName}":"John Doe"},"email":{"receipients":["example.com"]}},"headers":{}},"SendPushNotification":{"summary":"Send Notification For Push","description":"Description for when an empty body is used","value":{"isQueue":false,"context":"USER","key":"OFFLINE_SESSION_REMINDER_30_MIN_BEFORE","replacements":{"{sessionName}":"Science"},"push":{"receipients":["c_ZaMxFoxtx7HpclSLkuTcy5epQOL9DDBtYF5uC2JvSIHPl1hYHha-oc7QVgi1kVkxQwjUHiyO4oRbwqGEZRWyGYgsj-M","ciR6tZXC4FP4JZjdXqXWGv:APA9149F1UFPj3K8twmplIgtkzIZ-uUKxw5B5WlNINWkAB7bdPFmoyb2aFtNy","cxf-unu_pp28qxKAYKzmhg:APA91bEapmLbOpoFC7sELDiNwZRz8Z3YhW_4XThB3TYbZ6F8NOPVjrZOUaPvdEJ8"]}},"headers":{}},"SendSMSNotification":{"summary":"Send Notification for SMS","description":"Description for when an empty body is used","value":{"isQueue":false,"context":"TEST","key":"TEST_NOTIFY","replacements":{"{eventName}":"Event Reminder","{learnerName}":"John Doe"},"sms":{"receipients":["5566676750"]}},"headers":{}}}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"send notification successfully"},"400":{"description":"Invalid Request"},"500":{"description":"internal server error"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
docs/notifications-service/apis/notification-events-controller-create.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: notification-events-controller-create | ||
title: "Create Template" | ||
description: "Create Template" | ||
sidebar_label: "Create Template" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJzlWOluGzcQfhWCBdIWWF2+I1guHEdGDSS2YCktAtsIqN2RljGX3JBcKYYgIK+R18uTFEPuoctKUiRN0fqP7eVwZjjzzcfhzKhKQTPLlbyIaJteKstHPHQfuhOQ1pwpabUSAvSbUAOzQAOaMs0SsKANbd/MqGQJ0DbNDOiLiAZUw7uMa4ho2+oMAsolbdN3GegHGtAITKh5igZom74yoMnFc8INKXcFFN6zJBWos7WzC3v7B4c1OHo6rLV2ot0a29s/qO3tHBy09lqHe81mkwbUhDEkjLZn1D6kuM9YzeWYzud33h0w9pmKHlBi1btlhwYxkOfVFzJSmtgYSE8ZS5yKgIZKWpAWlbE0FXm4Gm8NapitO6OGbyG0GDeN0bYcDK46Ne/tuteLAej+0b0c0HlALbf4YZvsIOYGI+lFV0/m0pmvzQN6Dw/btV3J05EFfWotyAigKx0Kokf0orp5QI1lNjPbFafZUHATb1DV97vnmLNUsBASkHbAxk7hsuiqwIKBCpEhS1LGx7I+4trYN+7rqs1LlgBRI3KWy5KeVomyoCliJz8F05ph5rmFZMPp5vOAQsK4WPez6z4HlAlxNXK+bQeFyfz3DRHcoJgU4ovxvYQpcUnBQA5z1H8eNSiJgZj9NGG6+dOcLHLBI+ad9vl8seRvaOWTW74rses3PbeKzu/mAU0zE68HrJeZmERgGRfme8St/3cjtqwmp4LHw4jnQHU8YeONdbusL7Y2Ne1Gw4mbeiZNKpiJ66FKGmmsrKq19ltPd4+ePt1v7h3u1vYOh6y5c3h4eNQKfxtx2wm1Sp9MO0fN5pO4c+BYcd05p33RO8Hl/eedc1Kb9Ek24WNmgaBEpXc7IIqY5NYX8IG7F1FXQsUkGyig/7L/TwOlODeaLhR9O8j0X/a/opj6L/sbYrWyvbhjim2e90ueXifagsjy8vShX7B65noAVyzOYnkeF1y/OoAkFczCudKnQizRiEtAkjD9UOoihTg5V5qcCrGdeFYv52kMkjBJIEntgw8lNyQz7nqZMJHB0l1LB93+gFbnuRjhZhYlXDYGLxrnIcnSiFkwhBEBTEvQnz58NCTVasQFBK4ZeOEXiIlVJiKiIQQ+AcKIXPCcsKHKrJP3Kut59L0Pby6vBhfnr1tVMpZvxvI+KQFL+2e90vRpGKpMWnKmIQJpOXNF4IFIj2ObCCKYHHduKchbenIcA4tOjhOwjIQx0wZs55a+GpzXjnDVfcfrsXNLJxymqdL2lpK80enc0imPbNyJYMJDqLl/AsIlR7s1EzIBnVa9iZoa3hA6cnKcnjwHpslMgGYSNF618+C4keLKn0CYBpIKYAYiYhXhcqR0Qh5URmzMbJUAwvLDxsyQIYAkJgtDMGaUCfFAfFsa1ckzEGrqtGLQhRpzWRBEO7eK/Saes01m2K46j/KlHjNmqnTUJrM0/9MvNfxhGhjUE7pwcVWZeSZUeE+ugRnDxxKLqUrGa5V9+vBxAt5zncv4IzMiYUqGbvfM/XIe1clZDOG9OwZLU4dzj6GoOFC9pNHH2L0g98+RdcmuP/Y4yFyIHfeomOF/a2TSrUpiG4UULdcyb/wOQqiCGggzzpuxBrCeq//9VLHzFVTR8z6QV3mYZwLKCqxyWTg3y913yz+XJ6jqLc9WnVwD0oPzNM8c4bJI7BclsVcWz7Yc5gj+r6XwUbZfp5SVDP7YpGFn8tmcodD/KGVrrPnjMoY/2MqZVEnjO7GdZmu9Yy7TlV+ZS/co3gR7zeb6rgs5YYJHJJ+joNz+ZjmLl6sgfdAT0KSrtdLOV+ue8DdL06Va4YxrL5c1raCLBjQBGyscUKXKuJ6e2Zi2aWMxnzVbagyocT6g1buA4mTmupoCdYsOfBF2ftBS4W51mOKB8fhQZCNG1sYY33I2sYH2q4dsCb4ve95v7Gq+QFvO09+tE9n04HrUmeL9hI2ke47lqdz6nsCB36IAOe1dkEWRgCKQvHCr3sznf8w9IdEaIjJh7mmTp3Ydvksmy3ciIq+RCsZd/DPtkumRfUMfQfZdQGMsgfYNnc2GzMArLeZz/OwHrIiwiBs2RFS2R0yY1RHnrJpf0l+u87fir2TzJHajp74UynFvzuHUgXLCNEfjWHglSzmv/K4zb7s2QMXV3rU5Kuoqi7535a6E4pmdqAj3aDbFEmNTtB1Q5c7n8OO+zSg+gDIPTK8Tf/4CXZXqAg== | ||
sidebar_class_name: "post api-method" | ||
info_path: docs/notifications-service/apis/notification | ||
custom_edit_url: null | ||
--- | ||
|
||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
import ParamsDetails from "@theme/ParamsDetails"; | ||
import RequestSchema from "@theme/RequestSchema"; | ||
import StatusCodes from "@theme/StatusCodes"; | ||
import OperationTabs from "@theme/OperationTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Heading from "@theme/Heading"; | ||
|
||
<Heading | ||
as={"h1"} | ||
className={"openapi__heading"} | ||
children={"Create Template"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"post"} | ||
path={"/notification-templates"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Create Template | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"userId","required":true,"in":"query","description":"User ID is required","example":"123e4567-e89b-12d3-a456-426614174000","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"description":"The Description for the Post Body","content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","example":"EVENT"},"title":{"type":"string","example":"This is title","description":"Event title"},"key":{"type":"string","example":"OnAfterAttendeeEnrolled","description":"Event key"},"status":{"type":"string","example":"published","description":"Status"},"replacementTags":{"description":"replacementTags","example":[{"name":"campaign.first_name","description":"Name of Campaign Promoter"}],"type":"array","items":{"type":"string"}},"email":{"description":"Email","allOf":[{"type":"object","properties":{"subject":{"type":"string","description":"Email subject","example":"New Event"},"body":{"type":"string","example":"This is body of {#var0#} Notification","description":"Email body"}},"required":["subject","body"],"title":"EmailDto"}]},"push":{"description":"Push details","allOf":[{"type":"object","properties":{"subject":{"type":"string","description":"Subject","example":"New Event"},"body":{"type":"string","description":"Body","example":"This is body of Push"},"image":{"type":"string","description":"https://images.unsplash.com/photo-1519389950473-47ba0277781c?fit=crop&w=800&h=600","example":"This is image of Push"},"link":{"type":"string","description":"link","example":"This is navigate link of Push"}},"required":["subject","body","image","link"],"title":"PushNotificationDto"}]},"sms":{"description":"SMS details","allOf":[{"type":"object","properties":{"subject":{"type":"string","description":"Subject","example":"This is SMS subject"},"body":{"type":"string","description":"Body","example":"This is body of SMS"}},"required":["subject","body"],"title":"SMSNotificationDto"}]}},"required":["context","title","key","status","replacementTags","email","push","sms"],"title":"CreateEventDto"},"examples":{"CreateTemplateForAllNotification":{"summary":"Create Template For All Notification","description":"Description for when an empty body is used","value":{"context":"TEST","title":"If an admin/TL/Fc updates a learner’s profile, the Learner should receive a notification about the update.","key":"TEST_NOTIFY1","status":"published","email":{"subject":"SCP Learner Account Credentials","body":"<html lang=\"en\"><head><meta charset=\"UTF-8\"><meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"></head><body><p>Dear {leranerName},</p><p>We are pleased to inform you that a learner account has been successfully created. Below are the login details:</p><p>Username: {userName}</p><p>Password: {password}</p></body></html>"},"push":{"subject":"Block Reassignment","body":"You’ve been reassigned to a new block {blockName}. Check the app for updated details.","image":"This is image of Push","link":"This is navigate link of Push"},"sms":{"subject":"Block Reassignment","body":"You’ve been reassigned to a new block {blockName}. Check the app for updated details."}},"headers":{}},"CreateTemplateForEmail":{"summary":"Create Template For Email","description":"Hello is used as the greeting","value":{"context":"TEST","title":"If an admin/TL/Fc updates a learner’s profile, the Learner should receive a notification about the update.","key":"TEST_NOTIFY2","status":"published","email":{"subject":"Profile Updated {leanerName}","body":"Learner {learnerName}'s profile has been updated. Review the details in the app."}},"headers":{}},"CreateTemplateForPush":{"summary":"Create Template For Push","description":"Hello is used as the greeting","value":{"context":"TEST","title":"If an admin/TL/Fc updates a learner’s profile, the Learner should receive a notification about the update.","key":"TEST_NOTIFY1","status":"published","push":{"subject":"Profile Updated","body":"Learner {learnerName}'s profile has been updated. Review the details in the app."}},"headers":{}},"CreateTemplateForSMS":{"summary":"Create Template For SMS","description":"Hello is used as the greeting","value":{"context":"TEST","title":"If an admin/TL/Fc updates a learner’s profile, the Learner should receive a notification about the update.","key":"TEST_NOTIFY1","status":"published","sms":{"subject":"Profile Updated","body":"Learner {learnerName}'s profile has been updated. Review the details in the app."}},"headers":{}}}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"201":{"description":"Template created successfully"},"400":{"description":"Invalid request"},"500":{"description":"Internal Server Error"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
...tifications-service/apis/notification-events-controller-delete-template.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: notification-events-controller-delete-template | ||
title: "Template Delete" | ||
description: "Template Delete" | ||
sidebar_label: "Template Delete" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJytUsGK2zAQ/RXzTi2oTVr2pFvp5hBYSinb0xKKYk3WYmXJK41DjdG/l4njxdtke+pJMHrzZt6bNyJ2lAy7GLYWGt8iu4OrT4XNkQLnrzFwit5T+mXJE9M9tZ03TFDoTDItMaUM/TAimJag4SwUEj33LpGF5tSTggvQ6Aw3UMh1Q62BHsFDJx2hb/eUUIp6Iekzpe2bRM89peEaU+bkwiNK2Uln7mLIlOX/83otj6VcJ9eJPGjMUqpJWZX7uqacD733A4rCzfrmH00hcnWIfbCyONg8iguvHPwwYzN26i2a29NsKLTETZQj2Lly8ktjFZacPHOuRmeLmEDpOJ1gJ/Yc4skPx57+OigudmioWgKqL9+31RKiIMwT+NPHNRTqGNjUDD2K6C5mbk2Qgee7Xcp6NfLlUEy/edV544IY3Scvf5PeB1zXCwXtrDjZxMyCG8e9yfQz+VKkPKVCkmhdNnsvoTkYn+liCVFBgaHx7sc5X+8rqOvLPdGwDOTR+F5AkIwdTXIy6f9PPRdNGJYz522cRdmVRWZuN3eb+w1K+QPB2lAU | ||
sidebar_class_name: "delete api-method" | ||
info_path: docs/notifications-service/apis/notification | ||
custom_edit_url: null | ||
--- | ||
|
||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
import ParamsDetails from "@theme/ParamsDetails"; | ||
import RequestSchema from "@theme/RequestSchema"; | ||
import StatusCodes from "@theme/StatusCodes"; | ||
import OperationTabs from "@theme/OperationTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Heading from "@theme/Heading"; | ||
|
||
<Heading | ||
as={"h1"} | ||
className={"openapi__heading"} | ||
children={"Template Delete"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"delete"} | ||
path={"/notification-templates/{id}"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Template Delete | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"number"}},{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={undefined} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"Template delete successfully"},"404":{"description":"Template not found"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
...notifications-service/apis/notification-events-controller-get-templates.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: notification-events-controller-get-templates | ||
title: "Template List" | ||
description: "Template List" | ||
sidebar_label: "Template List" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJyNVE1v2zAM/SsGTxugLt2wXXzbumwIMLRF2+0SBANjM7E6WXIlOm1g+L8PlJyPxsEw3yw9ku+Rj+rANeSRtbOzEnK4dqxXuogH0w1ZDlfOsnfGkP+9Jn6gujHIFEBBgx5rYvIB8nkHFmuCHNpAflaCAk9PrfZUQs6+JQXaQg5PLfktKAhFRTVC3gFvGwkL7LVdQ98vUiQF/uLKrSBOExXOMlmWK2waM7CdPAZn5WyU2i0fqWAh7EUsawpyu9Imce+gpFB43UgayOFbushWzmeB0BcVKEBjblZR57+zRnIvPFamgF6wbowcTX9Nrx+gV/CHtv+F7I/bOd8XSQkWClhzhN9Hul/ZQb84DdrpHcGT3hjUp6DQOBuSng+Xl+MOfSfOeHBCZnRg0fLxHHJmN2h0mQ0jFdyn8zgmb9Fk9+Q35LOp985H3Yxr8dcrZ14cbLhQJ5l2V9kP4aWgJq6cWLtx8b9BriCHiT3OtxMTJiZFhUhDCi8UiLPuDp6c7qbzykP7wQ8zG4Z7NEFtVy5Oe+j+sSIYyagoOwZkn29n2TFEgRBM4PfvLiHtBRZiPakmcmuMGzFs5mlnXhXcm1BETBqD2sqwWm/kLjVtDuebBgpi2xYKKmlyPoeuW2Kgn970vRyntZftKXXApRFHrtAEGrHYLze8uRvM+zYDdZ5d6vD+xdmgaQUE8ohs0GupJCPsFVSEJflIIUVdpUIXD5L4EDt6USTX3kO3N/cy2eXwMtWulBiPz/Le4bPUVuCimGiKeNaBQbtucS3YlFO+v0n448I= | ||
sidebar_class_name: "post api-method" | ||
info_path: docs/notifications-service/apis/notification | ||
custom_edit_url: null | ||
--- | ||
|
||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
import ParamsDetails from "@theme/ParamsDetails"; | ||
import RequestSchema from "@theme/RequestSchema"; | ||
import StatusCodes from "@theme/StatusCodes"; | ||
import OperationTabs from "@theme/OperationTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Heading from "@theme/Heading"; | ||
|
||
<Heading | ||
as={"h1"} | ||
className={"openapi__heading"} | ||
children={"Template List"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"post"} | ||
path={"/notification-templates/list"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Template List | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"description":"Filters for search","allOf":[{"type":"object","properties":{"context":{"type":"string","example":"EVENT"},"key":{"type":"string","example":"EVENT"}},"required":["context","key"],"title":"SearchDto"}]}},"required":["filters"],"title":"SearchFilterDto"}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"Get template list"},"400":{"description":"Invalid request"},"500":{"description":"Internal Server Error"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
Oops, something went wrong.