feat(import): complete OpenAPI onboarding and verify delivery
This commit is contained in:
1 parent
bb3e376767
commit
e93de7015a
244 files changed
+57020
-5139
No files matched your search
@@ -47,6 +47,7 @@ Crank превращает REST API endpoint-ы в MCP-инструменты,
|
||||
- [Архитектура](./architecture.md)
|
||||
- [Модель данных](./data-model.md)
|
||||
- [Тестирование](./testing-strategy.md)
|
||||
- [План приёмочного тестирования всех восьми эпиков](./acceptance-test-plan.md) — сценарии, пороги и шаблоны evidence для отдельной приёмки.
|
||||
|
||||
В Inventory только статус `implemented` означает готовность. Статусы `planned`,
|
||||
`gap` и `blocked` остаются непроходными и не являются заявлением о наличии
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
{
|
||||
"kind": "inventory",
|
||||
"path": "docs/capability-inventory.json",
|
||||
"sha256": "9abb9106812cc0a82e98e39cf9646aade1355495dea737c86ee95cc6d514e2ef"
|
||||
"sha256": "83742e83715deeac32033c1b103a8e94e53d863a90203f96ed9d57521c8bb1f2"
|
||||
},
|
||||
{
|
||||
"kind": "required_surfaces",
|
||||
|
||||
@@ -841,14 +841,15 @@
|
||||
],
|
||||
"evidence": {
|
||||
"automated": [
|
||||
"apps/ui/tests/e2e/onboarding.spec.js"
|
||||
"apps/ui/tests/e2e/onboarding.spec.js",
|
||||
"apps/ui/tests/e2e/openapi-onboarding.spec.js"
|
||||
],
|
||||
"manual": [
|
||||
"docs/manual-regression-checklist.md"
|
||||
]
|
||||
},
|
||||
"id": "ui-onboarding-first-call",
|
||||
"notes": "Automated and five-participant manual evidence must be recorded against a clean revision. The manual protocol is explicitly not_run in this baseline and does not constitute a release usability pass.",
|
||||
"notes": "The OpenAPI Playwright source combines intercepted UI contracts with real-stack Auth Profile mapping and RU/EN public MCP call cases; server integration tests cover authoritative selection and private funnel properties; source presence is not a test result. Automated results and the five-participant OpenAPI protocol in docs/manual-regression-checklist.md section 5.10 must be recorded against a clean revision. Human usability evidence remains not_run until an actual eligible run; this flow remains blocked and does not constitute a usability pass.",
|
||||
"owner": "onboarding-ui-community",
|
||||
"requirements": [
|
||||
"FR-1",
|
||||
@@ -857,7 +858,7 @@
|
||||
],
|
||||
"status": "blocked",
|
||||
"type": "ui",
|
||||
"user_outcome": "A new self-hosted administrator can resume the optional Getting Started journey from manual REST Operation to an authoritative public MCP Tool call without retaining raw key material."
|
||||
"user_outcome": "A new self-hosted administrator can resume the optional Getting Started journey from a manual REST Operation or one explicitly selected OpenAPI-imported Draft to an authoritative public MCP Tool call without retaining raw key material."
|
||||
}
|
||||
],
|
||||
"product": "crank-community",
|
||||
|
||||
@@ -10,6 +10,10 @@
|
||||
- отделить автоматический baseline от ручного smoke на стенде;
|
||||
- не заставлять следующего агента заново собирать сценарии по всему проекту.
|
||||
|
||||
## Этап исполнения
|
||||
|
||||
Ручные сценарии этого checklist выполняются в отдельном приёмочном запуске. Для завершения разработки требуются готовые сценарии, fixtures/harness, пороги и шаблоны результатов, а не участие людей или внешние измерения в coding session. Единый [план приёмочного тестирования всех восьми эпиков](acceptance-test-plan.md) задаёт покрытие и порядок запуска. Реальные usability/performance/qualification outcomes остаются `not_run` до исполнения; release gates требуют фактического evidence.
|
||||
|
||||
## 2. Автоматический baseline
|
||||
|
||||
Локальный regression baseline на `2026-04-07`:
|
||||
@@ -202,6 +206,93 @@ call не более 15 минут. Незавершивший участник
|
||||
numerator публикуются раздельно. До фактического пятиучастникового запуска
|
||||
результат этого протокола остаётся `not_run`, а не `pass`.
|
||||
|
||||
### 5.10. Getting Started: ветка готового OpenAPI для пяти участников
|
||||
|
||||
Этот отдельный сценарий проверяет ветку готовой спецификации по Story 2.15.
|
||||
Он дополняет сценарий 5.9 и не заменяет его: manual REST и OpenAPI результаты
|
||||
записываются отдельно. До запуска подготовьте доступную тестовую REST-службу с
|
||||
безопасными синтетическими данными и OpenAPI-файл, соответствующий текущим
|
||||
ограничениям импорта. Все его actionable методы должны иметь проверяемый
|
||||
результат; если требуется аутентификация, заранее настройте совместимый
|
||||
workspace Auth Profile с тестовым Secret. Не используйте production credentials
|
||||
или данные. Не включайте значения Secret в файл спецификации.
|
||||
|
||||
Проведите пять независимых прогонов на свежих self-hosted установках и новых
|
||||
Admin accounts. Участникам разрешены только продукт, подготовленный файл и
|
||||
обычное MCP client окружение. До каждого прогона оператор проверяет доступность
|
||||
тестовой службы, файла и MCP client, но не показывает участнику дальнейшие шаги.
|
||||
Назначьте язык интерфейса до начала таймера (как минимум один прогон на русском
|
||||
и один на английском); не переключайте язык во время прогона. Каждый участник
|
||||
сам выполняет действия:
|
||||
|
||||
1. Откройте **Getting Started**, выберите путь OpenAPI, загрузите подготовленный
|
||||
файл и запустите preview.
|
||||
2. Осмотрите методы, findings, security requirements и предлагаемые Operations.
|
||||
Убедитесь, что blocker и unsupported findings видны. Выберите подходящую
|
||||
policy; для защищённого метода используйте совместимый Auth Profile, то
|
||||
есть только ссылку на Secret.
|
||||
3. Проверьте точный план и последствия для конфликтующих Operations, подтвердите
|
||||
Apply и осмотрите полный report. Если импорт создал несколько Drafts, явно
|
||||
выберите одну actionable Draft для продолжения. Убедитесь, что публикация не
|
||||
произошла автоматически.
|
||||
4. Обновите страницу и возобновите onboarding. Сверьте выбранную Draft и report;
|
||||
убедитесь, что повторное открытие или продолжение не создало новую версию.
|
||||
При surfaced stale/error recovery следуйте UI: перечитайте актуальные данные,
|
||||
создайте новый preview/plan при изменившемся digest и подтвердите его заново.
|
||||
Запишите фактически увиденную ошибку и восстановление; не имитируйте успешный
|
||||
recovery, если его не удалось пройти.
|
||||
5. Через обычный Operation wizard проверьте Draft, выполните test и явно
|
||||
опубликуйте Operation. Создайте Agent с этой опубликованной версией,
|
||||
опубликуйте Agent, выпустите MCP client key через one-time reveal <!-- community-scope: allow=one-time-token -->, затем
|
||||
выполните публичные `initialize`, `notifications/initialized`, `tools/list`
|
||||
и `tools/call` по показанному MCP endpoint.
|
||||
6. Завершите прогон только после подтверждения first call в authoritative
|
||||
checklist или Invocation History с Agent, key, Tool, Request ID и Trace ID.
|
||||
В процессе также проверьте refresh/resume после test, publication и создания
|
||||
key; raw key не должен повторно раскрываться.
|
||||
|
||||
Запустите таймер при первом authenticated рендере protected Admin UI и
|
||||
остановите при authoritative first call. В таблице фиксируйте только
|
||||
обезличенный label участника (`P1`–`P5`), eligibility, язык, завершение,
|
||||
длительность, наблюдённые recovery states и краткий безопасный результат. Не
|
||||
записывайте имя, email, account/workspace IDs, credentials, raw key, payload,
|
||||
исходную спецификацию, endpoint/private URL, Request ID, Trace ID или скриншоты.
|
||||
Для незавершённого eligible прогона укажите `30 min (censored)` независимо от
|
||||
момента остановки; он остаётся в denominator. Рассчитайте median по пяти
|
||||
eligible значениям времени с этим 30-минутным пределом; completion numerator
|
||||
публикуйте отдельно от eligibility denominator. Цель usability — median не
|
||||
более 15 минут. Не записывайте протокол как `pass`, если не выполнены все пять
|
||||
прогонов и цель не достигнута.
|
||||
|
||||
Перед запуском заполните идентификатор чистой ревизии и безопасные сведения о
|
||||
среде. Запись ревизии допускается только для чистой checkout без незакоммиченных
|
||||
изменений; фиксируйте фактически запущенный commit. Шаблон остаётся `not_run`,
|
||||
пока реальные значения не внесены после проведения исследования:
|
||||
|
||||
| Поле | Значение |
|
||||
|---|---|
|
||||
| Статус | `not_run` |
|
||||
| Чистая ревизия приложения | `<commit SHA>` |
|
||||
| Среда | `<self-hosted версия/тип установки; браузер и ОС без hostnames>` |
|
||||
| Eligible участников | `0 / 5` |
|
||||
| Завершившие до 30 min | `0 / 5` |
|
||||
| Длительности P1–P5 | `<not_run>` |
|
||||
| Median (censored, max 30 min) | `<not_run>` |
|
||||
| Recovery после refresh/stale/error | `<not_run>` |
|
||||
| Итог и ограничения | `<not_run>` |
|
||||
|
||||
| Участник | Eligible | Язык | Завершил | Время (max 30 min) | Refresh/recovery и результат |
|
||||
|---|---|---|---|---|---|
|
||||
| P1 | `<not_run>` | `<ru/en>` | `<not_run>` | `<not_run>` | `<not_run>` |
|
||||
| P2 | `<not_run>` | `<ru/en>` | `<not_run>` | `<not_run>` | `<not_run>` |
|
||||
| P3 | `<not_run>` | `<ru/en>` | `<not_run>` | `<not_run>` | `<not_run>` |
|
||||
| P4 | `<not_run>` | `<ru/en>` | `<not_run>` | `<not_run>` | `<not_run>` |
|
||||
| P5 | `<not_run>` | `<ru/en>` | `<not_run>` | `<not_run>` | `<not_run>` |
|
||||
|
||||
Отсутствующий участник не считается нулём: публикуйте eligibility denominator и
|
||||
completion numerator раздельно. Не подменяйте этот human run результатом
|
||||
автоматического теста или документации.
|
||||
|
||||
## 6. Protocol smoke pass
|
||||
|
||||
Для smoke-проверки MCP использовать готовый public target из [public-smoke-targets.md](public-smoke-targets.md).
|
||||
|
||||
+206
-13
@@ -2,39 +2,168 @@
|
||||
|
||||
Crank умеет импортировать REST API из OpenAPI 3.x и Swagger 2.0 документов. Импорт создает черновики MCP-инструментов, которые можно проверить и доработать в мастере операции перед публикацией.
|
||||
|
||||
## Начало работы из OpenAPI
|
||||
|
||||
В **Getting Started** можно выбрать OpenAPI как источник первой Operation. Эта
|
||||
ветка открывает тот же ограниченный импорт, что и раздел **Операции**: отдельного
|
||||
парсера для onboarding нет. После preview проверьте methods, findings, security
|
||||
references, конфликты и точное предложение плана. Устраните blockers или явно
|
||||
исключите затронутые методы согласно выбранной policy; blocker не скрывается
|
||||
переходом к частичному применению. Для security используйте совместимый Auth
|
||||
Profile и ссылку на Secret, не копируйте credential в onboarding.
|
||||
|
||||
После Apply внимательно проверьте полный import report. Apply может создать
|
||||
несколько Drafts; onboarding продолжает путь только после явного выбора одной
|
||||
актуальной actionable Draft. Никакая Operation не публикуется автоматически.
|
||||
Далее откройте выбранную Draft в обычном мастере, проверьте её contract и
|
||||
выполните test, затем отдельно опубликуйте Operation. Создайте и опубликуйте
|
||||
Agent с опубликованной версией, выпустите MCP client key и выполните первый
|
||||
публичный `tools/call` через обычный MCP client. Checklist подтверждает шаги по
|
||||
серверному состоянию; сам факт открытия страницы или возврат из import modal не
|
||||
считается завершением.
|
||||
|
||||
При refresh возобновите Getting Started и проверьте authoritative выбор Draft и
|
||||
результат импорта. Неизвестный исход Apply восстанавливайте повтором того же
|
||||
плана с исходной digest/idempotency identity. При stale plan, source correction
|
||||
или изменившемся digest создайте новый preview и заново подтвердите последствия;
|
||||
не повторяйте Apply со старым планом и не считайте локальный return context
|
||||
источником истины. Для защищённых методов проверьте, что onboarding хранит
|
||||
только Auth Profile reference и серверные идентификаторы; исходный документ
|
||||
хранится через canonical artifact flow, а secret value не включается в
|
||||
onboarding state.
|
||||
|
||||
Человеческий пятиучастниковый OpenAPI usability run и его обезличенный шаблон
|
||||
описаны в [ручном regression checklist, раздел 5.10](manual-regression-checklist.md#510-getting-started-ветка-готового-openapi-для-пяти-участников).
|
||||
Выполнение этого сценария относится к отдельной приёмке, а development done требует готового [плана всех эпиков](acceptance-test-plan.md), протокола и шаблона evidence.
|
||||
Этот сценарий описывает ожидаемый путь и требования к записи результатов; он не
|
||||
является свидетельством проведённого запуска. До реального прогона на чистой
|
||||
ревизии его статус — `not_run`.
|
||||
|
||||
## Как импортировать
|
||||
|
||||
1. Откройте раздел **Операции**.
|
||||
2. Нажмите **Импорт OpenAPI** рядом с кнопкой **Новая операция**.
|
||||
3. Загрузите ровно один UTF-8 `.yaml`, `.yml` или `.json` файл размером от 1 B до 256 KiB. Вставка текста не поддерживается.
|
||||
4. Нажмите **Разобрать документ**.
|
||||
5. Проверьте preview: сгенерированный contract сохраняет parameter locations, body formats и варианты успешного ответа.
|
||||
Preview принимает до 2 000 methods; документ с большим числом кандидатов отклоняется целиком с typed ошибкой, без скрытого усечения.
|
||||
5. Проверьте preview: сгенерированный contract сохраняет parameter locations, body formats, варианты успешного ответа и effective security requirements.
|
||||
API помечает метод `actionable`, `unresolved` или `blocked` по typed findings и доступным security choices; окончательное разрешение выбранного Auth Profile происходит при создании плана.
|
||||
6. Выберите нужные группы и методы.
|
||||
7. Проверьте `Base URL`. Если в документе нет `servers`, укажите URL вручную.
|
||||
8. Выберите поведение при конфликте имени:
|
||||
- **Создать копию с новым именем** — Crank добавит суффикс `_2`, `_3` и так далее.
|
||||
- **Пропустить** — существующие операции не будут изменены.
|
||||
9. Нажмите **Создать черновики**.
|
||||
8. Для уже существующей операции подтвердите решение отдельно: пропустить точную операцию, создать отдельную операцию с указанным вами свободным именем или добавить новую черновую версию к выбранной REST-операции. Автоматический подбор имени при применении плана не выполняется.
|
||||
9. Создайте план и проверьте число выбранных, исключённых, доступных и заблокированных методов. По умолчанию действует полный режим: любой blocker запрещает Apply всего документа. Для частичного импорта явно включите режим и выберите только методы без blocker findings с разрешёнными зависимостями и аутентификацией.
|
||||
10. Для защищённых методов выберите security alternative (OR-варианты preview; неподдерживаемые варианты, включая AND/OAuth, показаны заблокированными) и, если требуется аутентификация, совместимый Auth Profile текущего workspace — по безопасным метаданным `id/name/kind` из preview. Вариант без схем — анонимный вызов без профиля. Статус привязки показывает только API: `Unresolved` до проверки, `Resolved` после подтверждения планом, `Blocked` при отказе; UI не вычисляет resolved локально. Незакрытое обязательное требование или недоступный профиль оставляет метод заблокированным.
|
||||
11. Подтвердите план и примените его. Создание плана не меняет операции. Применение выполняет все выбранные изменения одной транзакцией и показывает результат для каждого метода.
|
||||
|
||||
## Прямые запросы к API плана
|
||||
|
||||
Все маршруты ниже имеют префикс `/api/admin/workspaces/{workspace_id}`.
|
||||
Используйте session cookie и `x-csrf-token` для POST, как описано в
|
||||
[авторизации Admin API](admin-api.md#авторизация). Идентификаторы, digest,
|
||||
ключи методов и версии берите из ответов сервера, а не вычисляйте самостоятельно.
|
||||
|
||||
После multipart preview создайте план через
|
||||
`POST /imports/openapi/{job_id}/plans`. Например, для одного анонимного метода
|
||||
без конфликта:
|
||||
|
||||
```json
|
||||
{
|
||||
"selection_mode": "partial",
|
||||
"selected_operation_keys": ["GET /pets"],
|
||||
"server_url": "https://api.example.com",
|
||||
"decisions": [{"operation_key": "GET /pets", "action": "create"}]
|
||||
}
|
||||
```
|
||||
|
||||
Ключ `GET /pets` здесь — пример; используйте точный `key` из preview.
|
||||
`full` требует полного выбора и не допускает blockers; `partial` явно исключает
|
||||
невыбранные методы. `server_url` можно не передавать, если URL получен из документа.
|
||||
Решение `rename` требует `confirmed_name`, `skip` и `new_version` — точный
|
||||
`target_operation_id`. Для защищённого метода укажите совместимый
|
||||
`auth_profile_id` и выбранный `security_alternative_index`; значения секретов
|
||||
в этих запросах не передаются.
|
||||
|
||||
Ответ содержит `plan_reference`, `plan_digest`, `catalog_revision`,
|
||||
`support_matrix_version`, `expires_at`, `selection_mode`, `counts` и `candidates`.
|
||||
Само создание плана не создаёт Draft. При повторном открытии выполните
|
||||
`GET /imports/openapi/plans/{plan_reference}` без тела запроса: ответ возвращает
|
||||
`revalidation_status` (`current` или `stale`), `revalidation_required`, `reason`,
|
||||
исходные `plan_digest`, `counts` и `candidates`. Срок действия плана ограничен
|
||||
сроком preview job; после истечения или изменения исходных условий создайте
|
||||
новый preview и подтвердите новый план.
|
||||
|
||||
Применение: `POST /imports/openapi/{plan_reference}/apply`:
|
||||
|
||||
```json
|
||||
{
|
||||
"plan_digest": "<plan_digest из ответа создания плана>",
|
||||
"idempotency_key": "import-pets-001"
|
||||
}
|
||||
```
|
||||
|
||||
Сохраните этот ключ вместе с digest до отправки. При потере ответа повторите
|
||||
тот же запрос с теми же значениями: сервер возвращает сохранённый отчёт без
|
||||
повторного создания версий. Ответ содержит `status`, `plan_id`, `plan_digest`,
|
||||
`idempotency_key`, `counts`, `outcomes` и `recovery`; проверяйте результат каждого
|
||||
метода, включая excluded/rejected. При отказе не подменяйте digest и не повторяйте
|
||||
старый план с новым ключом в надежде обойти причину отказа.
|
||||
|
||||
Чтобы продолжить Getting Started, получите актуальный `revision` через
|
||||
`GET /onboarding`, затем вызовите `POST /onboarding/import-context`:
|
||||
|
||||
```json
|
||||
{
|
||||
"application_idempotency_key": "import-pets-001",
|
||||
"plan_digest": "<тот же plan_digest>",
|
||||
"expected_revision": 1
|
||||
}
|
||||
```
|
||||
|
||||
Вместо `1` используйте текущий `revision`. Сервер возвращает `registered` и
|
||||
поля актуального onboarding, включая `revision` и `import_context` с вариантами
|
||||
выбора. Затем `POST /onboarding/select-draft` явно выбирает одну доступную Draft:
|
||||
|
||||
```json
|
||||
{
|
||||
"application_idempotency_key": "import-pets-001",
|
||||
"plan_digest": "<тот же plan_digest>",
|
||||
"operation_id": "<operation_id из применённого отчёта>",
|
||||
"operation_version": 1,
|
||||
"expected_revision": 2
|
||||
}
|
||||
```
|
||||
|
||||
Обе числовые величины здесь — примеры: возьмите версию Draft из серверного
|
||||
отчёта и revision из последнего onboarding-ответа. Ответ содержит `selected` и
|
||||
обновлённый onboarding. При конфликте revision перечитайте состояние перед
|
||||
повтором. Выбор не публикует операцию: test, publish, Agent/key и публичный
|
||||
MCP-вызов остаются отдельными шагами.
|
||||
|
||||
## Загрузка и восстановление
|
||||
|
||||
Браузер отправляет выбранный файл как `multipart/form-data`; границу multipart формирует сам браузер. Файл остаётся только в памяти текущего окна импорта. При замене файла, сбросе, закрытии окна, смене workspace/языка или уходе со страницы текущий запрос отменяется, а поздний ответ игнорируется. При `pagehide` (включая BFCache) выбранный файл и Base URL очищаются: после возврата нужно выбрать файл заново, повтор старой загрузки не предлагается.
|
||||
|
||||
Для ошибки можно выбрать файл заново или нажать **Повторить**. Диагностика показывает только ограниченные имя/размер файла и, если backend их вернул, `Request ID`/`Trace ID`; содержимое спецификации, digest, source ID и внутренние пути не выводятся. Повторное нажатие **Создать черновики** во время выполнения не создаёт вторую мутацию.
|
||||
До сохранения source snapshot импорт проверяет основной документ и загруженные allowlisted `$ref`-документы вместе, включая разрешённые ссылки. Если такая проверка находит literal credential, загрузка отклоняется; значение не попадает в artifact storage, preview или текст ошибки. Безопасные внешние ссылки сохраняются как digest-проверенные immutable snapshots и не загружаются заново при Apply.
|
||||
|
||||
## Контракт API импорта и аутентификация
|
||||
Перед разбором документ проходит ограниченную предварительную проверку без материализации YAML-aliases. Для каждого документа допуск на развёрнутые строки и ключи равен `min(16 × max(предел байтов, предел скаляра), 64 MiB)` (при значениях по умолчанию ≈4 MiB), а для набора основной документ + внешние snapshots — `min(сумма допусков, 64 MiB)`. Действуют и позлементные пределы: 256 KiB на документ, 256 KiB на скаляр/ключ, 128 aliases, 50 000 узлов, глубина 64, 10 000 элементов коллекции. Превышение возвращает контролируемую typed-ошибку предела без частичного импорта; обычные небольшие aliases, duplicate keys, non-finite значения и legacy-разбор сохраняют прежнее поведение.
|
||||
|
||||
В workspace API доступны `POST /imports/openapi/preview` (multipart upload) и `POST /imports/openapi/{job_id}/create` (JSON). Preview сохраняет effective security requirements по операциям и предлагает `auth_profile_choices`: для каждой OR-alternative он указывает индекс, имена схем, признак `supported` и только совместимые профили текущего workspace. Варианты профиля содержат ID, имя и тип; значения Secret и другие credential material не возвращаются.
|
||||
Раскрытие `$ref` в preview учитывает отдельный общий бюджет копируемых строк и ключей: `min(16 × max(предел документа, предел внешнего документа, предел скаляра), 64 MiB)` (по умолчанию ≈4 MiB). Бюджет общий для всего разрешения ссылок и не сбрасывается на каждую ссылку; превышение даёт контролируемую typed-ошибку предела до выделения памяти, а обычные документы, циклы и семантика `$ref` (включая sibling-поля OAS 3.1) не меняются.
|
||||
|
||||
При создании черновиков отправляйте `auth_mappings` с одной записью на выбранную защищённую операцию: `{ "operation_key": "GET /items", "alternative_index": 0, "auth_profile_id": "auth_…" }`. `alternative_index` начинается с нуля. Внешний список security alternatives означает OR; все схемы внутри одной alternative означают AND. Текущий runtime применяет одну Auth Profile, поэтому неподдерживаемый AND-вариант нельзя выбрать. Для явно пустой alternative можно передать `auth_profile_id: null`; отсутствие mappings остаётся совместимым для операций без security requirements. Неуказанное или unresolved required mapping блокирует создание Draft.
|
||||
Для ошибки можно выбрать файл заново или нажать **Повторить**. Диагностика загрузки показывает только ограниченные имя/размер файла и, если backend их вернул, `Request ID`/`Trace ID`; содержимое спецификации и внутренние пути не выводятся. Подтверждение плана показывает счётчики и решения по кандидатам, но не исходный документ и не учётные данные. Digest плана передаётся в Apply автоматически.
|
||||
|
||||
API принимает Bearer, Basic и API key в header/query, если соответствующая Auth Profile принадлежит текущему workspace, параметры схемы совпадают и все связанные Secrets активны с доступной current version. Cookie API key, OAuth2, OpenID Connect, mutual TLS, неизвестные схемы и несовместимые AND-варианты отображаются как unsupported и требуют ручной конфигурации. Apply повторяет проверку профиля и Secret внутри registry transaction; отсутствующие, foreign, несовместимые профили и недоступные Secrets возвращают одну sanitized ошибку без metadata профиля.
|
||||
При неизвестном результате Apply, например после разрыва соединения, повторите запрос с теми же ссылкой на план, digest и ключом идемпотентности. Повтор после commit возвращает сохранённый отчёт и не создаёт ещё одну версию; тот же ключ с другим digest даёт конфликт. Пока Apply выполняется, повторное нажатие кнопки не отправляет вторую логическую операцию.
|
||||
|
||||
Изменение требований безопасности после preview делает старый preview непригодным для применения: digest включает выбранные mapping-значения, а исходный документ повторно проверяется перед Apply. Literal credentials в поддерживаемых source locations отклоняются до сохранения upload или внешнего snapshot; ответ содержит только безопасный error code и не включает значение. Отдельный экран выбора Auth Profile в мастере относится к Story 2.11.
|
||||
Если с момента создания плана изменились источник или внешние документы, версия импортера, workspace catalog либо состояние выбранной операции, а также конфигурация выбранного Auth Profile или версия его секрета, Apply отклоняет план без частичных изменений и предлагает заново разобрать документ. Read-only `GET /api/admin/workspaces/{workspace_id}/imports/openapi/plans/{plan_id}` проверяет сохранённый план при повторном открытии и возвращает `current` или `stale` с `revalidation_required`; проверка не создаёт операции и не делает запрос к изменяемому внешнему `$ref`. Отозванный или недоступный профиль также приводит к отказу. Срок жизни плана ограничен сроком исходного preview job.
|
||||
|
||||
Новые планы `import-plan-v2` содержат source/external snapshot digests, версии normalizer/projection и support matrix, catalog revision, полный список кандидатов и selections, findings, решения по конфликтам и причины исключений. Digest вычисляется из semantic material: случайные идентификаторы plan/job/source/новой операции и время создания в него не входят. Сохранённый payload остаётся неизменяемым, а новый выбор или решение создаёт новую запись. Старые `import-plan-v1` продолжают проверяться по исходному полному digest payload.
|
||||
|
||||
Workspace catalog для revision и naming читается целиком до 10 000 записей; превышение лимита даёт ошибку вместо усечения. Revision учитывает релевантные метаданные операций, а состояние выбранных Auth Profile и Secret проверяется по безопасным snapshot-метаданным без чтения raw/ciphertext credentials. Для `import-plan-v2` предел сохранённого payload — 16 MiB при общем пределе 2 000 candidates; исторический `import-plan-v1` сохраняет свой предел 4 MiB. Запрос создания плана ограничен 16 MiB как в API, так и в веб-прокси; предел применяется только к этому маршруту и не отменяет проверки содержимого плана.
|
||||
|
||||
## Что создается
|
||||
|
||||
Для каждого выбранного метода Crank создает отдельную операцию в статусе черновика:
|
||||
Для каждого нового выбранного метода Crank создает отдельную операцию в статусе черновика. Для `new_version` новая Draft Version добавляется к точно выбранной операции; текущая опубликованная версия, прежние версии, привязки и история остаются прежними. `skip` не меняет выбранную существующую операцию. Исключённые методы не создаются, но перечисляются в отчёте.
|
||||
|
||||
Контракт нового черновика:
|
||||
|
||||
- имя инструмента берется из `operationId`, а если его нет — строится из HTTP-метода и пути;
|
||||
- отображаемое имя берется из `summary`;
|
||||
@@ -83,6 +212,70 @@ Semantic loss получает blocker с source location: такой candidate
|
||||
|
||||
Один endpoint с несколькими request formats остаётся одним Tool. Поля `content_type` и `body` выбирают одну schema и соответствующую сериализацию; неизвестный selector или body другой ветви отклоняются до отправки запроса. Для единственного формата selector не нужен. Подробный inline-file contract описан в [REST](protocols/rest.md).
|
||||
|
||||
Новые imports используют `normalized-ir-v4` / `preview-v4`. Сохранённые v2/v3 jobs воспроизводят сохранённый preview, а legacy-v1 использует отдельную историческую projection. Обновление importer не меняет inputs существующих jobs.
|
||||
Новые imports используют `normalized-ir-v5` / `preview-v6`: source-derived candidate, finding и naming conflict включают безопасный RFC 6901 `source_location`; typed findings сохраняют стабильный `code`. Схемы и маппинги принадлежат candidate с его source pointer и проверяемой provenance в IR/reference graph. Производные группы, counts и summary связаны с исходником через membership candidates; единственный pointer или finding code для такой агрегации был бы ложной provenance. Исторические v2/v3/v4/v5 jobs воспроизводят сохранённый preview, а legacy-v1 использует отдельную историческую projection. Обновление importer не меняет inputs существующих jobs.
|
||||
|
||||
Другие форматы спецификаций и протоколов в Community-импорт не входят.
|
||||
|
||||
## Проверка больших preview на Reference Deployment
|
||||
|
||||
Этот benchmark выполняется на этапе отдельной приёмки; для завершения разработки поставляются harness, параметры среды, порог и evidence template, а не фактический внешний run. Проверка включена в [единый план приёмки](acceptance-test-plan.md).
|
||||
|
||||
Локальная проверка пагинации использует mock API и измеряет только browser handler; она не подтверждает требование AC-11 о полной интерактивности ≤2 s p95. Для операторской проверки нужен отдельный Reference Deployment: Linux x86_64, сервисы с PostgreSQL 16 и Valkey 8 на 4 vCPU/8 GiB, SSD не менее 100 GB, 3000 IOPS и 100 MB/s, LAN не менее 1 Gbit/s, и отдельный эквивалентный load-generator с браузером. Перед запуском сохраните подтверждённые параметры без секретов в JSON-манифесте, например:
|
||||
|
||||
```json
|
||||
{
|
||||
"deployment": {
|
||||
"host_id": "reference-server", "cpu_model": "record actual model",
|
||||
"cpu_cores": 4, "ram_gib": 8, "postgres_version": "16.0",
|
||||
"valkey_version": "8.0", "storage_type": "SSD",
|
||||
"ssd_capacity_gb": 100, "ssd_iops": 3000,
|
||||
"ssd_throughput_mb_s": 100, "lan_mbps": 1000
|
||||
},
|
||||
"load_generator": { "host_id": "reference-runner", "cpu_cores": 4, "ram_gib": 8 },
|
||||
"browser": { "host_id": "reference-runner" }
|
||||
}
|
||||
```
|
||||
|
||||
На load-generator задайте `PLAYWRIGHT_BASE_URL` для удалённого origin, `PLAYWRIGHT_SKIP_WEB_SERVER=1`, абсолютный путь `CRANK_AC11_REFERENCE_ENV_JSON` и учётные данные через `CRANK_E2E_ADMIN_EMAIL`/`CRANK_E2E_ADMIN_PASSWORD` в окружении; затем выполните из `apps/ui`:
|
||||
|
||||
```sh
|
||||
npx playwright test tests/e2e/openapi-preview-reference.spec.js --workers=1
|
||||
```
|
||||
|
||||
Harness отправляет реальный `openapi.yaml` с 2 000 operations (157 023 B), делает warm-up и 20 независимых preview-запросов без mock routes. Каждый замер начинается при нажатии Preview и заканчивается после ответа API, разбора и отображения первой страницы с доступной кнопкой создания плана. JSON attachment/stdout сохраняет все 20 samples, p95, DOM bound и sanitized сведения об окружении. Отсутствующий URL пропускает только отдельный операторский тест; при заданном URL отсутствующий или неподходящий манифест вызывает ошибку. Сам манифест — декларация оператора; результат требует фактического запуска в указанной инфраструктуре.
|
||||
|
||||
Локальное ограниченное evidence: `cd apps/ui && npx playwright test tests/e2e/openapi-preview-partial.spec.js --grep 'AC-11' --workers=1` выводит `AC11_LOCAL_SHARED_HOST_METRICS` с сырыми samples. На shared host Linux x86_64 (Intel Core i5-4300U, 4 logical CPUs), headless Chromium 149, viewport 1280×720, mock fixture 2 000 candidates показал максимум 100 строк preview и 100 строк плана. Время ниже — длительность browser event handlers (`performance.now()`, ms), без API и LAN:
|
||||
|
||||
```json
|
||||
{
|
||||
"search_filter_ms": [7, 26, 12.7, 9.6, 5.3, 5.2, 6.5, 7.8, 5.5, 7.8, 5.6, 9.8, 8.2, 5.2, 7.9, 11.6, 6.9, 5.3, 6.6, 6],
|
||||
"preview_page_change_ms": [50.1, 30.1, 23.3, 18.8, 21.3, 24.2, 30, 20.6, 69, 23.9, 22.3, 19.5, 18.8, 20.3, 25.1, 20.8, 20.6, 21.2, 22.4, 24.8],
|
||||
"plan_page_change_ms": [2.8, 1.9, 1.9, 4.1, 2.9, 3.6, 2.9, 3.9, 2.4, 1.8, 4, 4.7, 1.9, 2, 1.7, 2.1, 1.8, 2.1, 1.7, 3.3]
|
||||
}
|
||||
```
|
||||
|
||||
## Нормативная матрица и regression corpus
|
||||
|
||||
Машинная матрица версии `1.0.3` хранится в [`crates/crank-import/tests/support-matrix.yaml`](../crates/crank-import/tests/support-matrix.yaml); corpus version — `1.0.4`. Матрица фиксирует контракт отдельно для OpenAPI 3.0, OpenAPI 3.1 и Swagger 2.0. Acceptance test запускает нормализатор на отдельном probe для каждой строки, включая все 100 успешных кодов в каждом формате, и сверяет сохранённую semantics или точный blocker; выполненные probes списываются со всех строк версии, поэтому неподвергнутая проверкой строка матрицы падает gate. Corpus version `1.0.4` — metadata-only SemVer increment для согласования manifest с неизменной matrix `1.0.3`; fixture contents и checksums не менялись. Предыдущий corpus release `1.0.3` добавил hostile fixture `hostile-security-scope.json`: document-level требование безопасности применяется только к унаследовавшему его secured candidate (`GET /secure`, location `/security/0`), а операция с явным `security: []` (`GET /public`) остаётся actionable без глобального blocker; oversized hostile JSON остаётся тем же canonical JSON с ожидаемым parser rejection.
|
||||
|
||||
| Конструкция | OpenAPI 3.0/3.1 | Swagger 2.0 | Сохраняемый контракт или finding |
|
||||
|---|---|---|---|
|
||||
| `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS` | Поддерживается | Поддерживается | Метод и исходный path переходят в Operation |
|
||||
| `path`, `query`, `header`, `cookie` параметры | Поддерживается | `path`, `query`, `header` поддерживаются; `cookie` явно unsupported | Имя, schema, required и source location сохраняются; Swagger cookie получает `unsupported_cookie_parameter` |
|
||||
| Placeholder без объявленного path parameter | Blocker | Blocker | `path_parameter_not_declared` указывает точный operation source node; path-level и operation-level declarations, включая разрешённый `$ref`, учитываются |
|
||||
| Schema defaults | Scalar сохраняется; object/array — blocker | Scalar сохраняется; object/array — blocker | `unsupported_compound_default` указывает точный `/default`; составное значение не превращается в lossy Draft |
|
||||
| JSON, urlencoded, multipart | Поддерживается | Поддерживается по `consumes`/body parameter | Schema и content type остаются частью request contract |
|
||||
| Успешные `2xx`, включая `204` | Поддерживается | Поддерживается | Каждая строка 200–299 проверяется отдельным probe; status сохраняется, а 204/205 остаются bodyless |
|
||||
| Локальные и allowlisted external `$ref` | Поддерживается | Поддерживается | Разрешение только из загруженного документа или digest-проверенного snapshot; тесты не загружают fixture по сети |
|
||||
| `allOf`, `oneOf`, `anyOf` | Поддерживается | Поддерживается | Совместимые `allOf` ветви объединяются; `oneOf` и `anyOf` остаются вариантами schema |
|
||||
| bearer/basic/API key security schemes | Поддерживается | Поддерживается для basic и API key header/query | Схемы типизируются без credential values; preview предлагает только совместимые workspace Auth Profiles с активными current secrets |
|
||||
| Security requirements с несколькими alternatives | Поддерживается | Поддерживается | Каждая OR alternative сохраняется отдельно и получает собственный список совместимых Auth Profiles; unsupported alternative не блокирует доступную соседнюю alternative |
|
||||
| Несколько schemes в одной security alternative (AND) | Blocker для этой alternative | Blocker для этой alternative | Составное требование сохраняет имена схем в finding; оно не становится actionable через single-scheme Auth Profile |
|
||||
| OAuth2, OpenID Connect, mutual TLS и неизвестные схемы | Manual configuration | Manual configuration | Явный unsupported finding; схема не извлекает token/client secret и не становится actionable автоматически |
|
||||
| security override: operation-level `security: []` | Поддерживается | Поддерживается | Явный пустой массив отключает наследование: только operations с эффективным requirement получают source-located blocker, связанные операции остаются actionable |
|
||||
| Микс public/secured operations | Поддерживается | Подвергается проверке | Blocker принадлежит только затронутому candidate; global blocker не создаётся для требований одного operation |
|
||||
| XML, `TRACE`, `CONNECT` | Unsupported | Unsupported | Source-located finding; blocker не становится actionable Draft |
|
||||
|
||||
Матрица `1.0.3` добавляет исполняемые probes обоих blockers во всех трёх форматах; coverage validation отвергает неподтверждённые source findings. Новые primary документы и external snapshots отвергают повторённые JSON/YAML mapping keys вместо last-key-wins; корректный YAML flow syntax сохраняется. HTTP(S) scheme регистронезависима, а Unicode hostname сопоставляется с punycode snapshot identity. Historical legacy v1 decoder и уже сохранённые completed reports не переписываются; новый preview с изменившейся semantics требует нового подтверждённого плана.
|
||||
|
||||
Offline corpus в `crates/crank-import/tests/corpus/` содержит 50 synthetic representative документов и hostile subset. Manifest фиксирует SHA-256 исходных файлов, canonical digest JSON, происхождение и лицензию; для representative документов он также фиксирует полный canonical preview и frozen candidates (schemas, mappings, actionable/blocker), а для hostile — ожидаемые отказы и findings. Команда `just openapi-corpus` прогоняет настоящий normalizer, сравнивает независимо перечисленные raw source pointers с canonical source tree и coverage ledger, проверяет порог 95% actionable от всех representative Operations и отдельно нулевой silent loss. Evidence связывает digest manifest и matrix, включает content digest и создаётся без перезаписи; конфликт содержимого для того же identity останавливает gate. CI прикладывает `crates/crank-import/target/openapi-corpus/evidence-<identity>.json`. Artifact не содержит загруженный исходник или значения secret-like examples.
|
||||
@@ -1,14 +1,14 @@
|
||||
{
|
||||
"schema_version": 1,
|
||||
"budget": {"logical_series": 5213, "rendered_series": 16538, "max_logical_series": 5250, "max_rendered_series": 16750},
|
||||
"budget": {"logical_series": 5563, "rendered_series": 17638, "max_logical_series": 5563, "max_rendered_series": 17638},
|
||||
"global_labels": [
|
||||
{"name": "service", "class": "process_constant", "domain": ["admin-api", "mcp-server"]},
|
||||
{"name": "version", "class": "process_constant", "domain": ["validated_release_identity"]},
|
||||
{"name": "environment", "class": "process_constant", "domain": ["validated_startup_value"]}
|
||||
],
|
||||
"metrics": [
|
||||
{"name": "crank_http_requests_total", "kind": "counter", "unit": "count", "help": "Total HTTP requests.", "processes": ["admin_api", "mcp_server"], "labels": [{"name": "route", "class": "product_closed", "domain": ["unmatched", "/health", "/ready", "/api/auth/login", "/api/auth/bootstrap/status", "/api/auth/bootstrap/complete", "/api/auth/logout", "/api/auth/session", "/api/auth/session/csrf", "/api/auth/profile", "/api/auth/password", "/api/admin/capabilities", "/api/admin/workspaces", "/api/admin/workspaces/{workspace_id}", "/api/admin/workspaces/{workspace_id}/onboarding", "/api/admin/workspaces/{workspace_id}/onboarding/events", "/api/admin/workspaces/{workspace_id}/onboarding/reset-selection", "/api/admin/workspaces/{workspace_id}/operations", "/api/admin/workspaces/{workspace_id}/imports/openapi/preview", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/create", "/api/admin/workspaces/{workspace_id}/operations/analyze-quality", "/api/admin/workspaces/{workspace_id}/operations/import", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/publish", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/archive", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/test-runs", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/input-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/output-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/drafts/generate", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/export", "/api/admin/workspaces/{workspace_id}/agents", "/api/admin/workspaces/{workspace_id}/agents/tool-search/preview", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/bindings", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/publish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/unpublish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/archive", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}/revoke", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}", "/api/admin/workspaces/{workspace_id}/auth-profiles", "/api/admin/workspaces/{workspace_id}/auth-profiles/{auth_profile_id}", "/api/admin/workspaces/{workspace_id}/upstreams", "/api/admin/workspaces/{workspace_id}/upstreams/{upstream_id}", "/api/admin/workspaces/{workspace_id}/secrets", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}/rotate", "/api/admin/workspaces/{workspace_id}/export", "/api/admin/workspaces/{workspace_id}/logs", "/api/admin/workspaces/{workspace_id}/logs/export.csv", "/api/admin/workspaces/{workspace_id}/logs/{log_id}", "/api/admin/workspaces/{workspace_id}/approvals", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/approve", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/deny", "/api/admin/workspaces/{workspace_id}/usage", "/api/admin/workspaces/{workspace_id}/usage/export.csv", "/api/admin/workspaces/{workspace_id}/usage/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/usage/agents/{agent_id}", "/v1/{workspace_slug}/{agent_slug}", "/v1/{workspace_slug}/{agent_slug}/approvals", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/approve", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/deny"]},{"name": "method", "class": "product_closed", "domain": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD", "CONNECT", "TRACE", "OTHER"]},{"name": "status_class", "class": "product_closed", "domain": ["1xx", "2xx", "3xx", "4xx", "5xx", "other"]}], "buckets_seconds": [], "max_logical_series": 4020, "max_rendered_series": 4020},
|
||||
{"name": "crank_http_request_duration_seconds", "kind": "histogram", "unit": "seconds", "help": "HTTP request duration in seconds.", "processes": ["admin_api", "mcp_server"], "labels": [{"name": "route", "class": "product_closed", "domain": ["unmatched", "/health", "/ready", "/api/auth/login", "/api/auth/bootstrap/status", "/api/auth/bootstrap/complete", "/api/auth/logout", "/api/auth/session", "/api/auth/session/csrf", "/api/auth/profile", "/api/auth/password", "/api/admin/capabilities", "/api/admin/workspaces", "/api/admin/workspaces/{workspace_id}", "/api/admin/workspaces/{workspace_id}/onboarding", "/api/admin/workspaces/{workspace_id}/onboarding/events", "/api/admin/workspaces/{workspace_id}/onboarding/reset-selection", "/api/admin/workspaces/{workspace_id}/operations", "/api/admin/workspaces/{workspace_id}/imports/openapi/preview", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/create", "/api/admin/workspaces/{workspace_id}/operations/analyze-quality", "/api/admin/workspaces/{workspace_id}/operations/import", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/publish", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/archive", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/test-runs", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/input-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/output-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/drafts/generate", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/export", "/api/admin/workspaces/{workspace_id}/agents", "/api/admin/workspaces/{workspace_id}/agents/tool-search/preview", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/bindings", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/publish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/unpublish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/archive", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}/revoke", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}", "/api/admin/workspaces/{workspace_id}/auth-profiles", "/api/admin/workspaces/{workspace_id}/auth-profiles/{auth_profile_id}", "/api/admin/workspaces/{workspace_id}/upstreams", "/api/admin/workspaces/{workspace_id}/upstreams/{upstream_id}", "/api/admin/workspaces/{workspace_id}/secrets", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}/rotate", "/api/admin/workspaces/{workspace_id}/export", "/api/admin/workspaces/{workspace_id}/logs", "/api/admin/workspaces/{workspace_id}/logs/export.csv", "/api/admin/workspaces/{workspace_id}/logs/{log_id}", "/api/admin/workspaces/{workspace_id}/approvals", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/approve", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/deny", "/api/admin/workspaces/{workspace_id}/usage", "/api/admin/workspaces/{workspace_id}/usage/export.csv", "/api/admin/workspaces/{workspace_id}/usage/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/usage/agents/{agent_id}", "/v1/{workspace_slug}/{agent_slug}", "/v1/{workspace_slug}/{agent_slug}/approvals", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/approve", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/deny"]},{"name": "method", "class": "product_closed", "domain": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD", "CONNECT", "TRACE", "OTHER"]}], "buckets_seconds": [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60], "max_logical_series": 670, "max_rendered_series": 10720},
|
||||
{"name": "crank_http_requests_total", "kind": "counter", "unit": "count", "help": "Total HTTP requests.", "processes": ["admin_api", "mcp_server"], "labels": [{"name": "route", "class": "product_closed", "domain": ["unmatched", "/health", "/ready", "/api/auth/login", "/api/auth/bootstrap/status", "/api/auth/bootstrap/complete", "/api/auth/logout", "/api/auth/session", "/api/auth/session/csrf", "/api/auth/profile", "/api/auth/password", "/api/admin/capabilities", "/api/admin/workspaces", "/api/admin/workspaces/{workspace_id}", "/api/admin/workspaces/{workspace_id}/onboarding", "/api/admin/workspaces/{workspace_id}/onboarding/events", "/api/admin/workspaces/{workspace_id}/onboarding/reset-selection", "/api/admin/workspaces/{workspace_id}/onboarding/import-context", "/api/admin/workspaces/{workspace_id}/onboarding/select-draft", "/api/admin/workspaces/{workspace_id}/operations", "/api/admin/workspaces/{workspace_id}/imports/openapi/preview", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/create", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/plans", "/api/admin/workspaces/{workspace_id}/imports/openapi/plans/{plan_id}", "/api/admin/workspaces/{workspace_id}/imports/openapi/{plan_id}/apply", "/api/admin/workspaces/{workspace_id}/operations/analyze-quality", "/api/admin/workspaces/{workspace_id}/operations/import", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/publish", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/archive", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/test-runs", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/input-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/output-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/drafts/generate", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/export", "/api/admin/workspaces/{workspace_id}/agents", "/api/admin/workspaces/{workspace_id}/agents/tool-search/preview", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/bindings", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/publish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/unpublish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/archive", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}/revoke", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}", "/api/admin/workspaces/{workspace_id}/auth-profiles", "/api/admin/workspaces/{workspace_id}/auth-profiles/{auth_profile_id}", "/api/admin/workspaces/{workspace_id}/upstreams", "/api/admin/workspaces/{workspace_id}/upstreams/{upstream_id}", "/api/admin/workspaces/{workspace_id}/secrets", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}/rotate", "/api/admin/workspaces/{workspace_id}/export", "/api/admin/workspaces/{workspace_id}/logs", "/api/admin/workspaces/{workspace_id}/logs/export.csv", "/api/admin/workspaces/{workspace_id}/logs/{log_id}", "/api/admin/workspaces/{workspace_id}/approvals", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/approve", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/deny", "/api/admin/workspaces/{workspace_id}/usage", "/api/admin/workspaces/{workspace_id}/usage/export.csv", "/api/admin/workspaces/{workspace_id}/usage/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/usage/agents/{agent_id}", "/v1/{workspace_slug}/{agent_slug}", "/v1/{workspace_slug}/{agent_slug}/approvals", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/approve", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/deny"]},{"name": "method", "class": "product_closed", "domain": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD", "CONNECT", "TRACE", "OTHER"]},{"name": "status_class", "class": "product_closed", "domain": ["1xx", "2xx", "3xx", "4xx", "5xx", "other"]}], "buckets_seconds": [], "max_logical_series": 4320, "max_rendered_series": 4320},
|
||||
{"name": "crank_http_request_duration_seconds", "kind": "histogram", "unit": "seconds", "help": "HTTP request duration in seconds.", "processes": ["admin_api", "mcp_server"], "labels": [{"name": "route", "class": "product_closed", "domain": ["unmatched", "/health", "/ready", "/api/auth/login", "/api/auth/bootstrap/status", "/api/auth/bootstrap/complete", "/api/auth/logout", "/api/auth/session", "/api/auth/session/csrf", "/api/auth/profile", "/api/auth/password", "/api/admin/capabilities", "/api/admin/workspaces", "/api/admin/workspaces/{workspace_id}", "/api/admin/workspaces/{workspace_id}/onboarding", "/api/admin/workspaces/{workspace_id}/onboarding/events", "/api/admin/workspaces/{workspace_id}/onboarding/reset-selection", "/api/admin/workspaces/{workspace_id}/onboarding/import-context", "/api/admin/workspaces/{workspace_id}/onboarding/select-draft", "/api/admin/workspaces/{workspace_id}/operations", "/api/admin/workspaces/{workspace_id}/imports/openapi/preview", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/create", "/api/admin/workspaces/{workspace_id}/imports/openapi/{job_id}/plans", "/api/admin/workspaces/{workspace_id}/imports/openapi/plans/{plan_id}", "/api/admin/workspaces/{workspace_id}/imports/openapi/{plan_id}/apply", "/api/admin/workspaces/{workspace_id}/operations/analyze-quality", "/api/admin/workspaces/{workspace_id}/operations/import", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/publish", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/archive", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/test-runs", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/input-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/samples/output-json", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/drafts/generate", "/api/admin/workspaces/{workspace_id}/operations/{operation_id}/export", "/api/admin/workspaces/{workspace_id}/agents", "/api/admin/workspaces/{workspace_id}/agents/tool-search/preview", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/versions/{version}", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/bindings", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/publish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/unpublish", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/archive", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}/revoke", "/api/admin/workspaces/{workspace_id}/agents/{agent_id}/platform-api-keys/{key_id}", "/api/admin/workspaces/{workspace_id}/auth-profiles", "/api/admin/workspaces/{workspace_id}/auth-profiles/{auth_profile_id}", "/api/admin/workspaces/{workspace_id}/upstreams", "/api/admin/workspaces/{workspace_id}/upstreams/{upstream_id}", "/api/admin/workspaces/{workspace_id}/secrets", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}", "/api/admin/workspaces/{workspace_id}/secrets/{secret_id}/rotate", "/api/admin/workspaces/{workspace_id}/export", "/api/admin/workspaces/{workspace_id}/logs", "/api/admin/workspaces/{workspace_id}/logs/export.csv", "/api/admin/workspaces/{workspace_id}/logs/{log_id}", "/api/admin/workspaces/{workspace_id}/approvals", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/approve", "/api/admin/workspaces/{workspace_id}/approvals/{approval_id}/deny", "/api/admin/workspaces/{workspace_id}/usage", "/api/admin/workspaces/{workspace_id}/usage/export.csv", "/api/admin/workspaces/{workspace_id}/usage/operations/{operation_id}", "/api/admin/workspaces/{workspace_id}/usage/agents/{agent_id}", "/v1/{workspace_slug}/{agent_slug}", "/v1/{workspace_slug}/{agent_slug}/approvals", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/approve", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}", "/v1/{workspace_slug}/{agent_slug}/approvals/{approval_id}/deny"]},{"name": "method", "class": "product_closed", "domain": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD", "CONNECT", "TRACE", "OTHER"]}], "buckets_seconds": [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60], "max_logical_series": 720, "max_rendered_series": 11520},
|
||||
{"name": "crank_http_inflight", "kind": "gauge", "unit": "count", "help": "HTTP requests currently being processed.", "processes": ["admin_api", "mcp_server"], "labels": [], "buckets_seconds": [], "max_logical_series": 1, "max_rendered_series": 1},
|
||||
{"name": "crank_mcp_requests_total", "kind": "counter", "unit": "count", "help": "Total MCP JSON-RPC requests.", "processes": ["mcp_server"], "labels": [{"name": "method", "class": "product_closed", "domain": ["initialize", "initialized", "ping", "tools_list", "tools_call", "notification", "unsupported", "response", "invalid"]},{"name": "response_mode", "class": "product_closed", "domain": ["json", "sse", "unknown"]},{"name": "outcome", "class": "product_closed", "domain": ["success", "client_error", "server_error", "jsonrpc_error", "tool_error", "aborted", "other"]}], "buckets_seconds": [], "max_logical_series": 189, "max_rendered_series": 189},
|
||||
{"name": "crank_mcp_request_duration_seconds", "kind": "histogram", "unit": "seconds", "help": "MCP JSON-RPC request duration in seconds.", "processes": ["mcp_server"], "labels": [{"name": "method", "class": "product_closed", "domain": ["initialize", "initialized", "ping", "tools_list", "tools_call", "notification", "unsupported", "response", "invalid"]},{"name": "outcome", "class": "product_closed", "domain": ["success", "client_error", "server_error", "jsonrpc_error", "tool_error", "aborted", "other"]}], "buckets_seconds": [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60], "max_logical_series": 63, "max_rendered_series": 1008},
|
||||
|
||||
@@ -208,6 +208,38 @@
|
||||
"source_digest": "abe822c967e1b2cc3966ede988e05eb2d9b2a062b539c45aaa8cad677395ab05",
|
||||
"transactional": true,
|
||||
"version": 13
|
||||
},
|
||||
{
|
||||
"backfill": {
|
||||
"kind": "none"
|
||||
},
|
||||
"checksum": "176c5b3cd12ddaf78dd0d312626a0c387f9c240a765194b34e88f7e0d3b4ca2a",
|
||||
"compatibility": "n-minus-one-readable",
|
||||
"contract_evidence": null,
|
||||
"name": "import-plan-v14",
|
||||
"owner": "crank-registry",
|
||||
"phase": "expand",
|
||||
"readable_schema_max": 14,
|
||||
"readable_schema_min": 13,
|
||||
"source_digest": "176c5b3cd12ddaf78dd0d312626a0c387f9c240a765194b34e88f7e0d3b4ca2a",
|
||||
"transactional": true,
|
||||
"version": 14
|
||||
},
|
||||
{
|
||||
"backfill": {
|
||||
"kind": "none"
|
||||
},
|
||||
"checksum": "0dbe85c649ca227f15ac141e7bf004948d3240c3495489b30e2197980ecd0c5e",
|
||||
"compatibility": "n-minus-one-readable",
|
||||
"contract_evidence": null,
|
||||
"name": "onboarding-import-selection-v15",
|
||||
"owner": "crank-registry",
|
||||
"phase": "expand",
|
||||
"readable_schema_max": 15,
|
||||
"readable_schema_min": 14,
|
||||
"source_digest": "0dbe85c649ca227f15ac141e7bf004948d3240c3495489b30e2197980ecd0c5e",
|
||||
"transactional": true,
|
||||
"version": 15
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user