Files
buryan-infra/docs/DATA-API.md
buryan-agent e0309080bc API данных: боты сохраняют всё в папку проекта
POST /data/<коллекция> — запись документа, GET /data/<коллекция> — чтение,
POST /export — выгрузка в /root/buryan-infra/data/.

Боты при любом пожелании пишут его в коллекцию wishes (кто, какой бот,
номер, текст). Команда !export выгружает коллекцию из чата. Каждый день
в 23:00 cron выгружает wishes, dialog, events и копирует журналы.

Проверено: пожелание от @polina легло в API и в файл, !export вернул путь,
в папке проекта 6 файлов (wishes, dialog, events, logs).
2026-10-19 20:13:37 +03:00

52 lines
1.8 KiB
Markdown

# API данных: боты пишут в папку проекта
Любой бот (и любой сервис) может сохранить данные в ядро — они лягут
в папку проекта `/root/buryan-infra/data/`.
## Записать
```
POST /data/<коллекция>
{"key": "уникальный-ключ", "payload": {"любые": "поля"}, "tags": ["метка"]}
```
Повторная запись с тем же ключом обновляет документ.
## Прочитать
```
GET /data/<коллекция>?limit=50&tag=пожелание
```
## Выгрузить в папку проекта
```
POST /export
{"collection": "wishes", "format": "md"} # или json
```
Файл появится в `/root/buryan-infra/data/<коллекция>/`.
## Что уже пишется автоматически
| Что | Куда |
|---|---|
| Пожелания из любого бота | коллекция `wishes` |
| Диалоги с моделью | `/var/lib/hub-bots/dialog.jsonl` → `data/logs/` |
| Входящие пожелания | `/var/lib/hub-bots/inbox/*.jsonl` → `data/logs/` |
| События системы | коллекция `events` |
Ежедневно в 23:00 (`/etc/cron.d/hub-export`) всё выгружается в репозиторий.
## Команда бота
`!export wishes` — выгрузить коллекцию прямо из чата, бот вернёт путь.
## Проверено
* пожелание «хочу сериал про космос» от @polina легло в `wishes`
с полями от/бот/номер/текст;
* `!export wishes` выгрузил файл и вернул путь;
* в папке проекта: `data/wishes/`, `data/dialog/`, `data/events/`,
`data/logs/` (6 файлов).