Руководства разработчика
В этом каталоге находятся нормативные документы, которые должны соответствовать текущему коду. Планы, отчёты о выполнении и журналы отдельных рефакторингов не являются guides.
Основные контракты
- API.md — HTTP API, JWT/auth sessions, OpenAPI, frontend proxy и тестирование.
- LDAP.md — LDAP/AD authentication, write-back, sync, retry queue и admin.
- WEBSOCKET.md — единый
/ws/, JWT, actions, events и production proxy. - NOTIFICATIONS.md — создание, доставка, REST, realtime, email и Web Push.
- COMMERCE.md — каталог, МойСклад, изображения, Celery и realtime-прогресс.
Frontend
- frontend/ — нормативная карта UI-системы, геометрии и workflow review.
Backend и эксплуатация
- CACHING_SETUP.md
- CELERY.md
- DJANGO_CORS_SETUP.md
- DJANGO_RULES_INTEGRATION.md
- IP_REGISTRATION_RESTRICTIONS.md
- LIVE_VALIDATION_GUIDE.md
- REQUESTS_DETAIL_VIEW_GUIDE.md
- testing-request-filters.md
Правила поддержки
- Guide описывает устойчивый контракт или операционную процедуру, а не историю реализации.
- Endpoint-ы REST не перечисляются вручную, если они уже представлены в OpenAPI.
- WebSocket message schema меняется вместе с AsyncAPI и tests.
- Ссылка на файл должна быть относительной и проходить link check.
- Завершённый plan/report удаляется; существенное архитектурное решение переносится в актуальный guide.