- Added support for Scribe API docs

Author: dash8x

src/Http/Controllers/Api/TimeSeriesStatsApiController.php

@@ -9,13 +9,17 @@
 use Javaabu\Stats\Support\ExactDateRange;
 use Javaabu\Stats\TimeSeriesStats;
 
+/**
+ * @group Stats
+ *
+ * Endpoints for generating statistics.
+ */
 class TimeSeriesStatsApiController extends Controller
 {
     /**
-     * Display a listing of the resource.
+     * Time series stats
      *
-     * @param TimeSeriesStatsRequest $request
-     * @return JsonResponse|Response
+     * Generate time series stats for given the metric in the given date range and comparison date range. Supports outputs in multiple formats.
      */
     public function index(TimeSeriesStatsRequest $request)
     {

src/Http/Requests/TimeSeriesStatsRequest.php

@@ -27,7 +27,7 @@ public function authorize()
      */
     public function rules()
     {
-        $user = $this->user();
+        $user = request()->user();
         $filters = $this->input('filters', []);
 
         $rules = [
@@ -96,4 +96,58 @@ public function rules()
 
         return $rules;
     }
+
+    public function bodyParameters()
+    {
+        return [
+            'mode' => [
+                'description' => 'Which date frequency to group the data by, like `hour`, `day`, etc.',
+                'example' => TimeSeriesModes::MONTH->value,
+            ],
+
+            'metric' => [
+                'description' => 'Which metric to use for the stat.',
+                'example' => TimeSeriesStats::allowedMetrics([], request()->user())[0] ?? '',
+            ],
+
+            'date_range' => [
+                'description' => 'Preset date range to filter results by.',
+                'example' => PresetDateRanges::THIS_YEAR->value,
+            ],
+
+            'date_from' => [
+                'description' => 'Custom starting date when not using a preset date range.',
+            ],
+
+            'date_to' => [
+                'description' => 'Custom ending date when not using a preset date range.',
+            ],
+
+            'compare' => [
+                'description' => 'Whether to compare the stat with the comparison date range.',
+                'example' => true,
+            ],
+
+            'compare_date_range' => [
+                'description' => 'Preset date range to compare results with. If not set, the previous date range will be compared.',
+                'example' => 'No-example'
+            ],
+
+            'compare_date_from' => [
+                'description' => 'Custom starting compare date when not using a preset compare date range.',
+            ],
+
+            'compare_date_to' => [
+                'description' => 'Custom ending compare date when not using a preset compare date range.',
+            ],
+
+            'format' => [
+                'description' => 'Which format to return the results in.',
+            ],
+
+            'filters' => [
+                'description' => 'Filters to apply to the stat.',
+            ],
+        ];
+    }
 }