2.7 KiB
2.7 KiB
Tasks
1. Общая маршрутизация HTTP API
- 1.1 Добавить в
plba.httpтипизированный descriptorHttpRouteи route registry: валидировать HTTP-методы и templates/api/v{version}/..., параметры пути, дубли и неоднозначные маршруты; покрыть проверки регистрации и сопоставления тестамиtests/test_http_routes.py. - 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). - 1.3 Проверить HTTP ошибки и совместную таблицу маршрутов: неизвестный путь возвращает 404
HTTP_ROUTE_NOT_FOUND, известный путь с неподдерживаемым методом возвращает 405HTTP_METHOD_NOT_ALLOWED, конфликт регистрации отклоняется; выполнитьpytest -q tests/test_http_routes.py tests/test_health_http.py(API.HTTP.CA-06.FR-01–FR-02).
2. Интеграционная документация и проверка
- 2.1 Обновить
README.mdиdocs/integration.md: описать маршруты/api/v1/..., пример передачи прикладныхHttpRouteвControlApi, внутренний путь сервиса и внешний/{service-name}/api/v{version}/..., который Caddy проксирует после удаления service-префикса; проверить примеры и ссылки в документации. - 2.2 Выполнить полный набор тестов проекта и OpenSpec-валидацию change; убедиться, что
openspec validate versioned-extensible-http-apiи тесты проходят, а старые unversioned paths больше не документируются как действующий API.
3. Версия пакета
- 3.1 Последней задачей повысить версию
pyproject.tomlс0.1.1до0.2.0как MINOR bump для нового API и изменения публичного контракта; проверить версию черезscripts/check_package_version.py --base-ref <target-ref>.