[DOC] Search Pagination Params

page,limit
This commit is contained in:
Poly 2020-07-25 22:09:20 +02:00
parent 3496ade48d
commit 1a420a0519

View File

@ -45,12 +45,28 @@ class SearchController extends Controller
private $request;
const MAX_RESULTS_PER_PAGE = 25;
/**
* @OA\Parameter(
* name="page",
* in="query",
* @OA\Schema(type="number")
* ),
* @OA\Parameter(
* name="limit",
* in="query",
* @OA\Schema(type="number")
* ),
*/
/**
* @OA\Get(
* path="/anime",
* operationId="getAnimeSearch",
* tags={"anime"},
*
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Parameter(
* name="q",
* in="query",
@ -172,6 +188,9 @@ class SearchController extends Controller
* operationId="getMangaSearch",
* tags={"manga"},
*
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Parameter(
* name="q",
* in="query",
@ -287,6 +306,9 @@ class SearchController extends Controller
* operationId="getPeopleSearch",
* tags={"people"},
*
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
* response="200",
* description="Returns search results for people",
@ -339,6 +361,9 @@ class SearchController extends Controller
* operationId="getCharactersSearch",
* tags={"characters"},
*
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
* response="200",
* description="Returns search results for characters",
@ -599,6 +624,9 @@ class SearchController extends Controller
* operationId="getClubsSearch",
* tags={"clubs"},
*
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
* response="200",
* description="Returns search results for clubs",