Add OpenStack request-body schemas and nested console PARAM sync.

2026-07-18 08:47:38 +03:00
parent cbd0adca91
commit ae297258b1
46 changed files with 42717 additions and 40135 deletions
@@ -2,32 +2,74 @@

 # Web UI

-URL консоли (Compose по умолчанию): [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
+Интерактивная консоль: обзор операций контракта Engine, лабораторные токены,
+Try-it запросы и управление seed-данными.

-UX ящиков совпадает с другими лабораторными симуляторами этого семейства:
+URL по умолчанию (Compose): [http://127.0.0.1:5000/](http://127.0.0.1:5000/)  
+(При `make up-local` — локальный UI-порт из `.env`, например `6080` / `7080`.)
+
+![Консоль](../images/web-ui/console.png)
+
+## Рабочая область

 | Область | Назначение |
 |---|---|
-| Auth | Выдача лабораторных токенов / показ principal |
-| API catalog | Обзор операций контракта активного series |
-| Coverage | Сводка покрытия pack / handlers |
-| Help | Краткие заметки оператора |
-| Data | Reseed `minimal` / `demo` |
-| Environment | Активный series, runtime-подсказки, hot-swap **Apply pack** |
+| Выбор endpoint | Поиск по путям контракта (series pack Engine) |
+| Вкладки методов | `GET` / `POST` / `PUT` / `DELETE` для выбранного пути |
+| Request body | JSON-пример в форме Engine для create/update/action |
+| Params | Плоские path/body-поля для быстрых правок |
+| Response | Статус + JSON-дерево последнего ответа |
+| History | Недавние Try-it запросы (повтор / восстановление) |
+
+![Ящик Endpoints](../images/web-ui/endpoints.png)
+
+![POST /vms с телом в форме Engine](../images/web-ui/request-body.png)
+
+![Параметры запроса](../images/web-ui/request-params.png)
+
+Тела запросов соответствуют соглашению Engine (root-wrapper сущности или
+`action`). В примерах — вложенные ссылки (`cluster`, `template`, CPU topology,
+storage domains) под seed-инвентарь лаборатории, а не однополевой stub.
+
+![History](../images/web-ui/history.png)
+
+## Ящики (drawers)
+
+| Ящик | Назначение |
+|---|---|
+| Authentication | SSO password grant / вставка Bearer-токена |
+| API catalog | Обзор series packs; **Apply as runtime** — hot-swap |
+| Help → Compatibility | Сводка declared / implemented / verified |
+| Data | Reseed `minimal` / `small` / `large` / `big` |
+| Environment | Runtime series + обзор инвентаря datacenter |
+
+![Authentication](../images/web-ui/authentication.png)
+
+Лабораторные учётки: `admin@internal`, `ops@internal`, `developer@internal`,
+`demo@internal` / `secret`. Scope: `ovirt-app-api`.
+
+![API catalog](../images/web-ui/api-catalog.png)
+
+![Help / compatibility](../images/web-ui/help-compatibility.png)
+
+![Пресеты Data](../images/web-ui/data.png)
+
+![Environment](../images/web-ui/environment.png)

 ## Hot-swap series

-Из Environment (или UI API):
+Из **API catalog** → **Apply as runtime** (или UI API):

 - `POST /ui/api/ovirt/contracts/activate` с `{"series":"4.4"}`
 - `POST /ui/api/contract/apply?major=N`

 Перемонтирует in-memory контрактные маршруты без пересборки образа. Рестарт
-процесса возвращает cold-start значение `OVIRT_SERIES`. См.
-[Версии API](api-versions.md).
+процесса возвращает cold-start `OVIRT_SERIES`. См. [Версии API](api-versions.md).

-Брендинг: oVirt blue `#0076B6` и charcoal `#1D2226`.
+## Заметки

-UI обращается к тому же процессу симулятора, что и Engine API; отличается только
-опубликованный listener ([ports.md](ports.md)). Схема OpenAPI:
-[http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs) (также на порту Engine).
+- Брендинг: oVirt blue `#0076B6` и charcoal `#1D2226`.
+- UI ходит в тот же процесс симулятора, что и Engine API; отличается только
+  опубликованный listener ([порты](ports.md)).
+- OpenAPI: [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs)
+  (также на HTTPS-порту Engine).