add example to phpdoc of getCountOverTime

steamysips · Oct 8, 2024 · 50fe124 · 50fe124
1 parent 67ad1b1
commit 50fe124
Showing 1 changed file with 25 additions and 1 deletion.
diff --git a/src/controllers/api/Reviews.php b/src/controllers/api/Reviews.php
@@ -206,7 +206,31 @@ public function deleteReview(): void
     }
 
     /**
-     * Gets the number of reviews for each month
+     * Gets the number of reviews for each month.
+     *
+     * <pre>
+     *     [
+     *         {
+     *             "date": "2024-04-01",
+     *             "totalReviews": 1,
+     *             "positiveReviews": "0",
+     *             "negativeReviews": "1"
+     *         },
+     *         {
+     *             "date": "2024-05-01",
+     *             "totalReviews": 9,
+     *             "positiveReviews": "4",
+     *             "negativeReviews": "5"
+     *         },
+     *         {
+     *             "date": "2024-06-01",
+     *             "totalReviews": 1,
+     *             "positiveReviews": "1",
+     *             "negativeReviews": "0"
+     *         }
+     *     ]
+     * </pre>
+     *
      * @return void
      */
     public function getCountOverTime(): void