diff --git a/README.md b/README.md index 6907dd4..8638408 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ - **База данных**: PostgreSQL. - **API**: - Генерация JWT для пользователей при успешной аутентификации. - - Проверка токенов при запросах от других микросервисов. - Регистрация пользователей. + - Проверка токенов при запросах от других микросервисов. + - Регистрация пользователей. - Аутентификация с использованием JWT. - Управление ролями пользователей. diff --git a/docs/API.md b/docs/API.md index bc20be6..75572d5 100644 --- a/docs/API.md +++ b/docs/API.md @@ -62,26 +62,27 @@ WIP\ Аргументы: -| Название | Тип | Описание | Доступные значения | -|--------------|-------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| `modpack_id` | `int` | ID модпака | | -| `fields` | `str` | (Опционально)
Поля, которые нужно вернуть.
Пример: `name,version` | - `name`
- `description`
- `version`
- `author`
- `mods`
- `mods_count`
- `created_at`
- `updated_at` | -| `token` | `str` | Токен авторизации | | -| `v` | `str` | Версия API | | +| Название | Тип | Описание | Доступные значения | +|--------------|-------|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `modpack_id` | `int` | ID модпака | | +| `fields` | `str` | (Опционально)
Поля, которые нужно вернуть.
Пример: `name,version` | - `name`
- `description`
- `version`
- `archive`
- `author`
- `mods`
- `mods_count`
- `created_at`
- `updated_at` | +| `token` | `str` | Токен авторизации | | +| `v` | `str` | Версия API | | Возвращает (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` | +| `archive` | `list` | Все версии модпака | [`test`, `new`, `Super Stabe v1.1`] | +| `author` | `str` | Автор модпака | `example` | +| `mods` | `dict` | Список модов в модпаке | `{"mode_name": {"sha256": "asdasd", "link": "https://....", "size": 1552}}` | +| `mods_count` | `int` | Количество модов в модпаке | `3` | +| `created_at` | `str` | Дата создания модпака | `2025-01-01T00:00:00` | +| `updated_at` | `str` | Дата последнего обновления | `2025-04-01T00:00:00` | Возможные ошибки: Общие ошибки, `100`