Skip to content

Commit 27df385

Browse files
authored
Apply suggestions from code review
1 parent 3eef797 commit 27df385

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

core/database/foxx/api/note_router.js

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ router
3535
httpVerb: "POST",
3636
routePath: basePath + "/create",
3737
status: "Started",
38-
description: "Create an annotation on an object",
38+
description: "Create an annotation on an object " + req.queryParams.subject,
3939
});
4040

4141
if (!permissions.hasAdminPermObject(client, id)) {
@@ -106,7 +106,7 @@ router
106106
httpVerb: "POST",
107107
routePath: basePath + "/create",
108108
status: "Success",
109-
description: "Create an annotation on an object",
109+
description: "Create an annotation on an object " + req.queryParams.subject,
110110
extra: result,
111111
});
112112
},
@@ -121,7 +121,7 @@ router
121121
httpVerb: "POST",
122122
routePath: basePath + "/create",
123123
status: "Failure",
124-
description: "Create an annotation on an object",
124+
description: "Create an annotation on an object " + req.queryParams.subject,
125125
extra: result,
126126
error: e,
127127
});
@@ -159,7 +159,7 @@ router
159159
httpVerb: "POST",
160160
routePath: basePath + "/update",
161161
status: "Started",
162-
description: "Update an annotation",
162+
description: "Update annotation " + req.queryParams.id,
163163
});
164164

165165
if (!req.queryParams.id.startsWith("n/"))
@@ -283,7 +283,7 @@ router
283283
httpVerb: "POST",
284284
routePath: basePath + "/update",
285285
status: "Success",
286-
description: "Update an annotation",
286+
description: "Update annotation " + req.queryParams.id,
287287
extra: result,
288288
});
289289
},
@@ -298,7 +298,7 @@ router
298298
httpVerb: "POST",
299299
routePath: basePath + "/update",
300300
status: "Failure",
301-
description: "Update an annotation",
301+
description: "Update annotation " + req.queryParams.id,
302302
extra: result,
303303
error: e,
304304
});
@@ -336,7 +336,7 @@ router
336336
httpVerb: "POST",
337337
routePath: basePath + "/comment/edit",
338338
status: "Started",
339-
description: "Edit an annotation comment",
339+
description: "Edit annotation comment " + req.queryParams.id,
340340
});
341341

342342
if (!req.queryParams.id.startsWith("n/"))
@@ -383,7 +383,7 @@ router
383383
httpVerb: "POST",
384384
routePath: basePath + "/comment/edit",
385385
status: "Success",
386-
description: "Edit an annotation comment",
386+
description: "Edit annotation comment " + req.queryParams.id,
387387
extra: note,
388388
});
389389
},
@@ -395,7 +395,7 @@ router
395395
httpVerb: "POST",
396396
routePath: basePath + "/comment/edit",
397397
status: "Failure",
398-
description: "Edit an annotation comment",
398+
description: "Edit an annotation comment " + req.queryParams.id,
399399
extra: note,
400400
error: e,
401401
});
@@ -420,7 +420,7 @@ router
420420
httpVerb: "GET",
421421
routePath: basePath + "/view",
422422
status: "Started",
423-
description: "Edit an annotation comment",
423+
description: "View annotation " + req.queryParams.id,
424424
});
425425

426426
if (!req.queryParams.id.startsWith("n/"))
@@ -480,7 +480,7 @@ router
480480
httpVerb: "GET",
481481
routePath: basePath + "/view",
482482
status: "Success",
483-
description: "View annotation",
483+
description: "View annotation " + req.queryParams.id,
484484
extra: note,
485485
});
486486
} catch (e) {
@@ -490,7 +490,7 @@ router
490490
httpVerb: "GET",
491491
routePath: basePath + "/view",
492492
status: "Failure",
493-
description: "View annotation",
493+
description: "View annotation " + req.queryParams.id,
494494
extra: note,
495495
error: e,
496496
});
@@ -515,7 +515,7 @@ router
515515
httpVerb: "GET",
516516
routePath: basePath + "/list/by_subject",
517517
status: "Started",
518-
description: "List annotations by subject",
518+
description: "List annotations by subject " + req.queryParams.subject,
519519
});
520520

521521
var qry,
@@ -551,7 +551,7 @@ router
551551
httpVerb: "GET",
552552
routePath: basePath + "/list/by_subject",
553553
status: "Success",
554-
description: "List annotations by subject",
554+
description: "List annotations by subject " + req.queryParams.subject,
555555
extra: results?._countTotal,
556556
});
557557
} catch (e) {
@@ -561,7 +561,7 @@ router
561561
httpVerb: "GET",
562562
routePath: basePath + "/list/by_subject",
563563
status: "Failure",
564-
description: "List annotations by subject",
564+
description: "List annotations by subject " + req.queryParams.subject,
565565
extra: results?._countTotal,
566566
error: e,
567567
});
@@ -586,7 +586,7 @@ router
586586
httpVerb: "GET",
587587
routePath: basePath + "/purge",
588588
status: "Started",
589-
description: "Purge old closed annotations",
589+
description: "Purge old closed annotations older than " + req.queryParams.age_sec,
590590
});
591591

592592
g_db._executeTransaction({
@@ -622,7 +622,7 @@ router
622622
httpVerb: "GET",
623623
routePath: basePath + "/purge",
624624
status: "Success",
625-
description: "Purge old closed annotations",
625+
description: "Purge old closed annotations older than " + req.queryParams.age_sec,
626626
extra: `Ids of purged notes: ${purgedIds.join(", ")}`,
627627
});
628628
} catch (e) {
@@ -632,7 +632,7 @@ router
632632
httpVerb: "GET",
633633
routePath: basePath + "/purge",
634634
status: "Failure",
635-
description: "Purge old closed annotations",
635+
description: "Purge old closed annotations older than " + req.queryParams.age_sec,
636636
extra: { last_purged_note: id },
637637
error: e,
638638
});

0 commit comments

Comments
 (0)