Document new admin endpoints.

This commit is contained in:
zkldi
2021-10-13 17:40:19 +01:00
parent 3e0438f89e
commit 9ed0b8e03f
+50 -1
View File
@@ -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.