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

move open api docs params to respective DTO files

Browse Source
This commit is contained in:
Irfan 2023-04-27 13:38:00 +05:00 committed by pushrbx
parent 55229901ab
commit ec5f091687
7 changed files with 59 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app/Dto/Concerns/HasKidsParameter.php
View File

@ -3,10 +3,20 @@
namespace App\Dto\Concerns;
use App\Casts\ContextualBooleanCast;
use OpenApi\Annotations as OA;
use Spatie\LaravelData\Attributes\Validation\BooleanType;
use Spatie\LaravelData\Attributes\WithCast;
use Spatie\LaravelData\Optional;
/**
* @OA\Parameter(
* name="kids",
* in="query",
* required=false,
* description="This is a flag. When supplied it will include entries with the Kids genres in specific endpoints that filter them out by default. You do not need to pass a value to it. e.g usage: `?kids`",
* @OA\Schema(type="boolean")
* ),
*/
trait HasKidsParameter
{
use PreparesData;

9
app/Dto/Concerns/HasLimitParameter.php
View File

@ -3,10 +3,19 @@
namespace App\Dto\Concerns;
use App\Rules\Attributes\MaxLimitWithFallback;
use OpenApi\Annotations as OA;
use Spatie\LaravelData\Attributes\Validation\IntegerType;
use Spatie\LaravelData\Attributes\Validation\Min;
use Spatie\LaravelData\Optional;
/**
* @OA\Parameter(
* name="limit",
* in="query",
* @OA\Schema(type="integer")
* ),
*/
trait HasLimitParameter
{
use PreparesData;

8
app/Dto/Concerns/HasPageParameter.php
View File

@ -2,10 +2,18 @@
namespace App\Dto\Concerns;
use OpenApi\Annotations as OA;
use Spatie\LaravelData\Attributes\Validation\Min;
use Spatie\LaravelData\Attributes\Validation\Numeric;
use Spatie\LaravelData\Optional;
/**
* @OA\Parameter(
* name="page",
* in="query",
* @OA\Schema(type="integer")
* ),
*/
trait HasPageParameter
{
#[Numeric, Min(1)]

10
app/Dto/Concerns/HasSfwParameter.php
View File

@ -3,10 +3,20 @@
namespace App\Dto\Concerns;
use App\Casts\ContextualBooleanCast;
use OpenApi\Annotations as OA;
use Spatie\LaravelData\Attributes\Validation\BooleanType;
use Spatie\LaravelData\Attributes\WithCast;
use Spatie\LaravelData\Optional;
/**
* @OA\Parameter(
* name="sfw",
* in="query",
* required=false,
* description="'Safe For Work'. This is a flag. When supplied it will filter out entries according to the SFW Policy. You do not need to pass a value to it. e.g usage: `?sfw`",
* @OA\Schema(type="boolean")
* ),
*/
trait HasSfwParameter
{
use PreparesData;

10
app/Dto/Concerns/HasUnapprovedParameter.php
View File

@ -3,10 +3,20 @@
namespace App\Dto\Concerns;
use App\Casts\ContextualBooleanCast;
use OpenApi\Annotations as OA;
use Spatie\LaravelData\Attributes\Validation\BooleanType;
use Spatie\LaravelData\Attributes\WithCast;
use Spatie\LaravelData\Optional;
/**
* @OA\Parameter(
* name="unapproved",
* in="query",
* required=false,
* description="This is a flag. When supplied it will include entries which are unapproved. Unapproved entries on MyAnimeList are those that are user submitted and have not yet been approved by MAL to show up on other pages. They will have their own specifc pages and are often removed resulting in a 404 error. You do not need to pass a value to it. e.g usage: `?unapproved`",
* @OA\Schema(type="boolean")
* ),
*/
trait HasUnapprovedParameter
{
use PreparesData;

41
app/Http/Controllers/V4DB/Controller.php
View File

@ -48,47 +48,6 @@ class Controller extends BaseController
* )
*/
/**
* Common parameters
*
* @OA\Parameter(
* name="page",
* in="query",
* @OA\Schema(type="integer")
* ),
*
* @OA\Parameter(
* name="limit",
* in="query",
* @OA\Schema(type="integer")
* ),
*
* @OA\Parameter(
* name="sfw",
* in="query",
* required=false,
* description="'Safe For Work'. This is a flag. When supplied it will filter out entries according to the SFW Policy. You do not need to pass a value to it. e.g usage: `?sfw`",
* @OA\Schema(type="boolean")
* ),
*
* @OA\Parameter(
* name="kids",
* in="query",
* required=false,
* description="This is a flag. When supplied it will include entries with the Kids genres in specific endpoints that filter them out by default. You do not need to pass a value to it. e.g usage: `?kids`",
* @OA\Schema(type="boolean")
* ),
*
* @OA\Parameter(
* name="unapproved",
* in="query",
* required=false,
* description="This is a flag. When supplied it will include entries which are unapproved. Unapproved entries on MyAnimeList are those that are user submitted and have not yet been approved by MAL to show up on other pages. They will have their own specifc pages and are often removed resulting in a 404 error. You do not need to pass a value to it. e.g usage: `?unapproved`",
* @OA\Schema(type="boolean")
* ),
*/
/**
* @var Request
*/

24
storage/api-docs/api-docs.json
View File

@ -8999,11 +8999,13 @@
}
},
"parameters": {
"page": {
"name": "page",
"kids": {
"name": "kids",
"in": "query",
"description": "This is a flag. When supplied it will include entries with the Kids genres in specific endpoints that filter them out by default. You do not need to pass a value to it. e.g usage: `?kids`",
"required": false,
"schema": {
"type": "integer"
"type": "boolean"
}
},
"limit": {
@ -9013,6 +9015,13 @@
"type": "integer"
}
},
"page": {
"name": "page",
"in": "query",
"schema": {
"type": "integer"
}
},
"sfw": {
"name": "sfw",
"in": "query",
@ -9022,15 +9031,6 @@
"type": "boolean"
}
},
"kids": {
"name": "kids",
"in": "query",
"description": "This is a flag. When supplied it will include entries with the Kids genres in specific endpoints that filter them out by default. You do not need to pass a value to it. e.g usage: `?kids`",
"required": false,
"schema": {
"type": "boolean"
}
},
"unapproved": {
"name": "unapproved",
"in": "query",