From 6d6c47d16e0f2271d9d503737f432424de22c8ed Mon Sep 17 00:00:00 2001
From: pushrbx <contact@pushrbx.net>
Date: Thu, 11 Jul 2024 21:19:47 +0100
Subject: [PATCH] fixed api docs around the "spoilers" parameter

---
 app/Dto/Concerns/HasSpoilersParameter.php       |  2 +-
 app/Http/Controllers/V4DB/AnimeController.php   |  4 ++--
 app/Http/Controllers/V4DB/MangaController.php   |  4 ++--
 app/Http/Controllers/V4DB/ReviewsController.php |  8 +++++---
 storage/api-docs/api-docs.json                  | 12 ++++++------
 5 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/app/Dto/Concerns/HasSpoilersParameter.php b/app/Dto/Concerns/HasSpoilersParameter.php
index b704e46..7ba499c 100644
--- a/app/Dto/Concerns/HasSpoilersParameter.php
+++ b/app/Dto/Concerns/HasSpoilersParameter.php
@@ -10,7 +10,7 @@ use Spatie\LaravelData\Optional;
 
 /**
  *  @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
index b6c26af..161b2b6 100644
--- a/app/Http/Controllers/V4DB/AnimeController.php
+++ b/app/Http/Controllers/V4DB/AnimeController.php
@@ -22,7 +22,7 @@ use App\Dto\AnimeThemesLookupCommand;
 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 @@ class AnimeController extends Controller
      *
      *     @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
index e1794eb..f863a2e 100644
--- a/app/Http/Controllers/V4DB/MangaController.php
+++ b/app/Http/Controllers/V4DB/MangaController.php
@@ -15,7 +15,7 @@ use App\Dto\MangaRelationsLookupCommand;
 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 @@ class MangaController extends Controller
      *
      *     @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
index dcf8ac2..8dca6a9 100644
--- a/app/Http/Controllers/V4DB/ReviewsController.php
+++ b/app/Http/Controllers/V4DB/ReviewsController.php
@@ -4,18 +4,20 @@ namespace App\Http\Controllers\V4DB;
 
 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 @@ class ReviewsController extends Controller
      *
      *     @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
index fb324e9..4779da6 100644
--- 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,