Назначение
<ModelName> используется для <request/response/view/snapshot/settings/rule/export row> в <service/feature>.
| Поле | Значение |
|---|
| Статус | draft / approved / deprecated |
| Owning team | <team> |
| Model kind | <request/response/view/settings/snapshot/export> |
| Versioning | <versioned/not versioned> |
Где Используется
| Usage | Ссылка | Direction |
|---|
| API method | <link> | Request/Response |
| Операция | <link> | Вход/Результат |
| Event | <link> | Snapshot |
| UI | <link> | View model |
| Export | <link> | Row model |
Поля
| Поле | Тип | Обязательное | Nullable | Источник | Правила | Безопасность |
|---|
<FieldName> | <TypedValue> | Да/Нет | Да/Нет | <source> | <constraints> | <mask/exclude> |
Enum Значения
| Enum | Значение | Смысл | Unknown handling |
|---|
<Status> | <Value> | <meaning> | <fallback> |
Nested Модели
| Модель | Назначение | Где Описана |
|---|
<NestedModelName> | <purpose> | <this file/other file> |
Валидация
Совместимость
- Optional поля можно добавлять без breaking change.
- Переименование, удаление, изменение типа или смысла поля является breaking change.
- Для versioned model указывается
ModelVersion, migration note и fallback behavior.
Безопасность
- Data classification:
<Public/Internal/PII/Sensitive/Secret>.
- Masking rules:
<rule>.
- Secrets, credentials и приватные ключи в бизнес-моделях запрещены.
Обратные ссылки
Автоссылки: где используется этот документ.
Связанные Документы