mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-06 22:07:58 +03:00
Go ahead, rewrite my urls underfoot. See if i care.
This commit is contained in:
zkldi
@@ -1,7 +1,7 @@
|
||||
# Admin Endpoints
|
||||
|
||||
These endpoints are for adminstrator use. As such, they all
|
||||
require an `authLevel` of atleast 3. For more information, see the [UserDocument](/tachi-server/documents/user).
|
||||
require an `authLevel` of atleast 3. For more information, see the [UserDocument](../../tachi-server/documents/user.md).
|
||||
|
||||
*****
|
||||
|
||||
|
||||
@@ -91,7 +91,7 @@ POST /api/v1/auth/login
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [UserDocument](/tachi-server/documents/user) | The newly-created user's User Document. |
|
||||
| `<body>` | [UserDocument](../../tachi-server/documents/user) | The newly-created user's User Document. |
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
+17
-17
@@ -66,7 +66,7 @@ GET /api/v1/games/iidx/SP
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `gameStats` | Array<GameStats> | The sorted statistics for the leaderboards. |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | All of the related users for the above statistics. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | All of the related users for the above statistics. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -108,8 +108,8 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `song` | [SongDocument](/tachi-server/documents/song) |The requested song document. |
|
||||
| `charts` | [ChartDocument](/tachi-server/documents/chart)[] | All of the charts that belong to this song for this playtype. |
|
||||
| `song` | [SongDocument](../../tachi-server/documents/song) |The requested song document. |
|
||||
| `charts` | [ChartDocument](../../tachi-server/documents/chart)[] | All of the charts that belong to this song for this playtype. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -164,8 +164,8 @@ GET /api/v1/games/iidx/SP/songs/1
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart) with `__playcount`> | The chart documents that matched this search, or the most popular 100 charts for this game. |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The associated song documents for the charts. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart) with `__playcount`> | The chart documents that matched this search, or the most popular 100 charts for this game. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The associated song documents for the charts. |
|
||||
|
||||
!!! info
|
||||
The `__playcount` property is patched onto the chart
|
||||
@@ -221,8 +221,8 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `song` | [SongDocument](/tachi-server/documents/song) | The parent song for this chart. |
|
||||
| `chart` | [ChartDocument](/tachi-server/documents/chart) | The requested chart document. |
|
||||
| `song` | [SongDocument](../../tachi-server/documents/song) | The parent song for this chart. |
|
||||
| `chart` | [ChartDocument](../../tachi-server/documents/chart) | The requested chart document. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -387,8 +387,8 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The related song documents for this folder. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The related chart documents for this folder. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The related song documents for this folder. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The related chart documents for this folder. |
|
||||
| `folder` | FolderDocument | The folder document at this ID. |
|
||||
|
||||
### Example
|
||||
@@ -523,9 +523,9 @@ GET /api/v1/games/bms/7K/tableID/insane
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `pbs` | Array<PBDocument> | The array of pbs part of the score leaderboard. |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The array of songs part of the PBs. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts part of the PBs. |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | The array of users part of the PBs. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The array of songs part of the PBs. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts part of the PBs. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | The array of users part of the PBs. |
|
||||
|
||||
*****
|
||||
|
||||
@@ -588,7 +588,7 @@ GET /api/v1/games/bms/7K/player-distribution?class=stslDan
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | Array of the users who achieved the courses. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | Array of the users who achieved the courses. |
|
||||
| `classes` | Array<ClassAchievementDocument> | Data about the recently achieved classes. |
|
||||
|
||||
*****
|
||||
@@ -607,7 +607,7 @@ GET /api/v1/games/bms/7K/player-distribution?class=stslDan
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `scores` | Array<[ScoreDocument](/tachi-server/documents/score)> | The highlighted scores. |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | The users who own the scores. |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The songs the scores are on. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The charts the scores are on. |
|
||||
| `scores` | Array<[ScoreDocument](../../tachi-server/documents/score)> | The highlighted scores. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | The users who own the scores. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The songs the scores are on. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The charts the scores are on. |
|
||||
|
||||
@@ -20,9 +20,9 @@
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `score` | [ScoreDocument](/tachi-server/documents/score) | The score document with this scoreID. |
|
||||
| `song` (Conditional) | [SongDocument](/tachi-server/documents/song) | If `getRelated` is set, then this is the song the score belongs to. |
|
||||
| `chart` (Conditional) | [ChartDocument](/tachi-server/documents/chart) | Same as above, but for the chart document. |
|
||||
| `score` | [ScoreDocument](../../tachi-server/documents/score) | The score document with this scoreID. |
|
||||
| `song` (Conditional) | [SongDocument](../../tachi-server/documents/song) | If `getRelated` is set, then this is the song the score belongs to. |
|
||||
| `chart` (Conditional) | [ChartDocument](../../tachi-server/documents/chart) | Same as above, but for the chart document. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -77,7 +77,7 @@ GET /api/v1/scores/Re7b00261b1d3ba8e5c9ee4e76e77ea9f07d9493b
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [ScoreDocument](/tachi-server/documents/score) | The new score document.
|
||||
| `<body>` | [ScoreDocument](../../tachi-server/documents/score) | The new score document.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | The array of users whose usernames look like the search criterion. |
|
||||
| `songs` | ([SongDocument](/tachi-server/documents/song) With [__textScore](../../tachi-server/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | The array of users whose usernames look like the search criterion. |
|
||||
| `songs` | ([SongDocument](../../tachi-server/documents/song) With [__textScore](../../tachi-server/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. |
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -14,11 +14,11 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `session` | [SessionDocument](/tachi-server/documents/session) | The session document at this ID. |
|
||||
| `scores` | Array<[ScoreDocument](/tachi-server/documents/score)> | The score documents involved in this session. |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The songs these score documents belong to. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The charts these score documents belong to. |
|
||||
| `user` | [UserDocument](/tachi-server/documents/user) | The user that made this session. |
|
||||
| `session` | [SessionDocument](../../tachi-server/documents/session) | The session document at this ID. |
|
||||
| `scores` | Array<[ScoreDocument](../../tachi-server/documents/score)> | The score documents involved in this session. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The songs these score documents belong to. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The charts these score documents belong to. |
|
||||
| `user` | [UserDocument](../../tachi-server/documents/user) | The user that made this session. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -89,7 +89,7 @@ GET /api/v1/sessions/Qe7b00261b1d3ba8e5c9ee4e76e77ea9f07d9493b
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [SessionDocument](/tachi-server/documents/session) | The new session document, after modifications. |
|
||||
| `<body>` | [SessionDocument](../../tachi-server/documents/session) | The new session document, after modifications. |
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -19,8 +19,8 @@ None.
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `gameStats` | UserGameStatsDocument | The User's GameStats for this game + playtype. |
|
||||
| `firstScore` | [ScoreDocument](/tachi-server/documents/score) or Null | The user's first score for this game + playtype. This is null if the user has no scores with timestamps. |
|
||||
| `mostRecentScore` | [ScoreDocument](/tachi-server/documents/score) or Null | The user's most recent score. This is null if the user has no scores with timestamps. |
|
||||
| `firstScore` | [ScoreDocument](../../tachi-server/documents/score) or Null | The user's first score for this game + playtype. This is null if the user has no scores with timestamps. |
|
||||
| `mostRecentScore` | [ScoreDocument](../../tachi-server/documents/score) or Null | The user's most recent score. This is null if the user has no scores with timestamps. |
|
||||
| `totalScores` | Integer | The total amount of scores this user has. |
|
||||
| `rankingData` | Record<Rating Algorithm, { ranking: integer, outOf: integer }> | The position of this player on the default leaderboards for this game, and how many players it is out of. |
|
||||
|
||||
@@ -180,8 +180,8 @@ GET /api/v1/users/zkldi/games/iidx/SP/milestones
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `pbs` | Array<PBDocument> | The array of personal bests this search returned. This is limited to 30 returns. |
|
||||
|
||||
### Example
|
||||
@@ -241,8 +241,8 @@ different rating algorithm to sort under.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `pbs` | Array<PBDocument> | The array of personal bests this search returned. |
|
||||
|
||||
### Example
|
||||
@@ -310,8 +310,8 @@ None.
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `pbs` | Array<PBDocument> | All of the users PB Documents |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | All of the relevant songs. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | All of the relevant charts. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | All of the relevant songs. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | All of the relevant charts. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -365,8 +365,8 @@ GET /api/v1/users/zkldi/games/iidx/SP/pbs/all
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `pb` | PBDocument | The user's PB for this chart. |
|
||||
| `chart` | [ChartDocument](/tachi-server/documents/chart) | The chart this PB is on. |
|
||||
| `scores` (Conditional) | Array<[ScoreDocument](/tachi-server/documents/score)> | If `getComposition` is present, then this field contains the array of score documents that composed this PB. |
|
||||
| `chart` | [ChartDocument](../../tachi-server/documents/chart) | The chart this PB is on. |
|
||||
| `scores` (Conditional) | Array<[ScoreDocument](../../tachi-server/documents/score)> | If `getComposition` is present, then this field contains the array of score documents that composed this PB. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -407,9 +407,9 @@ GET /api/v1/users/1/games/iidx/SP/pbs/some_chart_id
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song) with __textScore> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `scores` | Array<[ScoreDocument](/tachi-server/documents/score)> | The array of scores this search returned. This is limited to 30 returns. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song) with __textScore> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `scores` | Array<[ScoreDocument](../../tachi-server/documents/score)> | The array of scores this search returned. This is limited to 30 returns. |
|
||||
|
||||
!!! info
|
||||
All `songs` returned also have the `__textScore`
|
||||
@@ -467,9 +467,9 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `scores` | Array<[ScoreDocument](/tachi-server/documents/score)> | The array of scores this search returned. This is limited to 30 returns. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The array of songs this search returned. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts this search returned. |
|
||||
| `scores` | Array<[ScoreDocument](../../tachi-server/documents/score)> | The array of scores this search returned. This is limited to 30 returns. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -526,7 +526,7 @@ song titles of played songs inside sessions.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | Array<[SessionDocument](/tachi-server/documents/session)> | The array of sessions that matched this query. |
|
||||
| `<body>` | Array<[SessionDocument](../../tachi-server/documents/session)> | The array of sessions that matched this query. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -569,7 +569,7 @@ These are returned in descending order.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | Array<[SessionDocument](/tachi-server/documents/session)> | The array of the users best sessions. |
|
||||
| `<body>` | Array<[SessionDocument](../../tachi-server/documents/session)> | The array of the users best sessions. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -623,7 +623,7 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | Array<[SessionDocument](/tachi-server/documents/session)> | The array of the users sessions. |
|
||||
| `<body>` | Array<[SessionDocument](../../tachi-server/documents/session)> | The array of the users sessions. |
|
||||
|
||||
*****
|
||||
|
||||
@@ -643,7 +643,7 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [SessionDocument](/tachi-server/documents/session) | The user's most recent session. |
|
||||
| `<body>` | [SessionDocument](../../tachi-server/documents/session) | The user's most recent session. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -679,7 +679,7 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | Array<[SessionDocument](/tachi-server/documents/session)> | The array of the users highlighted sessions. |
|
||||
| `<body>` | Array<[SessionDocument](../../tachi-server/documents/session)> | The array of the users highlighted sessions. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -720,8 +720,8 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `songs` | Array<[SongDocument](/tachi-server/documents/song)> | The array of songs related to the pbs. |
|
||||
| `charts` | Array<[ChartDocument](/tachi-server/documents/chart)> | The array of charts related to the pbs. |
|
||||
| `songs` | Array<[SongDocument](../../tachi-server/documents/song)> | The array of songs related to the pbs. |
|
||||
| `charts` | Array<[ChartDocument](../../tachi-server/documents/chart)> | The array of charts related to the pbs. |
|
||||
| `pbs` | Array<(PBDocument & {__playcount: integer})> | An array of PB documents with the `__playcount` property attached. This property dictates how many times the user has played this chart. |
|
||||
|
||||
### Example
|
||||
@@ -790,7 +790,7 @@ GET /api/v1/users/zkldi/games/iidx/SP/most-played
|
||||
| :: | :: | :: |
|
||||
| `above` | Array<UserGameStats> | Up to 5 users' game stats better than this user. |
|
||||
| `below` | Array<UserGameStats> | Same as above, but below the user. |
|
||||
| `users` | Array<[UserDocument](/tachi-server/documents/user)> | The user documents related to the above statistics. |
|
||||
| `users` | Array<[UserDocument](../../tachi-server/documents/user)> | The user documents related to the above statistics. |
|
||||
| `thisUsersStats` | UserGameStats | The requested user's stats for this GPT. |
|
||||
| `thisUsersRanking` | {outOf: integer, ranking: integer} | The requested user's ranking for this GPT. |
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ These endpoints are related to users in general.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | Array<[UserDocument](/tachi-server/documents/user)> | The array of up to 100 users returned. |
|
||||
| `<body>` | Array<[UserDocument](../../tachi-server/documents/user)> | The array of up to 100 users returned. |
|
||||
|
||||
!!! note
|
||||
Users are guaranteeably returned in order of when they were `lastSeen`.
|
||||
@@ -66,7 +66,7 @@ None.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [UserDocument](/tachi-server/documents/user) | The user this ID/username corresponds to. |
|
||||
| `<body>` | [UserDocument](../../tachi-server/documents/user) | The user this ID/username corresponds to. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -119,7 +119,7 @@ GET /api/v1/users/me IF authenticated as userID 1.
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `<body>` | [UserDocument](/tachi-server/documents/user) | The user document with all of those changes applied. |
|
||||
| `<body>` | [UserDocument](../../tachi-server/documents/user) | The user document with all of those changes applied. |
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user