Справочник
Каталоги, матрицы, шаблоны и source-of-truth артефакты платформы.
Reference
Справочные артефакты отвечают на вопрос «где находится актуальное значение». Портал объясняет назначение и формат, а изменяемые operational values должны поступать из соответствующего source of truth.
Обязательные каталоги
| Каталог | Минимальное содержание | Owner |
|---|---|---|
| API Catalog | API, version, owner, status, Consumers, deprecation | API Management |
| API Product Catalog | Product, included operations, subscription model | API Owner |
| Topic Catalog | Topic, schema, producer, consumers, key, retention | Kafka/Router owner |
| Adapter Catalog | Target system, endpoints, owner, supported operations | Adapter team |
| Flow Catalog | Kestra flow, version, triggers, dependencies, owner | Orchestration owner |
| Environment Matrix | DNS, ingress, namespace, dependencies, readiness | Platform team |
| Service Registry | Service, support owner, dashboard, alerts, runbooks | Operations |
| Decision Log | ADR, status, context, decision, consequences | Architecture |
Матрица окружений
Для каждого environment фиксируются ссылки на:
- consumer-facing endpoints;
- administrative endpoints;
- Kubernetes cluster/namespace;
- Kafka cluster и topic namespace;
- database instances/schemas;
- dashboards и logs;
- pipeline и registry;
- secrets/certificate ownership;
- readiness status.
D8 Transaction Services snapshot
Confluence export от 19 августа 2026 добавляет и обновляет шесть transaction routes. Таблица ниже служит навигационным snapshot; полные request/response schemas должны публиковаться из versioned OpenAPI, а не копироваться вручную из Confluence. Общий runtime flow описан на странице D8 Transaction Services.
| Router rule | Operation | Input topic | Sync reply topic | DLT topic |
|---|---|---|---|---|
| 38 | getCardTransactionHistory | transactions.in.d8.command.get-card-transaction-history | transactions.out.d8.reply.get-card-transaction-history | transactions.dlt.d8.command.get-card-transaction-history |
| 39 | getTransactionDetails | transactions.in.d8.command.get-transaction-details | transactions.out.d8.reply.get-transaction-details | transactions.dlt.d8.command.get-transaction-details |
| 40 | authorizeTransaction | transactions.in.d8.command.authorize-transaction | transactions.out.d8.reply.authorize-transaction | transactions.dlt.d8.command.authorize-transaction |
| 41 | reverseTransaction | transactions.in.d8.command.reverse-transaction | transactions.out.d8.reply.reverse-transaction | transactions.dlt.d8.command.reverse-transaction |
| 42 | getTransactionStatus | transactions.in.d8.command.get-transaction-status | transactions.out.d8.reply.get-transaction-status | transactions.dlt.d8.command.get-transaction-status |
| 43 | calculateAcqCommission | transactions.in.d8.command.calculate-acq-commission | transactions.out.d8.reply.calculate-acq-commission | transactions.dlt.d8.command.calculate-acq-commission |
Для async-варианта всех шести операций используется callback.out. Adapter проверяет idempotencyKey, сохраняет результат для безопасного повтора и направляет неуспешно обработанные сообщения в соответствующий DLT. Точные retry parameters и error mapping должны подтверждаться реализацией и тестами перед публикацией SLA.
Credentials не являются документацией API
Учётные данные, секреты и полные токены из Confluence exports не переносятся в портал или OpenAPI. Храните только secret reference и процедуру получения доступа.
Не храните secrets в справочнике
Каталог содержит ссылку на secret reference и owner, но не значение secret. То же относится к private keys, passwords и полным access tokens.
Шаблоны
- New Consumer Onboarding Request;
- Access Modification Request;
- New API Request;
- API Design Review;
- Topic Registration;
- Adapter Onboarding;
- Architecture Decision Record;
- Release Checklist;
- Incident Record;
- Sandbox Audit;
- Runbook;
- Restore Test Record.
Статусы документов
| Статус | Значение |
|---|---|
| Draft | В разработке, не является нормативным |
| Review | Передан на согласование |
| Approved | Действующее правило/source of truth |
| Deprecated | Имеет замену, действует переходный период |
| Archived | Не применяется |
Управление актуальностью
Каждый документ имеет owner, status, version и review date. При изменении API, flow, topology или policy соответствующая документация обновляется в рамках той же поставки.
Где искать информацию
- назначение платформы —
Introduction; - подключение Consumer —
Consumer Onboarding; - создание API —
API Publishing; - нормативные правила —
Architecture & Standards; - диагностика и восстановление —
Operations & Reference.
Если информация расходится, приоритет имеет утверждённый source of truth с более новым version/review date; конфликт должен быть зарегистрирован и устранён владельцем.