From bc8a862be8b404ebbb515eca2d8e351b7805b592 Mon Sep 17 00:00:00 2001 From: SantaSpeen Date: Thu, 27 Mar 2025 16:34:43 +0300 Subject: [PATCH] [+] api errors --- docs/API.md | 28 ++++++++++++++---- docs/API_ERRORS.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+), 6 deletions(-) create mode 100644 docs/API_ERRORS.md diff --git a/docs/API.md b/docs/API.md index 36e7029..1d1299f 100644 --- a/docs/API.md +++ b/docs/API.md @@ -37,11 +37,12 @@ WIP\ Аргументы: -| Название | Тип | Описание | Доступные значения | -|--------------|-------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| `modpack_id` | `int` | ID модпака | | -| `fields` | `str` | (Опционально)
Поля, которые нужно вернуть. | - `name`
- `description`
- `version`
- `author`
- `mods`
- `mods_count`
- `created_at`
- `updated_at` | -| `v` | `str` | Версия API | | +| Название | Тип | Описание | Доступные значения | +|--------------|-------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| `modpack_id` | `int` | ID модпака | | +| `fields` | `str` | (Опционально)
Поля, которые нужно вернуть.
Пример: `name,version` | - `name`
- `description`
- `version`
- `author`
- `mods`
- `mods_count`
- `created_at`
- `updated_at` | +| `token` | `str` | Токен авторизации | | +| `v` | `str` | Версия API | | Возвращает (JSON): @@ -57,9 +58,24 @@ WIP\ | `created_at` | `str` | Дата создания модпака | `2025-01-01T00:00:00` | | `updated_at` | `str` | Дата последнего обновления | `2025-04-01T00:00:00` | +Возможные ошибки: Общие ошибка, `100` + ### `modpacks.delete` Удаление модпака. -.... +Аргументы: +| Название | Тип | Описание | Доступные значения | +|--------------|-------|-------------------|--------------------| +| `modpack_id` | `int` | ID модпака | | +| `token` | `str` | Токен авторизации | | +| `v` | `str` | Версия API | | + +Возвращает (JSON): + +| Название | Тип | Описание | Пример | +|----------|--------|-----------------|--------| +| `status` | `bool` | Статус операции | `true` | + +Возможные ошибки: Общие ошибки, `100` diff --git a/docs/API_ERRORS.md b/docs/API_ERRORS.md new file mode 100644 index 0000000..9b6d955 --- /dev/null +++ b/docs/API_ERRORS.md @@ -0,0 +1,72 @@ +# Ошибки API + +## Введение + +В данном документе описаны ошибки, которые могут возникнуть при работе с API. \ +Ошибки делятся на две категории: общие ошибки и ошибки конкретных методов. \ +Общие ошибки могут возникнуть при работе с любым методом, а ошибки конкретных методов - только при работе с соответствующими методами. \ +Каждая ошибка имеет свой код и описание. \ +Код ошибки - это уникальный идентификатор ошибки, который можно использовать для обработки ошибок в программе. \ +Описание ошибки - это текстовое описание ошибки, которое можно показать пользователю. + +Пример ошибки: + +```json +{ + "error": { + "code": 1, + "message": "Invalid token" + } +} +``` + +## Общие ошибки + +| Код | Описание | +|-----|---------------------| +| 1 | Invalid API version | + +### Ошибки аутентификации + +| Код | Описание | +|-----|------------------| +| 10 | Invalid token | +| 11 | Token expired | + +### Ошибки доступа + +| Код | Описание | +|-----|---------------| +| 20 | Access denied | +| 21 | Token expired | + +### Ошибки аргументов + +| Код | Описание | +|-----|---------------------------| +| 30 | Missing required argument | +| 31 | Invalid argument value | +| 32 | Invalid argument type | +| 33 | Invalid argument format | + +### Ошибки методов + +| Код | Описание | +|-----|--------------------| +| 40 | Method Not Found | +| 41 | Method Not Allowed | + + +### Ошибки сервера + +| Код | Описание | +|-----|---------------------------| +| 50 | Internal server error | + +## Ошибки методов + +| Код | Описание | Методы | +|-----|------------------------|------------------------------------------| +| 100 | Modpack not found | - `modpacks.update`
- `modpacks.get` | +| 101 | Modpack already exists | - `modpacks.create` | +