docs: документация переведена на канон av-dev-pm 3
- роадмап отвечает «что умеет и чего не умеет»: PLAN.md → ROADMAP.md, четыре канонические секции, достигнутые звенья строками в «Готово», цели переформулированы возможностями приложения - задачи: род работы и «Затрагивает» набору спринта, 34 заголовка в форму действия, «Завершение» целей перечнями со ссылкой из каждой задачи - вычитка проходами task-form и doc-wording, починены протухшие факты в README, паспорте и review.md
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Рукописная OpenAPI-спека
|
||||
# Написать OpenAPI-спеку руками
|
||||
|
||||
- **Секция:** ядро
|
||||
- **Секция:** Ядро
|
||||
- **Зачем:** Потребителей три и один из них агент — контракт должен читаться машиной, а не пересказываться в чате
|
||||
- **Теги:** goal:read-api, sprint:2026-08-04
|
||||
|
||||
@@ -18,13 +18,15 @@
|
||||
Заодно снимает вопрос, чем быть «схеме контракта API» из раздела самоописания:
|
||||
ею и будет OpenAPI-документ, а не собственный формат.
|
||||
|
||||
Двигает строку «Завершения» цели: «Контракт чтения читается машиной».
|
||||
|
||||
## Критерии приёмки
|
||||
|
||||
- по спеке генерируется клиент, и он выполняет запрос к живому сервису — оракул:
|
||||
прогон генератора плюс запрос сгенерированным клиентом
|
||||
- спека покрывает все существующие маршруты: приём, каталог, точки, тренировки,
|
||||
записи — оракул: сверка перечня путей спеки с таблицей маршрутов в
|
||||
`docs/architecture.md`
|
||||
- спека покрывает все маршруты, которые сервис действительно регистрирует —
|
||||
оракул: сверка перечня путей спеки с обходом роутера поднятого сервиса
|
||||
(`chi.Walk`)
|
||||
- спека проходит валидатор OpenAPI 3.1 — оракул: прогон валидатора
|
||||
|
||||
## Рамки
|
||||
|
||||
Reference in New Issue
Block a user