add: documentation
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Полный дамп параметров API (test)
|
||||
|
||||
Этот документ фиксирует расположение и структуру полной выгрузки параметров API для окружения test. Дамп нужен для проверки универсального алгоритма генерации YAML.
|
||||
|
||||
## Где лежит
|
||||
|
||||
- Полный набор артефактов: [artifacts/api-meta/test](../../artifacts/api-meta/test)
|
||||
|
||||
## Состав дампа
|
||||
|
||||
- Список сервисов: [artifacts/api-meta/test/services.json](../../artifacts/api-meta/test/services.json)
|
||||
- Детали сервисов по svcId: [artifacts/api-meta/test/services](../../artifacts/api-meta/test/services)
|
||||
- Операции и их параметры по svcId: [artifacts/api-meta/test/operations](../../artifacts/api-meta/test/operations)
|
||||
- Сводный JSONL по всем операциям: [artifacts/api-meta/test/all_params.jsonl](../../artifacts/api-meta/test/all_params.jsonl)
|
||||
- Индекс по сервисам и количествам: [artifacts/api-meta/test/all_params_index.json](../../artifacts/api-meta/test/all_params_index.json)
|
||||
- Аномалии полей параметров: [artifacts/api-meta/test/anomalies.txt](../../artifacts/api-meta/test/anomalies.txt)
|
||||
- Маркеры готовности: [artifacts/api-meta/test/STATUS.txt](../../artifacts/api-meta/test/STATUS.txt), [artifacts/api-meta/test/STATUS_SUMMARY.txt](../../artifacts/api-meta/test/STATUS_SUMMARY.txt)
|
||||
|
||||
## Что внутри
|
||||
|
||||
- В файлах операций содержатся `svcOperation.cfsParams` — входные параметры операций.
|
||||
- Сводный файл JSONL агрегирует операции и их параметры в одной строке на операцию.
|
||||
|
||||
## Использование
|
||||
|
||||
Этот дамп используется как эталон для анализа универсального алгоритма генерации YAML и проверки покрытия всех операций и параметров.
|
||||
Reference in New Issue
Block a user