Merge pull request #11035 from nanaya/score-docs

Add documentation for new score json

Author: notbakaneko

app/Http/Controllers/Multiplayer/Rooms/Playlist/ScoresController.php

@@ -104,7 +104,7 @@ public function index($roomId, $playlistId)
      *
      * ### Response Format
      *
-     * Returns [MultiplayerScore](#multiplayerscore) object.
+     * Returns [Score](#score) object.
      *
      * @urlParam room integer required Id of the room.
      * @urlParam playlist integer required Id of the playlist item.
@@ -136,7 +136,7 @@ public function show($roomId, $playlistId, $id)
      *
      * ### Response Format
      *
-     * Returns [MultiplayerScore](#multiplayerscore) object.
+     * Returns [Score](#score) object.
      *
      * @urlParam room integer required Id of the room.
      * @urlParam playlist integer required Id of the playlist item.

resources/views/docs/_structures/multiplayer_score.md

@@ -2,10 +2,10 @@
 
 An object which contains scores and related data for fetching next page of the result.
 
-Field           | Type                                    | Description
---------------- | --------------------------------------- | -------------------------------------------------------------
-cursor_string   | [CursorString](#cursorstring)           | To be used to fetch the next page.
-params          | object                                  | Parameters used for score listing.
-scores          | [MultiplayerScore](#multiplayerscore)[] | |
-total           | integer?                                | Index only. Total scores of the specified playlist item.
-user_score      | [MultiplayerScore](#multiplayerscore)?  | Index only. Score of the accessing user if exists.
+Field         | Type                          | Description
+------------- | ----------------------------- | -----------
+cursor_string | [CursorString](#cursorstring) | To be used to fetch the next page.
+params        | object                        | Parameters used for score listing.
+scores        | [Score](#score)[]             | |
+total         | integer?                      | Index only. Total scores of the specified playlist item.
+user_score    | [Score](#score)?              | Index only. Score of the accessing user if exists.

resources/views/docs/_structures/multiplayer_scores.md

@@ -1,5 +1,39 @@
 ## Score
 
+The following is the format returned when API v2 version header is 20220705 or higher. Exceptions apply (f.ex. doesn't apply for legacy match score).
+
+Field              | Type                     | Description
+------------------ | ------------------------ | -----------
+accuracy           | float                    | |
+beatmap_id         | integer                  | |
+best_id            | integer?                 | |
+build_id           | integer?                 | |
+ended_at           | [Timestamp](#timestamp)  | |
+has_replay         | boolean                  | |
+id                 | integer                  | |
+is_perfect_combo   | boolean                  | |
+legacy_perfect     | boolean                  | |
+legacy_score_id    | integer?                 | |
+legacy_total_score | integer                  | |
+max_combo          | integer                  | |
+maximum_statistics | ScoreStatistics?         | |
+mods               | Mod[]                    | |
+passed             | boolean                  | |
+playlist_item_id   | integer                  | Only for multiplayer score
+pp                 | float?                   | |
+preserve           | boolean                  | Whether or not the score may eventually be deleted. Only for `solo_score` type
+rank               | string                   | |
+ranked             | boolean                  | Whether or not the score can have pp. Only for `solo_score` type
+room_id            | integer                  | Only for multiplayer score
+ruleset_id         | integer                  | |
+started_at         | [Timestamp](#timestamp)? | |
+statistics         | ScoreStatistics          | |
+total_score        | integer                  | |
+type               | string                   | |
+user_id            | integer                  | |
+
+### Initial version
+
 The following is the format returned when API v2 version header is 20220704 or lower.
 
 Field                 | Type    | Description
@@ -26,14 +60,17 @@ mode                  |         | |
 mode_int              |         | |
 replay                |         | |
 
-Optional attributes:
+### Optional attributes
 
-Field        | Type | Description
------------- | ---- | -----------
-beatmap      |      | |
-beatmapset   |      | |
-rank_country |      | |
-rank_global  |      | |
-weight       |      | |
-user         |      | |
-match        |      | |
+Field                   | Type                                                 | Description
+----------------------- | ---------------------------------------------------- | -----------
+beatmap                 |                                                      | |
+beatmapset              |                                                      | |
+current_user_attributes | integer?                                             | |
+match                   |                                                      | Only for legacy match score
+position                | integer?                                             | Only for multiplayer score
+rank_country            |                                                      | |
+rank_global             |                                                      | |
+scores_around           | [MultiplayerScoresAround](#multiplayerscoresaround)? | Scores around the specified score. Only for multiplayer score
+user                    |                                                      | |
+weight                  |                                                      | |