Max/zkldi_Tachi
1
0
Fork 0
mirror of https://github.com/zkldi/Tachi.git synced 2026-10-12 09:18:25 +03:00
Code Issues Packages Projects Releases Wiki Activity

remove params

Browse Source
This commit is contained in:
zkldi
2021-06-28 17:05:35 +01:00
parent 6f7eaa4068
commit d161f7a8d8
5 changed files with 148 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/api/routes/games.md
+78
View File
@@ -0,0 +1,78 @@
# Game Endpoints
These endpoints cover all games and specific games. For
specific playtypes, see [Game:Playtype Endpoints](./gpt.md).
*****
## Retrieve all supported games.
`GET /api/v1/games`
### Parameters
None.
### Response
| Property | Type | Description |
| :: | :: | :: |
| `supportedGames` | String[] | The list of games this service supports. |
| `configs` | Record<Game, [GameConfig](../../codebase/implementation-details/game-configuration.md)> | Contains a mapping of every supported game to its configuration. |
### Example
#### Request
```
GET /api/v1/games
```
#### Response
```json
{
"supportedGames": ["iidx", "bms"],
"configs": {
"iidx": {
"name": "beatmania IIDX",
// ...
},
"bms": {
"name": "BMS",
// ...
}
}
}
```
*****
## Retrieve a specific games' configuration.
`GET /api/v1/games/:game`
### Parameters
### Response
| Property | Type | Description |
| :: | :: | :: |
| `<body>` | GameConfig | The configuration for this game. |
### Example
#### Request
```
GET /api/v1/games/iidx
```
#### Response
```json
{
"defaultPlaytype": "SP",
"name": "beatmania IIDX",
"internalName": "iidx",
"validPlaytypes": ["SP", "DP"],
}
```
docs/docs/api/routes/gpt.md
+31
View File
@@ -0,0 +1,31 @@
# Game:Playtype Endpoints
These endpoints are for games + their playtypes.
To find out what games are supported by a service
programmatically, you should see [Game Endpoints](./games.md).
*****
## Retrieve Game:Playtype Configuration.
`GET /api/v1/games/:game/:playtype`
### Parameters
### Response
| Property | Type | Description |
| :: | :: | :: |
### Example
#### Request
```
```
#### Response
docs/docs/api/routes/user-gamept.md
+34 -34
View File
@@ -12,9 +12,9 @@ This endpoints are for specific users information on specific game + playtype co
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
### Response
@@ -68,9 +68,9 @@ GET /api/v1/users/zkldi/games/iidx/SP
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `unachieved` (Optional) | Presence | If present, only unachieved goals are returned. |
### Response
@@ -122,9 +122,9 @@ GET /api/v1/users/zkldi/games/iidx/SP/goals
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `unachieved` (Optional) | Presence | If present, only unachieved milestones are returned. |
### Response
@@ -172,9 +172,9 @@ GET /api/v1/users/zkldi/games/iidx/SP/milestones
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `search` | String | Limits the returned scores to those where the corresponding song is most similar to this query. |
### Response
@@ -236,9 +236,9 @@ different rating algorithm to sort under.
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `alg` | String | An overriding rating algorithm to use instead of the default. |
### Response
@@ -309,10 +309,10 @@ GET /api/v1/users/zkldi/games/iidx/SP/pbs/best?alg=BPI
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `:chartID` | URL Parameter | The chart to retrieve this user's PB for. |
| `getComposition` | Presence | If present, the individual ScoreDocuments that composed this PB will also be returned. |
### Response
@@ -356,9 +356,9 @@ GET /api/v1/users/1/games/iidx/SP/pbs/some_chart_id
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `search` | String | Limits the returned scores to those where the corresponding song is most similar to this query. |
### Response
@@ -421,9 +421,9 @@ GET /api/v1/users/zkldi/games/iidx/SP/scores?search=Verfl
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
### Response
@@ -482,9 +482,9 @@ song titles of played songs inside sessions.
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `search` | string | The session name to search for. |
### Response
@@ -528,9 +528,9 @@ These are returned in descending order.
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
| `alg` (Optional) | string | The name of the algorithm to use instead of the default. |
### Response
@@ -587,9 +587,9 @@ These are returned in descending order according to `timeEnded`.
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The ID or username of the user to retrieve information from. |
| `:game` | URL Parameter | The game to retrieve information from. Must be a supported game. |
| `:playtype` | URL Parameter | The playtype to retrieve information for. Must be a supported playtype of the previous game. |
### Response
docs/docs/api/routes/users.md
+2 -2
View File
@@ -49,7 +49,7 @@ GET /api/v1/users
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The user's userID or their username. |
!!! note
The :userID param has some special functionality,
@@ -105,7 +105,7 @@ GET /api/v1/users/me WHEN authenticated as userID 1.
| Property | Type | Description |
| :: | :: | :: |
| `:userID` | URL Parameter | The user ID or username to fetch the data of. |
### Response