fixed api docs around the "spoilers" parameter

jikan-me · Jul 11, 2024 · 6d6c47d · 6d6c47d
1 parent 9902e0b
commit 6d6c47d
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
diff --git a/app/Dto/Concerns/HasSpoilersParameter.php b/app/Dto/Concerns/HasSpoilersParameter.php
@@ -10,7 +10,7 @@
 
 /**
  *  @OA\Parameter(
- *      name="spoiler",
+ *      name="spoilers",
  *      in="query",
  *      required=false,
  *      description="Any reviews that are tagged as a spoiler. Spoiler reviews are not returned by default. e.g usage: `?spoiler=true`",

diff --git a/app/Http/Controllers/V4DB/AnimeController.php b/app/Http/Controllers/V4DB/AnimeController.php
@@ -22,7 +22,7 @@
 use App\Dto\AnimeUserUpdatesLookupCommand;
 use App\Dto\AnimeVideosEpisodesLookupCommand;
 use App\Dto\AnimeVideosLookupCommand;
-use Illuminate\Http\Request;
+use OpenApi\Annotations as OA;
 
 class AnimeController extends Controller
 {
@@ -669,7 +669,7 @@ public function userupdates(AnimeUserUpdatesLookupCommand $command)
      *
      *     @OA\Parameter(ref="#/components/parameters/page"),
      *     @OA\Parameter(ref="#/components/parameters/preliminary"),
-     *     @OA\Parameter(ref="#/components/parameters/spoiler"),
+     *     @OA\Parameter(ref="#/components/parameters/spoilers"),
      *
      *     @OA\Response(
      *         response="200",

diff --git a/app/Http/Controllers/V4DB/MangaController.php b/app/Http/Controllers/V4DB/MangaController.php
@@ -15,7 +15,7 @@
 use App\Dto\MangaReviewsLookupCommand;
 use App\Dto\MangaStatsLookupCommand;
 use App\Dto\MangaUserUpdatesLookupCommand;
-use Illuminate\Http\Request;
+use OpenApi\Annotations as OA;
 
 class MangaController extends Controller
 {
@@ -387,7 +387,7 @@ public function userupdates(MangaUserUpdatesLookupCommand $command)
      *
      *     @OA\Parameter(ref="#/components/parameters/page"),
      *     @OA\Parameter(ref="#/components/parameters/preliminary"),
-     *     @OA\Parameter(ref="#/components/parameters/spoiler"),
+     *     @OA\Parameter(ref="#/components/parameters/spoilers"),
      *
      *     @OA\Response(
      *         response="200",

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

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