مرجع واجهة API
الاختبارات وتغييرات النماذج
إدارة مجموعات اختبارات الانحدار وتشغيلها، أو مقارنة نماذج عليها؛ وقراءة عمليات مجموعات المرجع التي تنتظر نظامك عند تغيّر نموذج، وإرسال نتائجها.
ملخصات المسارات وأسماء الحقول مكتوبة بالإنجليزية، هنا وفي الملف.
/api/v1/regression
GET /api/v1/regression/suites
The workspace's regression suites
المصادقة
مفتاح API
نطاق المفتاح
regression:readالإجابات
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/v1/regression/suites
Create a regression suite
المصادقة
مفتاح API
نطاق المفتاح
regression:writeالجسم
name (إلزامي) · description · provider · model · cases (إلزامي)الإجابات
201 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 regression_suite_limit_exceeded · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 429 · 500 internal_error · 503 service_unavailablePATCH /api/v1/regression/suites
Change a suite's name, description, provider or model
المصادقة
مفتاح API
نطاق المفتاح
regression:writeالمعاملات
suiteId (إلزامي)الجسم
name · description · provider · modelالإجابات
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/regression/suites
Delete a suite and its runs
المصادقة
مفتاح API
نطاق المفتاح
regression:writeالمعاملات
suiteId (إلزامي)الإجابات
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs
The latest regression runs, newest first
المصادقة
مفتاح API
نطاق المفتاح
regression:readالمعاملات
suiteIdالإجابات
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailablePOST /api/v1/regression/runs
Run a suite, or compare 2 to 5 models on it
المصادقة
مفتاح API
نطاق المفتاح
regression:writeالجسم
suiteId (إلزامي) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (إلزامي)الإجابات
202 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs/{id}
One run, with each case's result
المصادقة
مفتاح API
نطاق المفتاح
regression:readالمعاملات
id (إلزامي)الإجابات
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailable/api/v1/reference-sets
GET /api/v1/reference-sets/pending
The reference-set runs waiting for your system (model change control)
المصادقة
مفتاح API
نطاق المفتاح
usecases:readالوحدة
متاح حيث يشغّل النشر
FEATURE_MODEL_CHANGE_CONTROL.الإجابات
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 409 capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailablePOST /api/v1/reference-sets/receipts
Post the results of a reference-set run your system ran
المصادقة
مفتاح API
نطاق المفتاح
usecases:writeالوحدة
متاح حيث يشغّل النشر
FEATURE_MODEL_CHANGE_CONTROL.الجسم
runId (إلزامي) · servedVersion · results (إلزامي)الإجابات
200 · 400 validation_failed, unknown_case, duplicate_case · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 run_not_found · 409 run_not_awaiting_client, capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailable