TrueSight

Documentation hub

Build with TrueSight

Документация для интеграций, API reference, changelog и рабочих сценариев Data Sync. Один раздел для разработчиков, аналитиков и команд внедрения.

API families 12
Guides 64
Schema contracts 38
Search refresh 15 min

API Reference

Endpoint catalog

Reference-раздел описывает публичные методы, заголовки, payload structure и expected responses для синхронизации данных и документационных коллекций.

POST /v1/data/sync/

HeadersContent negotiation, request ids, idempotency keys.

ResponsesSuccess envelopes, retryable errors and validation reports.

VersionsStable, preview and deprecated contract markers.

docs.sync.request.json v1 
{
  "collection": "api-reference",
  "version": "2026.06",
  "mode": "incremental",
  "documents": [
    {
      "slug": "data-sync/overview",
      "hash": "sha256:..."
    }
  ]
}

Guides

Рабочие сценарии

01

Quickstart

Подключить первый source, отправить sync batch и проверить результат публикации.

02

Schema validation

Настроить проверку структуры документов, frontmatter и ссылочных якорей.

03

Search metadata

Синхронизировать теги, подсказки, aliases и индексацию документации.

04

Changelog publishing

Вести release notes, migration entries и сообщения об изменениях API.

05

Version migration

Планировать переход между версиями контрактов без разрыва интеграций.

06

Operational runbooks

Описывать проверки, rollback steps и реакции на задержки публикации.

Schemas

Контракты документации

Collection Version Mode State
api-reference 2026.06 incremental active
guides 2026.06 content batch active
changelog 2026.06 append only active
search-index 2026.06 metadata watch

SDK notes

Примеры подключения

curl 
curl -X POST https://docs.truesight.store/v1/data/sync/ \
  -H "Content-Type: application/json" \
  -d @docs-sync.json
Node.js 
await client.docs.sync({
  collection: "guides",
  mode: "incremental"
});
Python 
client.docs.sync(
    collection="api-reference",
    mode="incremental",
)

Changelog

Последние обновления

  1. Sync endpoint reference updated

    Added collection-level examples and payload validation notes.

  2. Search metadata guide

    Documented aliases, tags and anchor normalization.

  3. Changelog contract

    Append-only release entry format is now marked stable.

Quality gates

Перед публикацией

Links Проверка внутренних ссылок, anchors и redirect targets.
Contracts Сверка examples с текущими JSON schemas и response envelopes.
Search Нормализация заголовков, тегов, aliases и коротких описаний.

Publishing sync

Состояние публикации

Content intakeoperational
Reference buildoperational
Search indexoperational
Publish queuewatch