Zimin A.N.
11c9797757
Diplodoc CLI 4.60 транформирует `{% list tabs %}` встроенным плагином,
но runtime assets (`_assets/tabs-extension.{js,css}`) НЕ копирует
автоматически — в отличие от mermaid/latex/page-constructor, у которых
bundle paths захардкожены в CLI.
Решение:
- добавил devDep `@diplodoc/tabs-extension@^3` (содержит runtime/)
- post-build `copy-tabs-runtime` script: копирует
`build/runtime/index.{js,css}` → `_dist/_assets/tabs-extension.{js,css}`
- index.md: 4 секции "С чего начать" обёрнуты в `{% list tabs %}` —
выглядит компактнее и интерактивнее чем плоский список заголовков
Verified локально: `yfm-tabs` HTML рендерится, assets в `_dist/_assets/`.
nginx fallback rule для `/docs/_assets/*` уже работает.
3.3 KiB
Ordinis НСИ ЦУОД ОДХ — Integrator Guide
Документация для команд, интегрирующих свои сервисы с Ordinis НСИ ЦУОД. Сюда не входят operator runbooks и архитектурные deep-dives — те материалы во внутренней документации проекта.
Anchor v1 — production LIVE на cluster.142 (с 2026-05-07). Альтум consumers подключены, blue/green cutover завершён.
С чего начать
{% list tabs %}
-
Я интегрирую свой сервис
Начни с обзора API и авторизации.
Дальше:
- Read-side endpoints — как читать справочники
- События (Kafka outbox) — топики
ordinis.cuod.events.* - Webhooks — push-уведомления вместо polling
- Кэширование — TTL / push / snapshot стратегии
-
Я строю UI / клиент
- Cross-references — FK между справочниками
- Bitemporal —
validFrom/validTo+ история - Bundle cuod — список 40 справочников ЦУОД
- Best practices — частые ошибки
-
Я обрабатываю ошибки
- Ошибки и rate limits — error codes, retry strategy
- Лучшие практики — robust integration
-
Я хочу пощупать API
Открой Swagger UI — там можно нажать Authorize → войти через Keycloak (PKCE, без secret) → и сразу делать "Try it out" с реальным JWT. Authorization, error codes, schemas — всё через interactive UI.
{% endlist %}
Среды
| Среда | URL | Auth | Назначение |
|---|---|---|---|
| prod | https://ordinis.k8s.264.nstart.cloud/ |
JWT обязателен | Real users |
| staging | https://ordinis.k8s.265.nstart.cloud/ |
optional (legacy mode) | Dev environment |
| local | http://localhost:8080 |
off | docker-compose dev |
Поддержка
- Запросы новых ролей / scope в Keycloak:
zimin.an@nstart.space - Bug reports / feature requests: через issue tracker (запросить URL у Ordinis team)
Версионирование
API стабилизирован под v1 — breaking changes только через major bump (v2). См.
Best practices для рекомендаций по
обработке появления новых полей в v1 (forward compatibility).
Bundle справочников ЦУОД versioned отдельно (cuod-bundle:1.2.1). Изменение
schemas — minor bump, добавление словарей — minor bump, удаление — major bump
(никогда без уведомления consumers через record.closed events).