Files
bible/rules/patterns/hardware-ingest-json/contract.md
T

2.4 KiB
Raw Blame History

Contract: Hardware Ingest JSON

Version: 2.10 Source: bee/bible-local/docs/hardware-ingest-contract.md (canonical upstream)

Стандартный JSON-контракт для передачи данных об аппаратном обеспечении серверов в Reanimator. Используется в bee, logpile, core и внешних интеграторах (Redfish-коллекторы, CMDB-экспортёры).

Актуальная версия: https://git.mchus.pro/reanimator/core/src/branch/main/bible-local/docs/hardware-ingest-contract.md

Принципы

  1. Snapshot — JSON описывает состояние сервера на момент сбора. Может включать историю изменений статуса.
  2. Идемпотентность — повторная отправка идентичного payload не создаёт дублей (дедупликация по хешу).
  3. Частичность — можно передавать только те секции, данные по которым доступны. Пустой массив и отсутствие секции эквивалентны.
  4. Строгая схема — endpoint использует строгий JSON-декодер; неизвестные поля приводят к 400 Bad Request.
  5. Event-driven — импорт создаёт события в timeline (LOG_COLLECTED, INSTALLED, REMOVED, FIRMWARE_CHANGED и др.).
  6. Без синтеза — сборщик передаёт только фактически собранные значения. Запрещено придумывать serial_number, component_ref, message, message_id или иные идентификаторы, если источник их не предоставил.

Endpoint

POST /ingest/hardware
Content-Type: application/json

Ответ 202 Accepted с job_id. Результат: GET /ingest/hardware/jobs/{job_id}.

Topic Contracts