VimeWorld/api-docs

Некорректная документация в /user/session/:ids

boohba opened this issue · 6 comments

Вот обьект сессии который возвращаеться в документации

{ "user": { "id": 134568, "username": "xtrafrancyz", "level": 5, "levelPercentage": 0.894, "rank": "ADMIN", "playedSeconds": 3106732, "guild": null }, "online": { "value": true, "message": "Находится в Лобби", "game": "LOBBY" } }

А вот обьект который возвращаеться на деле

{ "id": 134568, "username": "xtrafrancyz", "level": 41, "levelPercentage": 0.34064, "rank": "ADMIN", "playedSeconds": 8444618, "lastSeen": 1595673501, "guild": null, "online": { "value": false, "message": "\u0418\u0433\u0440\u043e\u043a \u043e\u0444\u0444\u043b\u0430\u0439\u043d" } }

В итоге online и user склеиваются, и получается прикол. Это скорее баг апи, а не ошибка в документации, было бы найс его пофиксить

Здравствуйте, а что конкретно не так? Формат ответа не изменился, разве что новое поле у юзера появилось с датой последнего захода. сб, 25 июл. 2020 г., 13:55 Nordia notifications@github.com:

А почему оно там появилось? Почему тогда в /user/:id/session это отдельный обьект? Судя по документации тут он тоже должен быть отдельно, что логично. Я пишу враппер, и мне это крайне неудобно.

Во всех методах, которые возвращают юзера, одни и те же поля, в документации просто не все методы обновляются. Есть 2 варианта юзера - полный, как в /user/:id или сокращенный как в guilds/get сб, 25 июл. 2020 г., 20:07 Nordia notifications@github.com:

Причем тут юзер? /user/session/:ids должен возвращать массив объектов сессии, таких же как и в /user/:id/session, которые содержат два поля: юзер и онлайн, но он почему-то возвращает массив какого-то третьего варианта юзера с полем online.

Да, действительно, в документации была ошибка. Исправил в 51eebb4.

Стоило бы исправить то, что объект юзера склеен с онлайном, но это уже вопросы совместимости и при обновлении формата ответа сломается множество сайтов и приложений.

Стоило бы исправить то, что объект юзера склеен с онлайном, но это уже вопросы совместимости и при обновлении формата ответа сломается множество сайтов и приложений.

Надеюсь исправишь это в некст версии апи. И было бы неплохо задокументировать структуры обьектов, ибо про то, что некоторые филды nullable приходится узнавать практическим путем.