Files
plba_v2/openspec/changes/versioned-extensible-http-api/tasks.md
T
alex d46993a092
PLBA package CI / Python tests (push) Successful in 23s
PLBA package CI / Package version increment (push) Skipped
PLBA2-4. Доработка регистрации http эндпоинтов
2026-10-11 10:44:59 +03:00

17 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Tasks
## 1. Общая маршрутизация HTTP API
- [x] 1.1 Добавить в `plba.http` типизированный descriptor `HttpRoute` и route registry: валидировать HTTP-методы и templates `/api/v{version}/...`, параметры пути, дубли и неоднозначные маршруты; покрыть проверки регистрации и сопоставления тестами `tests/test_http_routes.py`.
- [x] 1.2 Перевести `ControlApi` на общий router, зарегистрировать встроенные endpoints `/api/v1/health`, `/api/v1/runtime/start`, `/api/v1/runtime/stop`, `/api/v1/runtime/status` и принимать прикладные `HttpRoute` при создании; проверить сохранение health/lifecycle контрактов и передачу ASGI handler-у ответа и `path_params` тестами `tests/test_health_http.py` и `tests/test_http_routes.py` (`API.HTTP.CA-01`, `API.HTTP.CA-02`–`CA-06`).
- [x] 1.3 Проверить HTTP ошибки и совместную таблицу маршрутов: неизвестный путь возвращает 404 `HTTP_ROUTE_NOT_FOUND`, известный путь с неподдерживаемым методом возвращает 405 `HTTP_METHOD_NOT_ALLOWED`, конфликт регистрации отклоняется; выполнить `pytest -q tests/test_http_routes.py tests/test_health_http.py` (`API.HTTP.CA-06.FR-01`–`FR-02`).
## 2. Интеграционная документация и проверка
- [x] 2.1 Обновить `README.md` и `docs/integration.md`: описать маршруты `/api/v1/...`, пример передачи прикладных `HttpRoute` в `ControlApi`, внутренний путь сервиса и внешний `/{service-name}/api/v{version}/...`, который Caddy проксирует после удаления service-префикса; проверить примеры и ссылки в документации.
- [x] 2.2 Выполнить полный набор тестов проекта и OpenSpec-валидацию change; убедиться, что `openspec validate versioned-extensible-http-api` и тесты проходят, а старые unversioned paths больше не документируются как действующий API.
## 3. Версия пакета
- [x] 3.1 Последней задачей повысить версию `pyproject.toml` с `0.1.1` до `0.2.0` как MINOR bump для нового API и изменения публичного контракта; проверить версию через `scripts/check_package_version.py --base-ref <target-ref>`.