mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-13 01:38:29 +03:00
Document new admin endpoints.
This commit is contained in:
@@ -38,4 +38,53 @@ POST /api/v1/admin/change-log-level
|
||||
|
||||
#### Response
|
||||
|
||||
Empty Object.
|
||||
Empty Object.
|
||||
|
||||
*****
|
||||
|
||||
## Remove the isPrimary status from a chart
|
||||
|
||||
This also uncalcs all score data for scores on the chart.
|
||||
|
||||
`POST /api/v1/admin/deprimarify`
|
||||
|
||||
### Permissions
|
||||
|
||||
- Admin
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `chartID` | String | The chartID to deprimarify. |
|
||||
| `game` | Game | The game this chart is on. |
|
||||
| `songID` | Integer | Alternatively to chartID, you can specify this to deprimarify all charts on this songID. |
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `charts` | Array<ChartDocument> | The array of charts that were deprimarified |
|
||||
|
||||
*****
|
||||
|
||||
## Delete any Score
|
||||
|
||||
This performs all the necessary checks to remove a score document aswell
|
||||
|
||||
`POST /api/v1/admin/delete-score`
|
||||
|
||||
### Permissions
|
||||
|
||||
- Admin
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `scoreID` | String | The scoreID to delete. |
|
||||
|
||||
### Response
|
||||
|
||||
Empty Object.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user