115 lines
1.6 KiB
Markdown
115 lines
1.6 KiB
Markdown
# {{title}}
|
|
|
|
## Summary
|
|
- Purpose:
|
|
- Actor:
|
|
- Trigger:
|
|
- Endpoint:
|
|
- Main entities:
|
|
- Main logic:
|
|
- Main errors:
|
|
- Source of truth:
|
|
|
|
## Назначение
|
|
|
|
## Контекст
|
|
|
|
## Технический use case
|
|
|
|
### Основной сценарий
|
|
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
### Альтернативные ветки
|
|
|
|
-
|
|
-
|
|
|
|
## Функциональные требования
|
|
|
|
### Request validation
|
|
-
|
|
|
|
### Processing rules
|
|
-
|
|
|
|
### State changes
|
|
-
|
|
|
|
### Side effects
|
|
-
|
|
|
|
## Contract
|
|
|
|
### Endpoint
|
|
- Method:
|
|
- Path:
|
|
- Auth:
|
|
- Idempotent:
|
|
- Timeout:
|
|
- Retry:
|
|
|
|
### Request
|
|
| Field | Type | Required | Constraints | Description |
|
|
|------|------|----------|-------------|-------------|
|
|
| | | | | |
|
|
|
|
### Response
|
|
| Field | Type | Description |
|
|
|------|------|-------------|
|
|
| | | |
|
|
|
|
### External contract refs
|
|
- OpenAPI:
|
|
- Schema:
|
|
- DTO / serializer:
|
|
- Additional refs:
|
|
|
|
## Errors
|
|
|
|
| error_id | http_code | when | client_behavior | retry |
|
|
|----------|-----------|------|-----------------|-------|
|
|
| | | | | |
|
|
|
|
## Нефункциональные требования
|
|
|
|
### Security
|
|
-
|
|
|
|
### Observability
|
|
- Logs:
|
|
- Metrics:
|
|
- Traces:
|
|
- Audit:
|
|
|
|
### Reliability
|
|
-
|
|
-
|
|
|
|
### Performance
|
|
-
|
|
|
|
## Связанные блоки логики
|
|
-
|
|
|
|
## Связанные сущности
|
|
-
|
|
|
|
## Связанный код
|
|
|
|
### Files
|
|
-
|
|
|
|
### Symbols
|
|
-
|
|
|
|
## Связанные документы
|
|
-
|
|
|
|
## История изменений
|
|
|
|
| Date | Source | Changes |
|
|
|------|--------|---------|
|
|
| | | | |