AI CodeOps

AI CodeOps API'si

Bugün programatik olarak neleri çağırabilirsiniz: bir çalışma alanı API anahtarıyla CI için yayın kapısı kontrolü ve herkese açık kanıt paketi anahtarları. API, betada sınırlıdır.

AI CodeOps tarayıcıda kullanılır. Açık beta süresince programatik API bilinçli olarak küçüktür: CI için bir uç nokta ve herkesin bir kanıt paketini kontrol etmesini sağlayan açık anahtarlar. Konsoldaki diğer her şey giriş yapılmış bir tarayıcı oturumu gerektirir ve desteklenen bir API değildir.

Çalışma alanı API anahtarları

Configure → API Keys altında bir anahtar oluşturun. Ona bir ad verin; secret (sk- ile başlar) yalnızca bir kez gösterilir, o yüzden o anda kopyalayın. AI CodeOps yalnızca bir özet (hash) saklar.

  • Bir anahtar, onu oluşturan üye olarak ve o üyenin güncel rolüyle hareket eder. Üye çıkarılırsa veya rolü bir izni kaybederse anahtar da o izni kaybeder.
  • Owner, Admin, Developer ve Member rolleri anahtar oluşturabilir. Viewer rolü oluşturamaz.
  • Admin rolündekiler çalışma alanındaki her anahtarı görür; diğerleri kendi anahtarlarını görür.
  • Delete bir anahtarı hemen iptal eder. Onu kullanan entegrasyonlar anında çalışmayı bırakır.

Planınız anahtar kapsamı sınırlamayı içeriyorsa bir Admin Scope seçeneğiyle bir anahtarı bir IP izin listesiyle (CIDR aralıkları), dakika başına bir istek limitiyle, bir son kullanma tarihiyle ve ne için kullanılabileceğiyle sınırlayabilir: model gateway çağrıları, yayın kapısı kontrolü veya her ikisi (varsayılan).

Anahtarı bir Bearer token olarak gönderin:

Authorization: Bearer sk-...

Yayın kapısı kontrolü

POST /api/release/check, CI'ınız için tek bir soruyu yanıtlar: bu pull request veya commit yayına alınabilir mi? Değişikliğe dokunan her oturum genelinde kalite kapılarıyla aynı kontrolleri uygular. Anahtarın workspace:read iznine ihtiyacı vardır.

curl -sf -X POST "https://console.aicodeops.dev/api/release/check" \
  -H "Authorization: Bearer $WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pullRequestURL":"https://github.com/acme/api/pull/42"}'

Konsolu açtığınız adresle aynı adresi kullanın. CI'da yayın kapısı sayfasında GitHub Actions, GitLab CI, Bitbucket Pipelines ile Forgejo ve Gitea Actions için kopyalanacak işler bulunur.

İstek alanları

AlanTürVarsayılan
pullRequestURLURLbu ikisinden biri zorunludur
commitSHAstring, 7+ karakter
blockingSeveritycritical, high, medium, low, infohigh
blockOnTestFailureboolean: başarısız testler engeller; test sonucu olmayan bir kod değişikliği de engellertrue
blockOnBuildFailureboolean: geçmeyen bir repo build'i engellertrue
minCoveragePct0–100 arası sayı: bir kapsam alt sınırı; kapsam bildirilmediyse reddederkapıya dahil değil
requiredWorkflowsstring dizisiyok
disallowedLicensesstring dizisi, projenin SBOM'una göre kontrol ediliryok
requireDeployedToortam adı; örn. stagingyok
blockOnInFlightboolean: bir çalıştırma hâlâ sürerken reddederfalse
lookbackMsne kadar geriye bakılacağı, milisaniye cinsinden14 gün
workspaceIDçalışma alanı kimliği: yalnızca bir konsol oturumuyla çağırdığınızdaAPI anahtarının çalışma alanı

GET /api/release/check, aynı adları sorgu parametreleri olarak kabul eder (listeler virgülle ayrılır).

Test kanıtı. Varsayılan olan blockOnTestFailure açıkken, bir projede kodu değiştiren her oturumun sayıları içeren bir test sonucuna ihtiyacı vardır. Onun için hiçbir test çalışmadıysa veya test komutu çalışıp test sayısı bildirmediyse kontrol reddeder: "The test command ran but reported no test counts, so nothing shows a test passed. Check the project's test command". Kanıt yokluğu, geçti anlamına gelmez. Test paketi olmayan bir proje için projenin ayarlarında Don't run tests for this project seçeneğini açın (ayarlar Plan → Projects altındadır); kontrol bu durumda test sonucu istemez. Kural, kod değiştirmeyen bir oturuma veya "blockOnTestFailure": false gönderdiğinizde de uygulanmaz.

Kapsam alt sınırı. minCoveragePct ayarlandığında, kapsam bildiren en son test çalıştırması bunu karşılamalıdır. Değişiklik üzerindeki hiçbir test çalıştırması kapsam bildirmediyse kontrol reddeder: "Coverage wasn't reported, so the 80% floor can't be checked". Kontrol edilemeyen bir alt sınır geçmez. Bir alt sınır belirlemeden önce projenin test komutunun bir kapsam özeti yazdırmasını sağlayın. minCoveragePct alanını belirtmezseniz kapsam kapıya dahil edilmez.

Bir konsol oturumuyla çağırma. Bir API anahtarı çalışma alanını taşır; dolayısıyla CI workspaceID göndermez. Giriş yapılmış bir konsol oturumu da uç noktayı çağırabilir ve çalışma alanını belirtmek zorundadır: URL'ye ?workspaceID=<id> ekleyin veya bir POST isteğinin JSON gövdesine workspaceID koyun. Bu olmadan yanıt 400 olur. Kimlik, konsolun adresinde /workspace/ kısmından sonra gelen bölümdür.

Yanıt

Uç nokta her iki sonuç için de 200 döndürür. allowed alanını okuyun:

  • allowed: true veya false
  • summary ve reasons: düz İngilizce açıklamalar
  • blockingFindings, testFailures, testEvidenceMissing, coverageShortfall, coverageNotReported, licenseViolations, licenseEvidenceMissing: bir reddin arkasındaki ayrıntılar (licenseEvidenceMissing, disallowedLicenses gönderdiğinizde kontrol edilecek SBOM'u olmayan projeleri listeler)
  • testEvidenceMissing: kodu değiştiren ve sayıları içeren bir test sonucu olmayan her oturum için bir { "workflowRunID", "reason" }; eksik bir şey yoksa boş bir liste
  • coverageNotReported: bir alt sınır belirlediğinizde ve hiçbir test çalıştırması kapsam bildirmediğinde { "required": 80 }; bir kapsam sayısı varsa veya alt sınır belirlenmemişse null
  • runsConsidered: kararın dayandığı oturumlar

Eşleşen oturumu olmayan bir değişiklik reddedilir ("No workflow runs found for …"). Yukarıda Test kanıtı altında anlatıldığı gibi, test sonucu olmayan bir kod değişikliği de reddedilir. Değerlendirme başarısız olursa "Evaluation failed" özetiyle allowed: false alırsınız; böylece bozuk bir kontrol asla bir değişikliği geçirmez.

Hatalar

DurumAnlamı
400Geçersiz JSON veya geçersiz alanlar. Bir konsol oturumuyla: workspaceID eksiktir ve mesaj bunu söyler
401API anahtarı ve konsol oturumu yok ya da anahtar geçerli değil
403Anahtarın kapsamı veya onu oluşturanın rolü buna izin vermiyor ya da anahtar başka bir çalışma alanına ait. Bir oturumla: çalışma alanının üyesi değilsiniz
429Çalışma alanı için dakikada 60'tan fazla kontrol; bkz. Retry-After

Aynı kontrol konsolda Review & Gate → Release gate altında, kopyalanacak bir CI işiyle birlikte bulunur.

Kanıt paketi anahtarları

GET /api/evidence?action=keys herkese açıktır ve anahtar gerektirmez. Kanıt paketlerini imzalayan Ed25519 açık anahtarlarını döndürür; böylece bir paketi çevrimdışı doğrulayabilirsiniz. Bir paketi indirmek için denetim erişimi olan, giriş yapmış bir üye gerekir; bir API anahtarıyla kullanılamaz.

API referansı

Her uç nokta için bir sayfa; OpenAPI spesifikasyonundan üretilmiştir:

Sonraki adımlar

Sık sorulan sorular

Oturumlar ve projeler için tam bir REST API var mı?

Henüz hayır. Açık beta süresince oturum çalıştırmanın ve projeleri yönetmenin yolu konsoldur. Bu sayfadaki uç noktalar, programatik erişimi kabul edenlerdir.

API anahtarlarının süresi dolar mı?

Varsayılan olarak hayır. Bir anahtar silinene, onu oluşturan kişi çalışma alanından ayrılana veya kapsamında ayarlanmış bir son kullanma tarihi geçene kadar çalışır.

Bu sayfa yardımcı oldu mu?