Files
agent/_process/doc_rules_v3/global/frontmatter.md
T

1.2 KiB

Frontmatter Rules

Обязательные поля

id: string
title: string
doc_type: string
domain: string
sub_domain: string
related_docs: []
status: string

Рекомендуемые поля

tags: []
entities: []
source_of_truth: string
related_code: []
system_analytics_refs: []

Дополнительные обязательные поля по типам документов

  • Для doc_type: api_method поле endpoint обязательно.
  • Значение endpoint должно содержать HTTP-метод и путь, например: GET /orders/{orderId}.
  • Если в аналитике endpoint указан в заголовке раздела, use case, контракте или интеграционной схеме, его нужно перенести во frontmatter и не опускать.

Body-метаданные для секции изменений

Под корнем секции изменений указывать:

  • domain
  • sub_domain

Для каждого подраздела X.Y указывать строками:

  • id
  • doc_type
  • application
  • platform