MiniModLauncher/server
2
0
Fork 0
mirror of https://github.com/MiniModLauncher/server.git synced 2025-07-01 15:35:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

[+] api errors

Browse Source
This commit is contained in:
Maxim Khomutov 2025-03-27 16:34:43 +03:00
parent f41083a5e6
commit bc8a862be8
2 changed files with 94 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/API.md
View File

@ -38,9 +38,10 @@ WIP\
Аргументы:
| Название | Тип | Описание | Доступные значения |
|--------------|-------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
|--------------|-------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `modpack_id` | `int` | ID модпака | |
| `fields` | `str` | (Опционально)<br/>Поля, которые нужно вернуть. | - `name`<br/>- `description`<br/>- `version`<br/>- `author`<br/>- `mods`<br/>- `mods_count`<br/>- `created_at`<br/>- `updated_at` |
| `fields` | `str` | (Опционально)<br/>Поля, которые нужно вернуть.<br/>Пример: `name,version` | - `name`<br/>- `description`<br/>- `version`<br/>- `author`<br/>- `mods`<br/>- `mods_count`<br/>- `created_at`<br/>- `updated_at` |
| `token` | `str` | Токен авторизации | |
| `v` | `str` | Версия API | |
@ -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`

72
docs/API_ERRORS.md Normal file
View File

@ -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`<br/>- `modpacks.get` |
| 101 | Modpack already exists | - `modpacks.create` |