Add comment to pages/api/comments.js

This comment described rationale to why we created this api endpoint
iterative · Dec 4, 2019 · 6b9d01a · 6b9d01a
1 parent 64b0749
commit 6b9d01a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/pages/api/comments.js b/pages/api/comments.js
@@ -1,3 +1,14 @@
+/*
+ * This API endpoint is used by https://blog.dvc.org
+ * to get comments count for the post, it gets
+ * discuss.dvc.org topic url as a param and returns
+ * comments count or error.
+ *
+ * It made this way to configure CORS, reduce user's payload
+ * and to add potential ability to cache comments count
+ * in the future.
+ */
+
 import Cors from 'micro-cors'
 import request from 'request'