Stack Golden — Документація
Бек-сервіс. HTTP API для електрон-клієнта (/electron-api/*), оператор-API (/operator-api/*), адмінка, статистика, RMQ-обмін з рештою стеку.
Головний вхід — Canvas. Правила формату — CONVENTIONS. Процес заповнення — AUTHORING. Терміни — glossary.
Категорії
Бек-сервіси розкладені за тригером (хто/що ініціює виклик), а не за доменом — бо домени перетинаються, а життєвий цикл «UI клік» і «крон щомінутно» різний.
- ui-triggered — те що клікає фронт або electron. Один контролер на сервіс. Таблиці по логічних групах з мітками покриття. Дзеркало
ui-family/*іui-shared/*зі stack-client. - workers — фонові задачі: Bull-черги, every-min планувальник, аґрегатори. По таймеру.
- integrations — що саме golden віддає/слухає назовні: конкретні RMQ-події (публікує/споживає) і ClickHouse-таблиці з призначенням. Як влаштовані самі RMQ/ClickHouse — у stack-docs, тут — golden-контракт.
- features — бізнес-фічі рівня всього сервісу (Statistics).
- entities — структури даних (Mongoose-схеми + ClickHouse).
- system — golden-специфічна інфра (кеш-стори). Платформенний стек (HTTP-конвенція, auth, Bull-engine, Winston) — спільний для всіх беків, у stack-docs.
Покриття документації
| Розділ | ✅ | 🟡 | ⬜ | Разом |
|---|---|---|---|---|
| ui-triggered | 4 | 2 | 25 | 31 |
| workers | 12 | — | — | 12 |
| integrations | — | 3 | — | 3 |
| features | — | 1 | — | 1 |
| system | — | — | 1 | 1 |
| Разом | 16 | 6 | 26 | 48 |
Легенда: ✅ заповнено · 🟡 частково (є контент, лишились #TODO) · ⬜ скелет (шапка + пара нотаток).
entities не в таблиці: реєстр на ~50 колекцій готовий (✅), окремих entity-сторінок поки 0 — пишемо за потреби.
API
Live Swagger UI: /golden/api-docs/v2. Контракт ендпоінтів — у Swagger; у markdown тільки бізнес-нюанси і deeplinks. Карта всіх Swagger-ів + єдина конвенція відповідей + нюанси гвардів — у API Map (stack-docs).
Платформенний стек
HTTP-шар (два паралельні стеки: legacy BaseController + routing-controllers), конвенція відповідей {success, data} з HTTP-200, SuccessWrapperInterceptor, ExeptionFilter, MiddlevareAuth/guard, Bull-engine, Winston — усе це спільне для всіх беків через stack-commons. Описано один раз у stack-docs: API Map. Як мігрувати legacy-контролер на RC — у CLAUDE.md цього репо.
Глибина опису
Тільки бізнес-нюанси і сервіс-специфічні правила. HTTP-контракт — у Swagger. Storage-форма — у entities/. Платформенна механіка — у stack-docs. Загальні UI-флоу — у stack-client docs.