REST (OpenAPI)
Control plane Engineering API sözleşmesi el yazımıdır ve depoda docs/api/openapi.yaml olarak tutulur. Derleme bu dosyayı siteye kopyalar; çalışan control plane GET /api/v1/openapi.yaml ile sunar.
Dosya
- openapi.yaml (bu sitede)
- Canlı sunucu:
http://127.0.0.1:8080/api/v1/openapi.yaml
Etkileşimli tarayıcı
API explorer’ı aç — Scalar; aynı origin’deki openapi.yaml dosyasını yükler.
Yerelde: npm run docs:dev sonra /api-explorer.html.
Ortak kurallar
| Konu | Davranış |
|---|---|
| Auth | Bearer oturum veya API token (vion_at_*) |
| Hata zarfı | code, message, correlationId, details |
| Correlation | Yanıt başlığı x-correlation-id |
| Eşzamanlılık | Kaynak yazmada expectedVersion; çakışma 409 |
| Setup | x-vion-setup-token (kurulum modu) |
OpenAPI’da tag’ler yoktur (~63 path / ~79 operasyon). Runtime canlı uçları için Runtime HTTP.