docs: update system documentation references
This commit is contained in:
+2
-2
@@ -14,8 +14,8 @@
|
|||||||
| JWT, cookie, login/refresh/logout, guard/access, token encryption, sensitive logs | [Security](conventions/security-auth.md) |
|
| JWT, cookie, login/refresh/logout, guard/access, token encryption, sensitive logs | [Security](conventions/security-auth.md) |
|
||||||
| External client/integration boundary; T-Bank/gRPC/proto, retry/rate limit/cache | [Integrations](conventions/backend-integrations.md) |
|
| External client/integration boundary; T-Bank/gRPC/proto, retry/rate limit/cache | [Integrations](conventions/backend-integrations.md) |
|
||||||
| Logging/request context без изменения secrets/auth | [Logging](conventions/backend-architecture.md#logging) |
|
| Logging/request context без изменения secrets/auth | [Logging](conventions/backend-architecture.md#logging) |
|
||||||
| Новый abstraction/dependency, refactor, неясный scope | [Общий выбор реализации](../../docs/development/engineering-governance.md#выбор-реализации) |
|
| Новый abstraction/dependency, refactor, неясный scope | [Общий выбор реализации](../../AGENTS.md) |
|
||||||
| Изменение request/response/route/status/error shape или Swagger metadata | HTTP API + [общий contract workflow](../../docs/development/runtime-openapi-verification.md) |
|
| Изменение request/response/route/status/error shape или Swagger metadata | HTTP API + [Источник HTTP-контракта](../../docs/architecture/http-api.md#источник-контракта) |
|
||||||
|
|
||||||
Новый endpoint обычно требует HTTP API + Testing; Architecture/Data/Security
|
Новый endpoint обычно требует HTTP API + Testing; Architecture/Data/Security
|
||||||
добавляются по новым ответственности, persistence или access rules.
|
добавляются по новым ответственности, persistence или access rules.
|
||||||
|
|||||||
@@ -4,8 +4,7 @@
|
|||||||
|
|
||||||
Сначала определи, меняется wire contract или только реализация существующего
|
Сначала определи, меняется wire contract или только реализация существующего
|
||||||
use case. Для route/request/response/status/error shape читай
|
use case. Для route/request/response/status/error shape читай
|
||||||
[HTTP semantics](../../../docs/architecture/http-api.md) и
|
[HTTP semantics и источник контракта](../../../docs/architecture/http-api.md).
|
||||||
[общий contract workflow](../../../docs/development/runtime-openapi-verification.md).
|
|
||||||
|
|
||||||
| Проверка | Где выполнять |
|
| Проверка | Где выполнять |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
|
|||||||
@@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
## Выбор уровня
|
## Выбор уровня
|
||||||
|
|
||||||
Применяй [общие testing risks](../../../docs/development/engineering-governance.md#risk-based-testing).
|
Проверяй риски доступа, денежных расчётов, целостности данных, конкурентных
|
||||||
|
изменений, публичного контракта и подтверждённых регрессий.
|
||||||
Тесты должны различать правильное и неправильное наблюдаемое поведение.
|
Тесты должны различать правильное и неправильное наблюдаемое поведение.
|
||||||
|
|
||||||
| Что меняется | Проверка |
|
| Что меняется | Проверка |
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ zero-warning ESLint, application/test TypeScript, Jest и build.
|
|||||||
`lint:fix`/`format` пишут файлы и запускаются отдельно от доказательства проверки.
|
`lint:fix`/`format` пишут файлы и запускаются отдельно от доказательства проверки.
|
||||||
`test:cov` — диагностика без общего threshold; scripts принадлежат `package.json`.
|
`test:cov` — диагностика без общего threshold; scripts принадлежат `package.json`.
|
||||||
|
|
||||||
HTTP contract changes дополнительно проходят общий
|
HTTP contract changes сохраняют [направление контракта](../docs/architecture/http-api.md#источник-контракта)
|
||||||
[contract workflow](../docs/development/runtime-openapi-verification.md).
|
и проходят contract check. Общий e2e запускается на отдельных временных DB;
|
||||||
Общий e2e запускается на отдельных временных DB; применимость и маршрут проверки
|
применимость и маршрут проверки
|
||||||
описаны в [backend testing](.ai/conventions/backend-testing.md).
|
описаны в [backend testing](.ai/conventions/backend-testing.md).
|
||||||
Generated Prisma client не редактируется вручную. Credentials, авторизация
|
Generated Prisma client не редактируется вручную. Credentials, авторизация
|
||||||
доступа к счетам и внешние интеграции остаются server-side.
|
доступа к счетам и внешние интеграции остаются server-side.
|
||||||
|
|||||||
@@ -34,8 +34,7 @@ application/test typechecks, Jest и build. `npm run lint:fix` — отдель
|
|||||||
записывающая команда, `npm run test:cov` — диагностика без общего числового
|
записывающая команда, `npm run test:cov` — диагностика без общего числового
|
||||||
threshold. `npm run test:e2e` отдельно проверяет все HTTP suites на новых базах
|
threshold. `npm run test:e2e` отдельно проверяет все HTTP suites на новых базах
|
||||||
и runtime OpenAPI с соседним frontend checkout. Для полной backend-проверки
|
и runtime OpenAPI с соседним frontend checkout. Для полной backend-проверки
|
||||||
выполните обе команды. Результаты — в
|
выполните обе команды.
|
||||||
[remediation registry](../docs/development/audit-remediation.md).
|
|
||||||
|
|
||||||
Nest 12 поставляется как ESM. Скрипты Jest включают `--experimental-vm-modules`,
|
Nest 12 поставляется как ESM. Скрипты Jest включают `--experimental-vm-modules`,
|
||||||
включая watch/coverage/debug; SQLite runner включает тот же флаг. TypeScript 6
|
включая watch/coverage/debug; SQLite runner включает тот же флаг. TypeScript 6
|
||||||
@@ -83,13 +82,10 @@ runtime-валидацию. В обычном коде нужны инициал
|
|||||||
- [HTTP API](.ai/conventions/backend-http-api.md), [data](.ai/conventions/backend-data.md) и [testing](.ai/conventions/backend-testing.md)
|
- [HTTP API](.ai/conventions/backend-http-api.md), [data](.ai/conventions/backend-data.md) и [testing](.ai/conventions/backend-testing.md)
|
||||||
- [Security/auth](.ai/conventions/security-auth.md) и [integrations](.ai/conventions/backend-integrations.md)
|
- [Security/auth](.ai/conventions/security-auth.md) и [integrations](.ai/conventions/backend-integrations.md)
|
||||||
|
|
||||||
- [Границы проверки API и данных](../docs/development/verification.md#api-и-хранение-данных)
|
|
||||||
- [Engineering governance и risk-based testing](../docs/development/engineering-governance.md)
|
|
||||||
- [Карта проектных фактов](../docs/README.md)
|
- [Карта проектных фактов](../docs/README.md)
|
||||||
- [API contract и runtime OpenAPI](../docs/development/runtime-openapi-verification.md)
|
- [API contract и runtime OpenAPI](../docs/architecture/http-api.md#источник-контракта)
|
||||||
- [Обзор поставленной системы](../docs/overview.md)
|
- [Обзор поставленной системы](../docs/overview.md)
|
||||||
- [Архитектурные решения](../docs/adr/README.md)
|
- [Архитектурные решения](../docs/adr/README.md)
|
||||||
- [Remediation registry](../docs/development/audit-remediation.md)
|
|
||||||
|
|
||||||
Из backend runtime OpenAPI можно read-only сверить с frontend snapshot:
|
Из backend runtime OpenAPI можно read-only сверить с frontend snapshot:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user