]> BookStack Code Mirror - bookstack/blobdiff - app/Entities/Tools/SearchRunner.php
Added API search endpoint
[bookstack] / app / Entities / Tools / SearchRunner.php
index f6da871f49be5af2b7c664b938413c70ca302459..04f4c57681a88e29b38bed639362a68127b8381e 100644 (file)
@@ -56,6 +56,8 @@ class SearchRunner
      * Search all entities in the system.
      * The provided count is for each entity to search,
      * Total returned could be larger and not guaranteed.
+     *
+     * @return array{total: int, count: int, has_more: bool, results: Entity[]}
      */
     public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20, string $action = 'view'): array
     {