X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/85db812feaae5f36ea6214931cec4adb67a9cb39..refs/pull/3503/head:/app/Http/Controllers/Api/BookshelfApiController.php diff --git a/app/Http/Controllers/Api/BookshelfApiController.php b/app/Http/Controllers/Api/BookshelfApiController.php index 4ce93defa..2720d1db2 100644 --- a/app/Http/Controllers/Api/BookshelfApiController.php +++ b/app/Http/Controllers/Api/BookshelfApiController.php @@ -1,7 +1,9 @@ - [ - 'name' => 'required|string|max:255', - 'description' => 'string|max:1000', - 'books' => 'array', + 'name' => ['required', 'string', 'max:255'], + 'description' => ['string', 'max:1000'], + 'books' => ['array'], + 'tags' => ['array'], ], 'update' => [ - 'name' => 'string|min:1|max:255', - 'description' => 'string|max:1000', - 'books' => 'array', + 'name' => ['string', 'min:1', 'max:255'], + 'description' => ['string', 'max:1000'], + 'books' => ['array'], + 'tags' => ['array'], ], ]; @@ -42,8 +42,9 @@ class BookshelfApiController extends ApiController public function list() { $shelves = Bookshelf::visible(); + return $this->apiListingResponse($shelves, [ - 'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by', 'image_id', + 'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by', ]); } @@ -51,6 +52,7 @@ class BookshelfApiController extends ApiController * Create a new shelf in the system. * An array of books IDs can be provided in the request. These * will be added to the shelf in the same order as provided. + * * @throws ValidationException */ public function create(Request $request) @@ -72,9 +74,10 @@ class BookshelfApiController extends ApiController $shelf = Bookshelf::visible()->with([ 'tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy', 'books' => function (BelongsToMany $query) { - $query->visible()->get(['id', 'name', 'slug']); - } + $query->scopes('visible')->get(['id', 'name', 'slug']); + }, ])->findOrFail($id); + return response()->json($shelf); } @@ -83,6 +86,7 @@ class BookshelfApiController extends ApiController * An array of books IDs can be provided in the request. These * will be added to the shelf in the same order as provided and overwrite * any existing book assignments. + * * @throws ValidationException */ public function update(Request $request, string $id) @@ -94,14 +98,14 @@ class BookshelfApiController extends ApiController $bookIds = $request->get('books', null); $shelf = $this->bookshelfRepo->update($shelf, $requestData, $bookIds); + return response()->json($shelf); } - - /** * Delete a single shelf. * This will typically send the shelf to the recycle bin. + * * @throws Exception */ public function delete(string $id) @@ -110,6 +114,7 @@ class BookshelfApiController extends ApiController $this->checkOwnablePermission('bookshelf-delete', $shelf); $this->bookshelfRepo->destroy($shelf); + return response('', 204); } }