docs: refresh project onboarding entrypoints
This commit is contained in:
+12
-1
@@ -1,3 +1,14 @@
|
||||
# Features
|
||||
# Возможности
|
||||
|
||||
Здесь документируется фактическое поведение завершенных пользовательских фич: пользовательский поток, API-сценарий и ограничения. Не реализованные возможности сюда не добавляются.
|
||||
|
||||
- [Аутентификация](authentication.md) — регистрация, сессии и refresh.
|
||||
- [Подключение T-Bank](tbank-connection.md) — безопасное управление
|
||||
подключением.
|
||||
- [Брокерские счета](brokerage-accounts.md) — список поддерживаемых счетов.
|
||||
- [Портфель](portfolio-view.md) — состав инвестиций и freshness states.
|
||||
- [Account Ledger](brokerage-account-ledger.md) — исполненные операции счёта.
|
||||
- [Future Cash Events](brokerage-account-upcoming-events.md) — прогнозируемые
|
||||
события по текущим позициям.
|
||||
- [Frontend UI resilience](frontend-ui-resilience.md) — устойчивые состояния
|
||||
интерфейса.
|
||||
|
||||
@@ -24,7 +24,7 @@ sequenceDiagram
|
||||
|
||||
`INVALID_TBANK_TOKEN` означает, что T-Bank отклонил аутентификацию или права доступа. `TBANK_UNAVAILABLE` означает временную ошибку, превышение лимита, ожидание в очереди или другую ошибку внешнего сервиса.
|
||||
|
||||
## Configuration and limits
|
||||
## Конфигурация и ограничения
|
||||
|
||||
- `TOKEN_ENCRYPTION_KEY` - закодированный в base64 32-байтный ключ AES-256-GCM; обязателен при запуске.
|
||||
- `TBANK_GRPC_ENDPOINT` по умолчанию имеет значение `invest-public-api.tbank.ru:443`.
|
||||
@@ -35,6 +35,12 @@ FIFO-ограничитель на экземпляр запускает не б
|
||||
|
||||
Портфель с большим числом ранее не кэшированных инструментов создаёт отдельные metadata lookup. Если в такой ситуации очередь переполняется и позиции получают FIGI вместо names, увеличьте `TBANK_RATE_LIMIT_PER_SECOND` в соответствии с разрешённой upstream-квотой; для локального портфеля из множества позиций использовалось значение `50`.
|
||||
|
||||
## MVP limits
|
||||
## Ограничения
|
||||
|
||||
Реализована только проверка токена. Счета, портфели, кэш метаданных инструментов, ротация ключа, распределенное ограничение запросов и сериализация параллельного обновления подключения отложены. Вендорные protobuf-контракты взяты из `references/moex-vibe`; при необходимости обновляйте их вручную по официальной документации T-Bank Invest API.
|
||||
Подключение используется поставленными сценариями Brokerage Accounts,
|
||||
Portfolio, Account Ledger и Future Cash Events; frontend не обращается к
|
||||
T-Bank напрямую. Token encryption key не ротируется, rate limit остаётся
|
||||
per-instance, а обновление connection не сериализуется между распределёнными
|
||||
экземплярами backend. Вендорные protobuf-контракты взяты из
|
||||
`references/moex-vibe`; при необходимости обновляйте их вручную по официальной
|
||||
документации T-Bank Invest API.
|
||||
|
||||
Reference in New Issue
Block a user