Files
tf_provider/docs/TODO/resource_name_docs.md
T

2.0 KiB

resource_name в документации — план доработок

Суть проблемы

  • resource_nameRequired: true во всех 82+ сгенерированных ресурсах
  • Хардкодится в Go-шаблоне: universal_rebuild/tools/gen_v2/generate_resources_v2.go:911
  • Мапится на API-поле displayName (CRUD: universal_rebuild/internal/resources_core/crud.go:30)
  • В сгенерированной документации (docs/30_registry/resources/*.md) — отсутствует полностью
  • Нет ни в HCL-примерах, ни в таблицах параметров

Причина

Docs-генератор (universal_rebuild/tools/docs_template_gen_v2/main.go) читает только YAML-спеки, а resource_name — не API-параметр create-операции, его нет в YAML. Это мета-параметр уровня провайдера.

Что править

Один файл: universal_rebuild/tools/docs_template_gen_v2/main.go

  1. exampleBlock() (~строка 373) — добавить resource_name = "my-instance" первой строкой в resource-блок
  2. buildCreateParamsPage() (~строка 411) — добавить секцию «Системные параметры» с описанием resource_name перед таблицей create-параметров

Почему не YAML

  • resource_name — не API-параметр, это уровень Terraform-провайдера
  • Добавление в 42 YAML-спека семантически неверно + легко забыть при новых сервисах
  • Правильнее зеркально Go-генератору: один раз в docs-генераторе → охват всех ресурсов

Чеклист

  • resource_name в HCL-примерах (exampleBlock)
  • resource_name в таблицах create-параметров (buildCreateParamsPage)