-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use neoteroi-mkdocs to generate API Reference
- Loading branch information
Showing
11 changed files
with
2,070 additions
and
726 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,175 +1 @@ | ||
| # difficalcy-catch | ||
|
|
||
| ## `GET /api/calculator/info` | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "rulesetName": "string", | ||
| "calculatorName": "string", | ||
| "calculatorPackage": "string", | ||
| "calculatorVersion": "string", | ||
| "calculatorUrl": "string" | ||
| } | ||
| ``` | ||
|
|
||
| ## `GET /api/calculator/difficulty` | ||
|
|
||
| ### Query Parameters | ||
|
|
||
| | Name | Description | Required | Type | | ||
| | ------------ | ----------- | -------- | ------- | | ||
| | Accuracy | | No | double | | ||
| | Combo | | No | integer | | ||
| | Misses | | No | integer | | ||
| | TinyDroplets | | No | integer | | ||
| | Droplets | | No | integer | | ||
| | BeatmapId | | Yes | string | | ||
| | Mods | | No | integer | | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "total": 0 | ||
| } | ||
| ``` | ||
|
|
||
| ## `GET /api/calculator/performance` | ||
|
|
||
| ### Query Parameters | ||
|
|
||
| | Name | Description | Required | Type | | ||
| | ------------ | ----------- | -------- | ------- | | ||
| | Accuracy | | No | double | | ||
| | Combo | | No | integer | | ||
| | Misses | | No | integer | | ||
| | TinyDroplets | | No | integer | | ||
| | Droplets | | No | integer | | ||
| | BeatmapId | | Yes | string | | ||
| | Mods | | No | integer | | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "total": 0 | ||
| } | ||
| ``` | ||
|
|
||
| ## `GET /api/calculator/calculation` | ||
|
|
||
| ### Query Parameters | ||
|
|
||
| | Name | Description | Required | Type | | ||
| | ------------ | ----------- | -------- | ------- | | ||
| | Accuracy | | No | double | | ||
| | Combo | | No | integer | | ||
| | Misses | | No | integer | | ||
| | TinyDroplets | | No | integer | | ||
| | Droplets | | No | integer | | ||
| | BeatmapId | | Yes | string | | ||
| | Mods | | No | integer | | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "difficulty": { | ||
| "total": 0 | ||
| }, | ||
| "performance": { | ||
| "total": 0 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## `POST /api/calculator/batch/difficulty` | ||
|
|
||
| ### Body Parameters | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "beatmapId": "string", | ||
| "mods": 0, | ||
| "accuracy": 0, | ||
| "combo": 0, | ||
| "misses": 0, | ||
| "tinyDroplets": 0, | ||
| "droplets": 0 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "total": 0 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ## `POST /api/calculator/batch/performance` | ||
|
|
||
| ### Body Parameters | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "beatmapId": "string", | ||
| "mods": 0, | ||
| "accuracy": 0, | ||
| "combo": 0, | ||
| "misses": 0, | ||
| "tinyDroplets": 0, | ||
| "droplets": 0 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "total": 0 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ## `POST /api/calculator/batch/calculation` | ||
|
|
||
| ### Body Parameters | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "beatmapId": "string", | ||
| "mods": 0, | ||
| "accuracy": 0, | ||
| "combo": 0, | ||
| "misses": 0, | ||
| "tinyDroplets": 0, | ||
| "droplets": 0 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "difficulty": { | ||
| "total": 0 | ||
| }, | ||
| "performance": { | ||
| "total": 0 | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
| [OAD(./docs/api-reference/difficalcy-catch.json)] |
Oops, something went wrong.