Zimin A.N.
d5268b9395
Новая документация-as-code на платформе Diplodoc (Yandex open-source) с YFM (Yandex Flavored Markdown). Build → static HTML, deployable куда угодно. Что добавлено: - package.json + .yfm + toc.yaml — Diplodoc setup, навигация для sidebar - index.md — главная страница с tabs для разных audiences - README.md — инструкция для contributors Раздел integration/api/ — 11 страниц про интеграцию consumers: - index — обзор + глоссарий - auth — Keycloak service accounts, scope mapping - read-endpoints — GET /dictionaries, list/by-key, spatial filters - events — Kafka outbox топики, partition keys, idempotency, DLQ - webhooks — HMAC, SSRF guard, retry policy, test ping endpoint - bitemporal — validFrom/validTo + history, future-dated entries, bulk close/export - x-references — FK syntax, validation errors, scope hiding, orphan scanner, v2 cascade preview - caching — TTL / push / snapshot strategies, hybrid pattern - errors — full error code reference (validation/auth/conflict/server), retry strategy - best-practices — 33 numbered rules для consumers - bundle-cuod — все 40 справочников с FK графом и сценариями Обновлены: - ops/README.md — link на новую integration/api/, убран inline <br> - ops/slo.md — broken cross-repo links заменены на text references Build: cd docs && pnpm install && pnpm build → ./_dist (20 HTML files, 7.1M) pnpm serve # → http://localhost:8088 CI deploy job для GitLab Pages — в roadmap (см. docs/README.md). Существующий tech/api-integration.md оставлен в toc как legacy (содержимое мигрировано + расширено в integration/api/).
57 lines
1.7 KiB
YAML
57 lines
1.7 KiB
YAML
title: Ordinis НСИ ЦУОД ОДХ
|
|
href: index.md
|
|
|
|
items:
|
|
- name: Введение
|
|
href: index.md
|
|
|
|
- name: Интеграция по API
|
|
items:
|
|
- name: Обзор
|
|
href: integration/api/index.md
|
|
- name: Авторизация
|
|
href: integration/api/auth.md
|
|
- name: Read-side endpoints
|
|
href: integration/api/read-endpoints.md
|
|
- name: События (Kafka outbox)
|
|
href: integration/api/events.md
|
|
- name: Webhooks
|
|
href: integration/api/webhooks.md
|
|
- name: Bitemporal модель
|
|
href: integration/api/bitemporal.md
|
|
- name: Cross-references (FK)
|
|
href: integration/api/x-references.md
|
|
- name: Кэширование
|
|
href: integration/api/caching.md
|
|
- name: Ошибки и rate limits
|
|
href: integration/api/errors.md
|
|
- name: Best practices
|
|
href: integration/api/best-practices.md
|
|
- name: Bundle справочников cuod
|
|
href: integration/api/bundle-cuod.md
|
|
|
|
- name: Прикладные сценарии
|
|
items:
|
|
- name: Альтум — заказ съёмки
|
|
href: integration/altum-imaging-order.md
|
|
|
|
- name: Operations
|
|
items:
|
|
- name: Runbook (индекс)
|
|
href: ops/README.md
|
|
- name: SLO
|
|
href: ops/slo.md
|
|
- name: Outbox DLQ
|
|
href: ops/outbox-dlq.md
|
|
- name: Database migrations
|
|
href: ops/db-migrations.md
|
|
- name: Vault unseal
|
|
href: ops/vault-unseal.md
|
|
- name: Kafka restart
|
|
href: ops/kafka-restart.md
|
|
|
|
- name: Архитектура (legacy)
|
|
items:
|
|
- name: API integration (старая страница, см. /integration/api/)
|
|
href: tech/api-integration.md
|