Added examples, updated docs for image gallery api endpoints

[bookstack] / app / Http / Controllers / Api / ApiController.php

diff --git a/app/Http/Controllers/Api/ApiController.php b/app/Http/Controllers/Api/ApiController.php
index 0a3d8945356cb9414fc592fb3c4f7668c272e4b7..5c448e49f4fbb66594eded24216c4eaa859b12b1 100644 (file)
--- a/app/Http/Controllers/Api/ApiController.php
+++ b/app/Http/Controllers/Api/ApiController.php
@@ -1,4 +1,6 @@
-<?php namespace BookStack\Http\Controllers\Api;
+<?php
+
+namespace BookStack\Http\Controllers\Api;
 
 use BookStack\Api\ListingResponseBuilder;
 use BookStack\Http\Controllers\Controller;
@@ -7,24 +9,38 @@ use Illuminate\Http\JsonResponse;
 
 abstract class ApiController extends Controller
 {
-
     protected $rules = [];
 
     /**
      * Provide a paginated listing JSON response in a standard format
      * taking into account any pagination parameters passed by the user.
      */
-    protected function apiListingResponse(Builder $query, array $fields): JsonResponse
+    protected function apiListingResponse(Builder $query, array $fields, array $modifiers = []): JsonResponse
     {
         $listing = new ListingResponseBuilder($query, request(), $fields);
+
+        foreach ($modifiers as $modifier) {
+            $listing->modifyResults($modifier);
+        }
+
         return $listing->toResponse();
     }
 
     /**
      * Get the validation rules for this controller.
+     * Defaults to a $rules property but can be a rules() method.
+     */
+    public function getValidationRules(): array
+    {
+        return $this->rules();
+    }
+
+    /**
+     * Get the validation rules for the actions in this controller.
+     * Defaults to a $rules property but can be a rules() method.
      */
-    public function getValdationRules(): array
+    protected function rules(): array
     {
         return $this->rules;
     }
-}
\ No newline at end of file
+}