malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

[DOC] Clubs Search Params

Browse Source
This commit is contained in:
Poly 2020-07-25 22:36:46 +02:00
parent d97301ea20
commit 39ab25004c
2 changed files with 58 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
app/Http/Controllers/V4DB/SearchController.php
View File

@ -658,6 +658,42 @@ class SearchController extends Controller
* @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Parameter(
* name="q",
* in="query",
* @OA\Schema(type="string")
* ),
*
* @OA\Parameter(
* name="type",
* in="query",
* @OA\Schema(ref="#/components/schemas/club search query type")
* ),
*
* @OA\Parameter(
* name="category",
* in="query",
* @OA\Schema(ref="#/components/schemas/club search query category")
* ),
*
* @OA\Parameter(
* name="order_by",
* in="query",
* @OA\Schema(ref="#/components/schemas/club search query orderby")
* ),
*
* @OA\Parameter(
* name="sort",
* in="query",
* @OA\Schema(ref="#/components/schemas/search query sort")
* ),
*
* @OA\Parameter(
* name="letter",
* in="query",
* @OA\Schema(type="string")
* ),
*
* @OA\Response(
* response="200",
* description="Returns search results for clubs",

25
app/Http/QueryBuilder/SearchQueryBuilderClub.php
View File

@ -20,7 +20,12 @@ class SearchQueryBuilderClub implements SearchQueryBuilderInterface
const MAX_RESULTS_PER_PAGE = 25;
/**
*
* @OA\Schema(
* schema="club search query type",
* description="Club Search Query Type",
* type="string",
* enum={"public","private","secret"}
* )
*/
const MAP_TYPES = [
'public' => 'public',
@ -29,7 +34,16 @@ class SearchQueryBuilderClub implements SearchQueryBuilderInterface
];
/**
*
* @OA\Schema(
* schema="club search query category",
* description="Club Search Query Category",
* type="string",
* enum={
* "anime","manga","actors_and_artists","characters",
* "cities_and_neighborhoods","companies","conventions","games",
* "japan","music","other","schools"
* }
* )
*/
const MAP_CATEGORY = [
'anime' => 'Anime',
@ -47,7 +61,12 @@ class SearchQueryBuilderClub implements SearchQueryBuilderInterface
];
/**
*
* @OA\Schema(
* schema="club search query orderby",
* description="Club Search Query OrderBy",
* type="string",
* enum={"mal_id","title","members_count","pictures_count","created"}
* )
*/
const ORDER_BY = [
'mal_id', 'title', 'members_count', 'pictures_count', 'created'