Skip to content

Commit e0c0d29

Browse files
authored
Merge pull request #26 from Banalian/patch-1
Update the error example for the live get map info endpoint
2 parents b2fd1be + 9fcc211 commit e0c0d29

File tree

3 files changed

+9
-21
lines changed

3 files changed

+9
-21
lines changed

docs/live/maps/add-favorite.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,6 @@ POST https://live-services.trackmania.nadeo.live/api/token/map/favorite/EgUgXeBV
3333

3434
**Example response**:
3535

36-
A successful response has no content and a `204` response code.
36+
Both successful and unsuccessful responses have no content and return a `204` response code.
3737

38-
Example response if the requested map does not exist:
39-
40-
```json
41-
["map:error-notFound"]
42-
```
38+
An invalid `mapUid` results in a `500` response code with an error object in the response body.

docs/live/maps/info.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ GET https://live-services.trackmania.nadeo.live/api/token/map/QleO8OiNAkIXrZs6r0
6363
Example response if the requested map does not exist:
6464

6565
```json
66-
["map:error-notFound"]
66+
{
67+
"error": "NotFoundHttpException",
68+
"message": "",
69+
"traceId": "Root=1-68b47f2d-6c4f97f5124aa8ab32d2914e"
70+
}
6771
```
68-
69-
Note: Be careful to check the response type; a valid track will return an object, but an invalid track will return an array with a string in it.

docs/live/maps/remove-favorite.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,6 @@ POST https://live-services.trackmania.nadeo.live/api/token/map/favorite/EgUgXeBV
3232

3333
**Example response**:
3434

35-
A successful response has no content and a `204` response code.
35+
Both successful and unsuccessful responses (including requests for maps that are not part of your favorites) have no content and return a `204` response code.
3636

37-
Example response if the requested map does not exist:
38-
39-
```json
40-
["map:error-notFound"]
41-
```
42-
43-
Example response if the requested map is not among your favorites:
44-
45-
```json
46-
["mapFavorite:error-notFound"]
47-
```
37+
An invalid `mapUid` results in a `500` response code with an error object in the response body.

0 commit comments

Comments
 (0)