move id_asc and id_desc to own sort type

ppy · Sep 11, 2024 · 7f62c0b · 7f62c0b
1 parent 44dc277
commit 7f62c0b
Show file tree

Hide file tree

Showing 13 changed files with 30 additions and 46 deletions.
diff --git a/app/Docs/Attributes/SortCustom.php → app/Docs/Attributes/Sort.php b/app/Docs/Attributes/SortCustom.php → app/Docs/Attributes/Sort.php
@@ -11,7 +11,7 @@
 use Knuckles\Scribe\Attributes\GenericParam;
 
 #[Attribute(Attribute::IS_REPEATABLE | Attribute::TARGET_FUNCTION | Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
-class SortCustom extends GenericParam
+class Sort extends GenericParam
 {
     public function __construct(
         array|string $sorts,

diff --git a/app/Docs/Attributes/SortId.php b/app/Docs/Attributes/SortId.php
diff --git a/app/Docs/Strategies/GetFromQueryParamAttribute.php b/app/Docs/Strategies/GetFromQueryParamAttribute.php
@@ -10,8 +10,7 @@
 use App\Docs\Attributes\Limit;
 use App\Docs\Attributes\Offset;
 use App\Docs\Attributes\Page;
-use App\Docs\Attributes\SortCustom;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use Http\Message\Authentication\QueryParam;
 use Knuckles\Scribe\Extracting\Strategies\GetParamsFromAttributeStrategy;
 
@@ -22,7 +21,6 @@ class GetFromQueryParamAttribute extends GetParamsFromAttributeStrategy
         Offset::class,
         Page::class,
         QueryParam::class,
-        SortCustom::class,
-        SortId::class,
+        Sort::class,
     ];
 }
diff --git a/app/Http/Controllers/BeatmapDiscussionPostsController.php b/app/Http/Controllers/BeatmapDiscussionPostsController.php
@@ -7,7 +7,7 @@
 
 use App\Docs\Attributes\Limit;
 use App\Docs\Attributes\Page;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\ModelNotSavedException;
 use App\Libraries\BeatmapsetDiscussion\Discussion;
 use App\Libraries\BeatmapsetDiscussion\Reply;
@@ -73,7 +73,7 @@ public function destroy($id)
      * @queryParam user integer The `id` of the [User](#user).
      * @queryParam with_deleted boolean This param has no effect as api calls do not currently receive group permissions.
      */
-    #[Limit, Page, SortId]
+    #[Limit, Page, Sort('IdSort')]
     public function index()
     {
         $bundle = new BeatmapsetDiscussionPostsBundle(request()->all());

diff --git a/app/Http/Controllers/BeatmapDiscussionsController.php b/app/Http/Controllers/BeatmapDiscussionsController.php
@@ -7,7 +7,7 @@
 
 use App\Docs\Attributes\Limit;
 use App\Docs\Attributes\Page;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\ModelNotSavedException;
 use App\Libraries\BeatmapsetDiscussion\Review;
 use App\Libraries\BeatmapsetDiscussionsBundle;
@@ -102,7 +102,7 @@ public function destroy($id)
      * @queryParam user integer The `id` of the [User](#user).
      * @queryParam with_deleted boolean This param has no effect as api calls do not currently receive group permissions. No-example
      */
-    #[Limit, Page, SortId]
+    #[Limit, Page, Sort('IdSort')]
     public function index()
     {
         $bundle = new BeatmapsetDiscussionsBundle(request()->all());

diff --git a/app/Http/Controllers/BeatmapsetDiscussionVotesController.php b/app/Http/Controllers/BeatmapsetDiscussionVotesController.php
@@ -7,7 +7,7 @@
 
 use App\Docs\Attributes\Limit;
 use App\Docs\Attributes\Page;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Libraries\BeatmapsetDiscussionVotesBundle;
 
 /**
@@ -49,7 +49,7 @@ public function __construct()
      * @queryParam user integer The `id` of the [User](#user) giving the votes.
      * @queryParam with_deleted boolean This param has no effect as api calls do not currently receive group permissions. No-example
      */
-    #[Limit, Page, SortId]
+    #[Limit, Page, Sort('IdSort')]
     public function index()
     {
         $bundle = new BeatmapsetDiscussionVotesBundle(request()->all());

diff --git a/app/Http/Controllers/CommentsController.php b/app/Http/Controllers/CommentsController.php
@@ -5,7 +5,7 @@
 
 namespace App\Http\Controllers;
 
-use App\Docs\Attributes\SortCustom;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\ModelNotSavedException;
 use App\Jobs\Notifications\CommentNew;
 use App\Libraries\CommentBundle;
@@ -77,7 +77,7 @@ public function destroy($id)
      * @queryParam cursor Pagination option. See [CommentSort](#commentsort) for detail. The format follows [Cursor](#cursor) except it's not currently included in the response. No-example
      * @queryParam parent_id integer Limit to comments which are reply to the specified id. Specify 0 to get top level comments. Example: 1
      */
-    #[SortCustom('CommentSort', 'Defaults to `new` for guests and user-specified default when authenticated.', 'new')]
+    #[Sort('CommentSort', 'Defaults to `new` for guests and user-specified default when authenticated.', 'new')]
     public function index()
     {
         $params = request()->all();

diff --git a/app/Http/Controllers/EventsController.php b/app/Http/Controllers/EventsController.php
@@ -7,7 +7,7 @@
 
 namespace App\Http\Controllers;
 
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Models\Event;
 
 /**
@@ -52,7 +52,7 @@ public function __construct()
      *   cursor_string: "eyJldmVudF9pZCI6OH0"
      * }
      */
-    #[SortId]
+    #[Sort('IdSort')]
     public function index()
     {
         $params = request()->all();

diff --git a/app/Http/Controllers/Forum/TopicsController.php b/app/Http/Controllers/Forum/TopicsController.php
@@ -6,7 +6,7 @@
 namespace App\Http\Controllers\Forum;
 
 use App\Docs\Attributes\Limit;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\ModelNotSavedException;
 use App\Jobs\Notifications\ForumTopicReply;
 use App\Libraries\NewForumTopic;
@@ -314,7 +314,7 @@ public function reply($id)
      *   "sort": "id_asc"
      * }
      */
-    #[Limit(20, 1, 50, 'Maximum number of posts to be returned'), SortId]
+    #[Limit(20, 1, 50, 'Maximum number of posts to be returned'), Sort('IdSort')]
     public function show($id)
     {
         $topic = Topic::with(['forum'])->withTrashed()->findOrFail($id);

diff --git a/app/Http/Controllers/MatchesController.php b/app/Http/Controllers/MatchesController.php
@@ -6,7 +6,7 @@
 namespace App\Http\Controllers;
 
 use App\Docs\Attributes\Limit;
-use App\Docs\Attributes\SortId;
+use App\Docs\Attributes\Sort;
 use App\Models\LegacyMatch\LegacyMatch;
 use App\Models\User;
 use App\Transformers\LegacyMatch\EventTransformer;
@@ -60,7 +60,7 @@ public function __construct()
      *     "cursor_string": "eyJtYXRjaF9pZCI6MTE0NDI4Njg1fQ"
      * }
      */
-    #[Limit(50, 1, 50), SortId]
+    #[Limit(50, 1, 50), Sort('IdSort')]
     public function index()
     {
         $params = request()->all();

diff --git a/app/Http/Controllers/Multiplayer/Rooms/Playlist/ScoresController.php b/app/Http/Controllers/Multiplayer/Rooms/Playlist/ScoresController.php
@@ -6,7 +6,7 @@
 namespace App\Http\Controllers\Multiplayer\Rooms\Playlist;
 
 use App\Docs\Attributes\Limit;
-use App\Docs\Attributes\SortCustom;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\InvariantException;
 use App\Http\Controllers\Controller as BaseController;
 use App\Libraries\ClientCheck;
@@ -47,7 +47,7 @@ public function __construct()
      * @usesCursor
      */
     #[Limit(50, 1, 50)]
-    #[SortCustom('MultiplayerScoresSort')]
+    #[Sort('MultiplayerScoresSort')]
     public function index($roomId, $playlistId)
     {
         $playlist = PlaylistItem::where('room_id', $roomId)->findOrFail($playlistId);

diff --git a/app/Http/Controllers/Multiplayer/RoomsController.php b/app/Http/Controllers/Multiplayer/RoomsController.php
@@ -6,7 +6,7 @@
 namespace App\Http\Controllers\Multiplayer;
 
 use App\Docs\Attributes\Limit;
-use App\Docs\Attributes\SortCustom;
+use App\Docs\Attributes\Sort;
 use App\Exceptions\InvariantException;
 use App\Http\Controllers\Controller as BaseController;
 use App\Models\Model;
@@ -32,7 +32,7 @@ public function __construct()
      * @queryParam season_id Season ID to return Rooms from. No-example
      * @queryParam type_group `playlists` (default) or `realtime`. No-example
      */
-    #[Limit(250, 1, 250), SortCustom(['ended', 'created'])]
+    #[Limit(250, 1, 250), Sort(['ended', 'created'])]
     public function index()
     {
         $apiVersion = api_version();

diff --git a/resources/views/docs/_structures/id_sort.md b/resources/views/docs/_structures/id_sort.md
@@ -0,0 +1,9 @@
+## IdSort
+
+Available sort types are `id_asc`, `id_desc`.
+
+Name    | Description
+------- | ----------------------------
+id_asc  | Sort by oldest first.
+id_desc | Sort by newest first.
+