mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-03 04:18:16 +03:00
Refactor how contribution info is displayed.
This commit is contained in:
@@ -34,7 +34,7 @@ permissions over API Tokens, such as being able to change your password.
|
||||
|
||||
## Getting Tokens
|
||||
|
||||
[Our OAuth2 Flow](../codebase/infrastructure/oauth2.md) should be used to acquire API Tokens.
|
||||
[Our OAuth2 Flow](../tachi-server/infrastructure/oauth2.md) should be used to acquire API Tokens.
|
||||
|
||||
## Permissions
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ None.
|
||||
| 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. |
|
||||
| `configs` | Record<Game, [GameConfig](../../tachi-server/implementation-details/game-configuration.md)> | Contains a mapping of every supported game to its configuration. |
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ None.
|
||||
|
||||
!!! warning
|
||||
A GamePTConfig is different to a GameConfig! Read more
|
||||
[here](../../codebase/implementation-details/game-configuration.md).
|
||||
[here](../../tachi-server/implementation-details/game-configuration.md).
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ appropriate way to send files.
|
||||
|
||||
| HTTP Header | Description |
|
||||
| :: | :: |
|
||||
| `X-User-Intent` (optional) | If this header is present, the request is assumed to have been sent with 'User Intent'. For more on this, see [Import Types](../../codebase/import/import-types.md) |
|
||||
| `X-User-Intent` (optional) | If this header is present, the request is assumed to have been sent with 'User Intent'. For more on this, see [Import Types](../../tachi-server/import/import-types.md) |
|
||||
|
||||
!!! info
|
||||
It's the responsibility of the API user to use the X-User-Intent
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
These endpoints relate to managing your OAuth2 clients, such as creating new ones or deleting them.
|
||||
|
||||
For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../codebase/infrastructure/oauth2.md)
|
||||
For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../tachi-server/infrastructure/oauth2.md)
|
||||
|
||||
*****
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Tachi provides an OAuth2 API and some other things
|
||||
so that you can create your own clients and retrieve
|
||||
user api keys safely.
|
||||
|
||||
For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../codebase/infrastructure/oauth2.md)
|
||||
For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../tachi-server/infrastructure/oauth2.md)
|
||||
|
||||
*****
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `users` | UserDocument[] | The array of users whose usernames look like the search criterion. |
|
||||
| `songs` | (SongDocument With [__textScore](../../codebase/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. |
|
||||
| `songs` | (SongDocument With [__textScore](../../tachi-server/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -49,4 +49,4 @@ GET /api/v1/search?search=freedom
|
||||
```
|
||||
|
||||
!!! info
|
||||
For more details on how searching works, see [Search Implementation](../../codebase/implementation-details/search.md).
|
||||
For more details on how searching works, see [Search Implementation](../../tachi-server/implementation-details/search.md).
|
||||
|
||||
@@ -224,7 +224,7 @@ GET /api/v1/users/zkldi/games/iidx/SP/pbs?search=Verfl
|
||||
`GET /api/v1/users/:userID/games/:game/:playtype/pbs/best`
|
||||
|
||||
This returns the users' best 100 personal bests according
|
||||
to the [Default Rating Algorithm](../../codebase/implementation-details/game-configuration) for this game.
|
||||
to the [Default Rating Algorithm](../../tachi-server/implementation-details/game-configuration) for this game.
|
||||
|
||||
This is returned in descending sorted order.
|
||||
|
||||
@@ -363,7 +363,7 @@ GET /api/v1/users/1/games/iidx/SP/pbs/some_chart_id
|
||||
property. This property describes how close the query
|
||||
was to the actual text, and is mostly internal.
|
||||
|
||||
You can read more into the details of this at [Search Implementation](../../codebase/implementation-details/search.md)
|
||||
You can read more into the details of this at [Search Implementation](../../tachi-server/implementation-details/search.md)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user