Перейти к основному содержимому

Назначение

<ModelName> используется для <request/response/view/snapshot/settings/rule/export row> в <service/feature>.

Metadata

ПолеЗначение
Статус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>

Валидация

  • <rule>;
  • <rule>;
  • <rule>.

Совместимость

  • Optional поля можно добавлять без breaking change.
  • Переименование, удаление, изменение типа или смысла поля является breaking change.
  • Для versioned model указывается ModelVersion, migration note и fallback behavior.

Безопасность

  • Data classification: <Public/Internal/PII/Sensitive/Secret>.
  • Masking rules: <rule>.
  • Secrets, credentials и приватные ключи в бизнес-моделях запрещены.

Обратные ссылки

Автоссылки: где используется этот документ.

Связанные Документы

  • <links>