diff --git a/docs/API.md b/docs/API.md index 71437c0..bc20be6 100644 --- a/docs/API.md +++ b/docs/API.md @@ -9,8 +9,33 @@ ## Auth -WIP\ -В будущем будет добавлена авторизация. +### `auth.login` + +Аутентификация пользователя. + +Аргументы: + +| Название | Тип | Описание | Доступные значения | +|------------|-------|---------------------|--------------------| +| `login` | `str` | Логин пользователя | | +| `password` | `str` | Пароль пользователя | | +| `v` | `str` | Версия API | | + +Возвращает (JSON): + +| Название | Тип | Описание | Пример | +|----------|-------|---------------|------------------------------| +| `token` | `str` | Токен доступа | `eyJCFJ9.eyJdfM30.C9adDS-h2` | + +Возможные ошибки: Общие ошибки + +### `auth.register` + +.... + +### `auth.refreshToken` + +.... ## Users @@ -47,16 +72,16 @@ WIP\ Возвращает (JSON): -| Название | Тип | Описание | Пример | -|---------------|--------|-----------------------------------|------------------------------| -| `name` | `str` | Название модпака | `Example Modpack` | -| `description` | `str` | Описание модпака | `This is an example modpack` | -| `version` | `str` | Версия модпака (может быть любым) | `Super Stabe v1.1` | -| `author` | `str` | Автор модпака | `example` | -| `mods` | `list` | Список модов в модпаке | `["mod1", "mod2", "mod3"]` | -| `mods_count` | `int` | Количество модов в модпаке | `3` | -| `created_at` | `str` | Дата создания модпака | `2025-01-01T00:00:00` | -| `updated_at` | `str` | Дата последнего обновления | `2025-04-01T00:00:00` | +| Название | Тип | Описание | Пример | +|---------------|--------|----------------------------|------------------------------| +| `name` | `str` | Название модпака | `Example Modpack` | +| `description` | `str` | Описание модпака | `This is an example modpack` | +| `version` | `str` | Версия модпака | `Super Stabe v1.1` | +| `author` | `str` | Автор модпака | `example` | +| `mods` | `list` | Список модов в модпаке | `["mod1", "mod2", "mod3"]` | +| `mods_count` | `int` | Количество модов в модпаке | `3` | +| `created_at` | `str` | Дата создания модпака | `2025-01-01T00:00:00` | +| `updated_at` | `str` | Дата последнего обновления | `2025-04-01T00:00:00` | Возможные ошибки: Общие ошибки, `100` diff --git a/docs/API_ERRORS.md b/docs/API_ERRORS.md index 9f51f46..f1dce36 100644 --- a/docs/API_ERRORS.md +++ b/docs/API_ERRORS.md @@ -28,10 +28,11 @@ ### Ошибки аутентификации -| Код | Описание | -|-----|------------------| -| 10 | Invalid token | -| 11 | Token expired | +| Код | Описание | +|-----|--------------------------------| +| 10 | Invalid token | +| 11 | Token expired | +| 12 | Login or password is incorrect | ### Ошибки доступа