@@ -131,10 +131,10 @@ async function validate(args, draft = false) {
131
131
*
132
132
* @param {object } params params object
133
133
*
134
- * @api {POST } i/push/message/test message/ test
134
+ * @api {POST } i/push/message/test Message / test
135
135
* @apiName message/test
136
136
* @apiDescription Send push notification to test users specified in application plugin configuration
137
- * @apiGroup push
137
+ * @apiGroup Push Notifications
138
138
*
139
139
* @apiQuery {ObjectID} app_id application id
140
140
* @apiUse PushMessageBody
@@ -238,11 +238,11 @@ module.exports.test = async params => {
238
238
*
239
239
* @param {object } params params object
240
240
*
241
- * @api {POST } i/push/message/create message/ create
241
+ * @api {POST } i/push/message/create Message / create
242
242
* @apiName message/create
243
243
* @apiDescription Create push notification.
244
244
* Set status to "draft" to create a draft, leave it unspecified otherwise.
245
- * @apiGroup push
245
+ * @apiGroup Push Notifications
246
246
*
247
247
* @apiQuery {ObjectID} app_id application id
248
248
* @apiUse PushMessageBody
@@ -290,10 +290,10 @@ module.exports.create = async params => {
290
290
*
291
291
* @param {object } params params object
292
292
*
293
- * @api {POST } i/push/message/update message/ update
293
+ * @api {POST } i/push/message/update Message / update
294
294
* @apiName message/update
295
295
* @apiDescription Update push notification
296
- * @apiGroup push
296
+ * @apiGroup Push Notifications
297
297
*
298
298
* @apiQuery {ObjectID} app_id application id
299
299
* @apiUse PushMessageBody
@@ -350,10 +350,10 @@ module.exports.update = async params => {
350
350
*
351
351
* @param {object } params params object
352
352
*
353
- * @api {POST } i/push/message/remove message/ remove
353
+ * @api {POST } i/push/message/remove Message / remove
354
354
* @apiName message/remove
355
- * @apiDescription Remove push notification
356
- * @apiGroup push
355
+ * @apiDescription Remove message by marking it as deleted (it stays in the database for consistency)
356
+ * @apiGroup Push Notifications
357
357
*
358
358
* @apiQuery {ObjectID} _id message id
359
359
* @apiSuccessExample {json} Success
@@ -408,12 +408,12 @@ module.exports.remove = async params => {
408
408
*
409
409
* @param {object } params params object
410
410
*
411
- * @api {POST } i/push/message/toggle message/ toggle
411
+ * @api {POST } i/push/message/toggle Message / API or Automated / toggle
412
412
* @apiName message/toggle
413
- * @apiDescription Stop or start automated message
414
- * @apiGroup push
413
+ * @apiDescription Stop active or start inactive API or automated message
414
+ * @apiGroup Push Notifications
415
415
*
416
- * @apiQuery {ObjectID} _id message id
416
+ * @apiQuery {ObjectID} _id message ID
417
417
* @apiQuery {Boolean} active true to start the message, false to stop it
418
418
* @apiUse PushMessage
419
419
* @apiUse PushValidationError
@@ -490,10 +490,10 @@ module.exports.toggle = async params => {
490
490
*
491
491
* @param {object } params params object
492
492
*
493
- * @api {POST } o/push/message/estimate message/ estimate
493
+ * @api {POST } o/push/message/estimate Message / estimate audience
494
494
* @apiName message/estimate
495
495
* @apiDescription Estimate message audience
496
- * @apiGroup push
496
+ * @apiGroup Push Notifications
497
497
*
498
498
* @apiBody {ObjectID} app Application ID
499
499
* @apiBody {String[]} platforms Array of platforms to send to
@@ -585,10 +585,10 @@ module.exports.estimate = async params => {
585
585
*
586
586
* @param {object } params params object
587
587
*
588
- * @api {GET } o/push/message/mime message/mime
588
+ * @api {GET } o/push/message/mime Message / attachment MIME
589
589
* @apiName message/mime
590
590
* @apiDescription Get MIME information of the URL specified by sending HEAD request and then GET if HEAD doesn't work. Respects proxy setting, follows redirects and returns end URL along with content type & length.
591
- * @apiGroup push
591
+ * @apiGroup Push Notifications
592
592
*
593
593
* @apiQuery {String} url URL to check
594
594
*
@@ -644,10 +644,10 @@ module.exports.mime = async params => {
644
644
*
645
645
* @param {object } params params object
646
646
*
647
- * @api {GET } o/push/message/GET message/ GET
647
+ * @api {GET } o/push/message/GET Message / GET
648
648
* @apiName message/GET
649
- * @apiDescription Get message by id
650
- * @apiGroup push
649
+ * @apiDescription Get message by ID
650
+ * @apiGroup Push Notifications
651
651
*
652
652
* @apiQuery {ObjectID} _id Message ID
653
653
*
@@ -689,11 +689,11 @@ module.exports.one = async params => {
689
689
* @param {object } params params
690
690
* @returns {Promise } resolves to true
691
691
*
692
- * @api {GET } o/push/user user
692
+ * @api {GET } o/push/user User notifications
693
693
* @apiName user
694
694
* @apiDescription Get notifications sent to a particular user.
695
695
* Makes a look up either by user id (uid) or did (device id). Returns ids of messages & dates, optionally returns corresponding message objects.
696
- * @apiGroup push
696
+ * @apiGroup Push Notifications
697
697
*
698
698
* @apiQuery {String} app_id Application ID
699
699
* @apiQuery {Boolean} messages Whether to return Message objects as well
@@ -773,11 +773,11 @@ module.exports.user = async params => {
773
773
* @param {object } params params
774
774
* @returns {Promise } resolves to true
775
775
*
776
- * @api {GET } o/push/message/all message/all
776
+ * @api {GET } o/push/message/all Message / find
777
777
* @apiName message/all
778
778
* @apiDescription Get messages
779
779
* Returns one of three groups: one time messages (neither auto, nor api params set or set to false), automated messages (auto = "true"), API messages (api = "true")
780
- * @apiGroup push
780
+ * @apiGroup Push Notifications
781
781
*
782
782
* @apiQuery {String} app_id Application ID
783
783
* @apiQuery {Boolean} auto Whether to return only automated messages
0 commit comments