From 41935029c8a8d0541e6d68428a267ef1b6bf9a9e Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Thu, 16 Dec 2021 18:51:06 +0000 Subject: [PATCH] Remove unused tierlist endpoint. --- docs/docs/api/routes/gpt.md | 67 ------------------------------------- 1 file changed, 67 deletions(-) diff --git a/docs/docs/api/routes/gpt.md b/docs/docs/api/routes/gpt.md index eb2b1ccf3..e6b5018d8 100644 --- a/docs/docs/api/routes/gpt.md +++ b/docs/docs/api/routes/gpt.md @@ -251,73 +251,6 @@ GET /api/v1/games/iidx/SP/charts/some_chart_id ***** -## Return tierlist information for this chart - -`GET /api/v1/games/:game/:playtype/charts/:chartID/tierlist` - -Retrieve the tierlist information for this chart. If no tierlistID is provided, this falls back -to the GPT's default. - -!!! warning - If the GPT has no default tierlist, then the server will return a 501. - -### Parameters - -| Property | Type | Description | -| :: | :: | :: | -| `tierlistID` | string, Optional | Optionally, provide a tierlist ID to use instead of the default. | - -### Response - -| Property | Type | Description | -| :: | :: | :: | -| `tierlist` | TierlistDocument | The related tierlist document. | -| `tierlistData` | Array<TierlistDataDocument> | All of the tierlist data for this chart. | - -### Example - -#### Request -``` -GET /api/v1/games/iidx/SP/charts/chart_id/tierlist -``` - -#### Response - -```js -{ - tierlist: { - game: "iidx", - playtype: "SP", - name: "Default IIDX SP Tierlist", - // ... - }, - tierlistData: [{ - type: "lamp", - key: "HARD CLEAR", - chartID: "chart_id", - data: { - value: 12.5, - humanised: "C", - flags: {} - }, - // ... - }, { - type: "lamp", - key: "CLEAR", - chartID: "chart_id", - data: { - value: 12.4, - humanised: "C", - flags: { - idvDifference: true - } - }, - // ... - }] -} -``` - -***** ## Retrieve playcount for this chart. `GET /api/v1/games/:game/:playtype/charts/:chartID/playcount`