docs: документация переведена на канон av-dev-pm 3
- роадмап отвечает «что умеет и чего не умеет»: PLAN.md → ROADMAP.md, четыре канонические секции, достигнутые звенья строками в «Готово», цели переформулированы возможностями приложения - задачи: род работы и «Затрагивает» набору спринта, 34 заголовка в форму действия, «Завершение» целей перечнями со ссылкой из каждой задачи - вычитка проходами task-form и doc-wording, починены протухшие факты в README, паспорте и review.md
This commit is contained in:
@@ -67,13 +67,17 @@ iPhone ──HTTPS POST──► healthlog ──► журнал доставо
|
||||
витрину и сверяет её отпечаток с накопленной — на живом архиве из 116 тел
|
||||
пересборка воспроизводима и повторный прогон ничего не меняет.
|
||||
|
||||
Первый маршрут чтения открыт: **каталог разрезов** (`GET /api/v1/metrics`) под
|
||||
Маршрутов чтения открыто два. **Каталог разрезов** (`GET /api/v1/metrics`) под
|
||||
токеном чтения отдаёт слои с диапазонами и измеренный род агрегации, а повтор
|
||||
неизменившегося отвечает `304` по `ETag` — снимок витрины при этом не
|
||||
открывается. Журнал WAL разбирается фоновым чекпойнтом по таймеру.
|
||||
открывается. **Точки метрики за период** (`GET /api/v1/metrics/{name}`) едут
|
||||
одним запросом: слой выбирается по охвату точек внутри периода, а род агрегации
|
||||
приезжает вместе с данными и с явным указанием, применим ли он к ряду. Журнал
|
||||
WAL разбирается фоновым чекпойнтом по таймеру.
|
||||
|
||||
Чего ещё нет: **read API точек**, тренировок и записей — сами данные наружу
|
||||
пока не отдаются. План в [docs/tasks/PLAN.md](docs/tasks/PLAN.md).
|
||||
Чего ещё нет: свёртки по сетке, условного запроса по точкам, тренировок и
|
||||
записей наружу. Что умеет и чего не умеет —
|
||||
[docs/tasks/ROADMAP.md](docs/tasks/ROADMAP.md).
|
||||
|
||||
Разведка формата закончена: 50 находок на живом потоке, половина расходится с
|
||||
документацией Health Auto Export — [docs/research/apple-health.md](docs/research/apple-health.md).
|
||||
@@ -81,7 +85,7 @@ iPhone ──HTTPS POST──► healthlog ──► журнал доставо
|
||||
## Команды
|
||||
|
||||
```
|
||||
healthlog serve приём + read API + MCP
|
||||
healthlog serve приём + read API (MCP — в планах)
|
||||
healthlog import родной экспорт Apple Health (в планах)
|
||||
healthlog reindex пересборка витрины из журнала
|
||||
healthlog uncovered перечень секций, которых разбор не покрыл
|
||||
@@ -154,7 +158,8 @@ curl -i -H 'If-None-Match: W/"…"' localhost:8080/api/v1/metrics # 304
|
||||
|
||||
Если `auth.write_tokens` пуст, проверка токена выключена — для доверенной
|
||||
локальной сети этого достаточно, сервис пишет об этом `write auth disabled`
|
||||
на старте. Для доступа снаружи понадобится и токен, и TLS — это шаг «Деплой».
|
||||
на старте. Для доступа снаружи понадобится и токен, и TLS — это цель
|
||||
«Сервис доступен телефону из любой сети».
|
||||
|
||||
|
||||
## Документация
|
||||
@@ -170,7 +175,8 @@ curl -i -H 'If-None-Match: W/"…"' localhost:8080/api/v1/metrics # 304
|
||||
- [docs/conventions/](docs/conventions/README.md) — как пишем код
|
||||
- [docs/security.md](docs/security.md) — периметр и модель угроз
|
||||
- [docs/review.md](docs/review.md) — настройка конвейера ревью и журнал дефектов
|
||||
- [docs/tasks/PLAN.md](docs/tasks/PLAN.md) — цели и обоснование их порядка
|
||||
- [docs/tasks/ROADMAP.md](docs/tasks/ROADMAP.md) — что приложение уже умеет и
|
||||
чего ещё не умеет
|
||||
- [docs/tasks/BACKLOG.md](docs/tasks/BACKLOG.md) — что брать следующим, включая
|
||||
отложенные идеи
|
||||
- [docs/research/apple-health.md](docs/research/apple-health.md) — что показал реальный поток
|
||||
|
||||
Reference in New Issue
Block a user