PLBA2-4. Доработка регистрации http эндпоинтов
This commit is contained in:
+16
-38
@@ -1,43 +1,21 @@
|
||||
schema: function-driven
|
||||
schema: use-case-driven
|
||||
|
||||
context: |
|
||||
Актуальные спецификации проекта находятся в openspec/specs/.
|
||||
Старые документы spec/specs/ устарели и не подтверждают текущее поведение.
|
||||
Capability имеет отдельную бизнес-функцию или понятный результат и живёт
|
||||
в иерархии доменов, например orders/snapshot-sync.
|
||||
Requirement описывает одну завершённую техническую функцию.
|
||||
Формат требований определяется локальной схемой function-driven.
|
||||
Включай только сведения, влияющие на наблюдаемое поведение, устойчивый
|
||||
контракт или обязательное техническое ограничение; не добавляй повторы и
|
||||
пояснительный текст без такого влияния.
|
||||
Пиши по-русски весь пояснительный текст каждого изменения OpenSpec:
|
||||
в proposal.md, design.md, specs/**/*.md и tasks.md. Сохраняй обязательные
|
||||
заголовки и синтаксис OpenSpec, имена API, SQL-полей, кодов, файлов,
|
||||
инструментов, команд и идентификаторы без перевода.
|
||||
ADR проекта хранятся в `openspec/context/adr/`. Перед проектированием и
|
||||
реализацией прочитай применимые ADR со статусом Accepted и следуй им. Если
|
||||
запрос или предлагаемое решение конфликтует с принятым ADR, явно сообщи о
|
||||
конфликте пользователю; не обходи решение молча. Новые ADR оформляй по
|
||||
шаблону `openspec/schemas/use-case-driven/templates/adr.md` со статусом
|
||||
Proposed; не помечай решение Accepted без явного принятия владельцем решения.
|
||||
|
||||
rules:
|
||||
specs:
|
||||
- Пиши пояснительный текст спецификаций по-русски; сохраняй обязательные заголовки OpenSpec и технические идентификаторы.
|
||||
- Каждый Requirement содержит ровно один Use case. Автор выбирает полный или сокращенный формат независимо от типа FR и предмета описания.
|
||||
- Обычный FR без метки описывает логику, правила или последовательность шагов; специальные типы помечай в заголовке FR как [DB], [API] или [UI].
|
||||
- FR [DB] с таблицей БД оформляй по openspec/schemas/function-driven/patterns/database-table.md.
|
||||
- Каждый HTTP endpoint описывай отдельным Requirement с полным Use case; сложные шаги выноси в FR и связывай со сценарием.
|
||||
- Контракт endpoint помещай после FR в завершающий CONTRACT с подразделами Request и Response; не создавай для request/response отдельные FR.
|
||||
- Таблицы тела запроса и ответа в CONTRACT оформляй по openspec/schemas/function-driven/patterns/message-contract.md; для каждого поля Response указывай источник или правило формирования значения.
|
||||
- Сериализуемые контракты сообщений и технических логов описывай в FR [API] по openspec/schemas/function-driven/patterns/message-contract.md; один FR описывает одно направление.
|
||||
- Детали находятся в локально нумерованных FR за пределами Scenario; шаги ссылаются на FR.
|
||||
- Коды завершения сами передают смысл результата и связаны с FR о текстах и дальнейшем поведении.
|
||||
- Для master spec используй templates/main-spec.md выбранной схемы; для delta используй templates/spec.md.
|
||||
- Проверяй формат командой python3 openspec/schemas/function-driven/validate_format.py <spec-path>.
|
||||
proposal:
|
||||
- Сохраняй полные иерархические пути capabilities.
|
||||
- Пиши пояснительный текст proposal по-русски; сохраняй обязательные заголовки OpenSpec и технические идентификаторы.
|
||||
design:
|
||||
- Ссылайся на Requirement ID и локальные FR; описывай решения реализации без копирования требований.
|
||||
- Пиши пояснительный текст design по-русски; сохраняй обязательные заголовки OpenSpec и технические идентификаторы.
|
||||
tasks:
|
||||
- Связывай задачи с Requirement ID, FR и кодами завершения, если задача затрагивает эти результаты.
|
||||
- Пиши названия групп и формулировки задач по-русски; сохраняй команды, пути, API, коды и идентификаторы без перевода.
|
||||
- Каждый реализуемый change заканчивай отдельной последней задачей на увеличение версии пакета в pyproject.toml. Выполняй её после реализации и проверок; один change повышает версию ровно один раз.
|
||||
- До версии 1.0.0 используй PATCH для исправлений, рефакторинга и документации; MINOR для новых возможностей и любых изменений публичного контракта, включая несовместимые. Переход на 1.0.0 означает начало стабильного публичного контракта.
|
||||
- Начиная с 1.0.0 используй PATCH для исправлений, рефакторинга и документации, MINOR для обратно совместимых возможностей и MAJOR для несовместимых изменений публичного контракта.
|
||||
- >-
|
||||
Завершай каждый реализуемый change отдельной последней задачей на
|
||||
увеличение версии пакета в `pyproject.toml`; один change повышает версию
|
||||
ровно один раз. До 1.0.0 используй PATCH для исправлений, рефакторинга и
|
||||
документации, MINOR для новых возможностей и изменений публичного
|
||||
контракта, в том числе несовместимых; переход на 1.0.0 начинает стабильный
|
||||
публичный контракт. Начиная с 1.0.0 используй PATCH для исправлений,
|
||||
рефакторинга и документации, MINOR для обратно совместимых возможностей,
|
||||
MAJOR для несовместимых изменений публичного контракта.
|
||||
|
||||
Reference in New Issue
Block a user