Skip to content

contracts

contracts хранит договорённости между сервисами, чтобы API и event-схемы не расходились по репозиториям.

Что хранится

ПутьНазначение
graphql/schema.graphqlGraphQL-контракт для npp-backend и npp-web
events/source-raw.v1.jsonсхема сырого события
events/source-normalized.v1.jsonсхема нормализованного события
queue-messages/примеры сообщений для отладки и тестов

Кто использует

  • npp-backend реализует GraphQL-схему.
  • npp-web ориентируется на GraphQL-контракт API.
  • scrape-helper и processing-worker валидируют события по общим схемам.

Когда менять этот репозиторий

  • когда меняется shape GraphQL API;
  • когда появляется новое поле в raw- или normalized-событии;
  • когда нужно синхронно обновить несколько сервисов без скрытого дрейфа.

Проверка

bash
npm install
npm run validate

Техническая и аналитическая документация платформы NPPWEB.