Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Syriiin committed Apr 25, 2024
1 parent b73991a commit ef38497
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ difficalcy is an osu! difficulty and performance calculator REST API.
1. Query the API

```sh
curl "localhost:5000/api/calculator/info"
curl "localhost:5000/api/info"
```

```json
Expand All @@ -25,7 +25,7 @@ difficalcy is an osu! difficulty and performance calculator REST API.
```

```sh
curl "localhost:5000/api/calculator/calculation?BeatmapId=658127"
curl "localhost:5000/api/calculation?BeatmapId=658127"
```

```json
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Thus, each calculator has it's own API Reference:

In general, each calculator exposes:

| Endpoint | Description |
| ---------------------------------------- | ----------------------------------------------------- |
| `GET /api/calculator/info` | Returns details of the running calculation engine |
| `GET /api/calculator/difficulty` | Calculates difficulty of a beatmap |
| `GET /api/calculator/performance` | Calculates performance of a score |
| `GET /api/calculator/calculation` | Calculates both difficulty and performance of a score |
| `POST /api/calculator/batch/difficulty` | Calculates a batch of difficulties |
| `POST /api/calculator/batch/performance` | Calculates a batch of performances |
| `POST /api/calculator/batch/calculation` | Calculates a batch of difficulties and performances |
| Endpoint | Description |
| ----------------------------- | ----------------------------------------------------- |
| `GET /api/info` | Returns details of the running calculation engine |
| `GET /api/difficulty` | Calculates difficulty of a beatmap |
| `GET /api/performance` | Calculates performance of a score |
| `GET /api/calculation` | Calculates both difficulty and performance of a score |
| `POST /api/batch/difficulty` | Calculates a batch of difficulties |
| `POST /api/batch/performance` | Calculates a batch of performances |
| `POST /api/batch/calculation` | Calculates a batch of difficulties and performances |

0 comments on commit ef38497

Please sign in to comment.