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

Merge pull request #546 from jikan-me/hotfix/api-docs

Browse Source 
🐛 Fixed api docs around the "spoilers" parameter
This commit is contained in:
pushrbx 2024-07-26 15:15:03 +02:00 committed by GitHub
commit 9b9757c11f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/Dto/Concerns/HasSpoilersParameter.php
View File

@ -10,7 +10,7 @@ use Spatie\LaravelData\Optional;
/** /**
* @OA\Parameter( * @OA\Parameter(
* name="spoiler", * name="spoilers",
* in="query", * in="query",
* required=false, * required=false,
* description="Any reviews that are tagged as a spoiler. Spoiler reviews are not returned by default. e.g usage: `?spoiler=true`", * description="Any reviews that are tagged as a spoiler. Spoiler reviews are not returned by default. e.g usage: `?spoiler=true`",

4
app/Http/Controllers/V4DB/AnimeController.php
View File

@ -22,7 +22,7 @@ use App\Dto\AnimeThemesLookupCommand;
use App\Dto\AnimeUserUpdatesLookupCommand; use App\Dto\AnimeUserUpdatesLookupCommand;
use App\Dto\AnimeVideosEpisodesLookupCommand; use App\Dto\AnimeVideosEpisodesLookupCommand;
use App\Dto\AnimeVideosLookupCommand; use App\Dto\AnimeVideosLookupCommand;
use Illuminate\Http\Request; use OpenApi\Annotations as OA;
class AnimeController extends Controller class AnimeController extends Controller
{ {
@ -669,7 +669,7 @@ class AnimeController extends Controller
* *
* @OA\Parameter(ref="#/components/parameters/page"), * @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/preliminary"), * @OA\Parameter(ref="#/components/parameters/preliminary"),
* @OA\Parameter(ref="#/components/parameters/spoiler"), * @OA\Parameter(ref="#/components/parameters/spoilers"),
* *
* @OA\Response( * @OA\Response(
* response="200", * response="200",

4
app/Http/Controllers/V4DB/MangaController.php
View File

@ -15,7 +15,7 @@ use App\Dto\MangaRelationsLookupCommand;
use App\Dto\MangaReviewsLookupCommand; use App\Dto\MangaReviewsLookupCommand;
use App\Dto\MangaStatsLookupCommand; use App\Dto\MangaStatsLookupCommand;
use App\Dto\MangaUserUpdatesLookupCommand; use App\Dto\MangaUserUpdatesLookupCommand;
use Illuminate\Http\Request; use OpenApi\Annotations as OA;
class MangaController extends Controller class MangaController extends Controller
{ {
@ -387,7 +387,7 @@ class MangaController extends Controller
* *
* @OA\Parameter(ref="#/components/parameters/page"), * @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/preliminary"), * @OA\Parameter(ref="#/components/parameters/preliminary"),
* @OA\Parameter(ref="#/components/parameters/spoiler"), * @OA\Parameter(ref="#/components/parameters/spoilers"),
* *
* @OA\Response( * @OA\Response(
* response="200", * response="200",

8
app/Http/Controllers/V4DB/ReviewsController.php
View File

@ -4,18 +4,20 @@ namespace App\Http\Controllers\V4DB;
use App\Dto\QueryAnimeReviewsCommand; use App\Dto\QueryAnimeReviewsCommand;
use App\Dto\QueryMangaReviewsCommand; use App\Dto\QueryMangaReviewsCommand;
use OpenApi\Annotations as OA;
class ReviewsController extends Controller class ReviewsController extends Controller
{ {
/** /**
* @OA\Get( * @OA\
* Get(
* path="/reviews/anime", * path="/reviews/anime",
* operationId="getRecentAnimeReviews", * operationId="getRecentAnimeReviews",
* tags={"reviews"}, * tags={"reviews"},
* *
* @OA\Parameter(ref="#/components/parameters/page"), * @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/preliminary"), * @OA\Parameter(ref="#/components/parameters/preliminary"),
* @OA\Parameter(ref="#/components/parameters/spoiler"), * @OA\Parameter(ref="#/components/parameters/spoilers"),
* *
* *
* @OA\Response( * @OA\Response(
@ -70,7 +72,7 @@ class ReviewsController extends Controller
* *
* @OA\Parameter(ref="#/components/parameters/page"), * @OA\Parameter(ref="#/components/parameters/page"),
* @OA\Parameter(ref="#/components/parameters/preliminary"), * @OA\Parameter(ref="#/components/parameters/preliminary"),
* @OA\Parameter(ref="#/components/parameters/spoiler"), * @OA\Parameter(ref="#/components/parameters/spoilers"),
* *
* @OA\Response( * @OA\Response(
* response="200", * response="200",

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

@ -587,7 +587,7 @@
"$ref": "#/components/parameters/preliminary" "$ref": "#/components/parameters/preliminary"
}, },
{ {
"$ref": "#/components/parameters/spoiler" "$ref": "#/components/parameters/spoilers"
} }
], ],
"responses": { "responses": {
@ -1605,7 +1605,7 @@
"$ref": "#/components/parameters/preliminary" "$ref": "#/components/parameters/preliminary"
}, },
{ {
"$ref": "#/components/parameters/spoiler" "$ref": "#/components/parameters/spoilers"
} }
], ],
"responses": { "responses": {
@ -2226,7 +2226,7 @@
"$ref": "#/components/parameters/preliminary" "$ref": "#/components/parameters/preliminary"
}, },
{ {
"$ref": "#/components/parameters/spoiler" "$ref": "#/components/parameters/spoilers"
} }
], ],
"responses": { "responses": {
@ -2258,7 +2258,7 @@
"$ref": "#/components/parameters/preliminary" "$ref": "#/components/parameters/preliminary"
}, },
{ {
"$ref": "#/components/parameters/spoiler" "$ref": "#/components/parameters/spoilers"
} }
], ],
"responses": { "responses": {
@ -9086,8 +9086,8 @@
"type": "boolean" "type": "boolean"
} }
}, },
"spoiler": { "spoilers": {
"name": "spoiler", "name": "spoilers",
"in": "query", "in": "query",
"description": "Any reviews that are tagged as a spoiler. Spoiler reviews are not returned by default. e.g usage: `?spoiler=true`", "description": "Any reviews that are tagged as a spoiler. Spoiler reviews are not returned by default. e.g usage: `?spoiler=true`",
"required": false, "required": false,