Commit Graph

5 Commits

Author SHA1 Message Date
Zimin A.N. f3c3e33289 docs(cheatsheet): добавить конкретные примеры с реальными dicts
После Postman demo audit — в cheatsheet не хватало живых примеров,
которые можно скопировать и сразу проверить. Добавил:

* FK-зависимость:
  GET /dictionaries/satellite_type/dependents →
  [{sourceDict: spacecraft, sourceField: satellite_type_code,
    onClose: BLOCK, activeRecordsInSourceDict: 14}]
  + список других живых FK на staging (ground_station, country etc).

* Локализация записи через Accept-Language:
  ru: НАСА / Глобальный мониторинг суши и атмосферы
  en: NASA / Global land and atmosphere monitoring
  + warning что ?locale= игнорируется и schema endpoint вообще
  не локализуется.

* Time-travel: 14.05.2026 12:00 → 200, 14.05.2026 00:00 → 404
  record_not_active (ожидаемое поведение, не bug).

* History и changelog/diff живые примеры с test1.

Также убрал password-grant из Auth (используется client_credentials —
это правильный flow для server-to-server интеграторов). И добавил
dependents проверку в 60-second smoke.
2026-05-20 11:52:04 +03:00
Zimin A.N. ee4f495973 docs(api): уточнение — locale работает только на records, не на schema
Tested: GET /dictionaries/spacecraft с Accept-Language: en-US возвращает
schemaJson с descriptions на ru (defaultLocale). Header игнорируется на
этом endpoint.

Локализация (Accept-Language header) работает только на records-side
(read-api DictionaryReadController). DictionaryDefinitionController
(writer/ordinis-app) возвращает schema без locale negotiation.

Cheatsheet обновлён, добавлен warning в query-params секцию.
2026-05-20 11:46:41 +03:00
Zimin A.N. 11b6ca9835 docs(api): локализация — только Accept-Language header (не ?locale= query)
После testing на staging выявлено: backend парсит локаль ТОЛЬКО из
Accept-Language header. ?locale=en-US query param сейчас игнорируется
(сервер возвращает default ru-RU вне зависимости от значения).

Реальный demo (spacecraft/1999-068A):
  default (без header):           operator: "НАСА"
  Accept-Language: en-US:         operator: "NASA"
  ?locale=en-US (без header):     operator: "НАСА"  ← не работает

Cheatsheet + quickstart обновлены. Postman collection тоже (используется
header). ?locale= query — отдельный backend feature request в roadmap.
2026-05-20 11:40:19 +03:00
Zimin A.N. ae05e17f96 docs(api): cheatsheet + quickstart sync с реальным API после Postman audit
Audit Postman collection выявил расхождения docs ↔ runtime — фикс:

Topology clarification:
- Records (consumer) — БЕЗ /dictionaries/ префикса: /api/v1/{name}/records
- History/cascade-preview/changelog/drafts — С /dictionaries/ (writer audit)
- export-selected.csv — POST, не GET

Query params (records list, /{name}/records):
-  as_scope (required, CSV) — было документировано как ?scope= (неверно)
-  at (ISO timestamp) — было ?asOf= (неверно)
-  locale + Accept-Language header
-  bbox / polygon (geo)
-  убраны: ?limit, ?offset (pagination отсутствует),
            ?status/?country (нет ad-hoc filtering по schema полям)

Snapshots params:
-  from / to / granularity (hour/day/week) — было ?asOf= (неверно)

Base URLs:
- prod: ordinis.nstart.cloud (public LE-cert)
- staging: ordinis.k8s.265.nstart.cloud (Swagger UI здесь)
- было: ordinis.k8s.264.nstart.cloud (устаревший internal, prod переехал)

Version: v2.36 → v2.37.x.

Refs MR !242 (snapshots backend fix), Postman collection в
~/Desktop/Ordinis-Postman/.
2026-05-19 23:15:40 +03:00
Александр Зимин 04e8251941 docs(api): Quick Start guide + Cheat Sheet для интеграторов 2026-05-17 13:14:33 +00:00