Référence de l’API
Tests et changements de modèle
Gérer les suites de non-régression et les exécuter, ou y comparer des modèles ; lire les exécutions de jeux de référence qui attendent votre système quand un modèle change, et en envoyer les résultats.
Les résumés des routes et les noms des champs sont écrits en anglais, ici comme dans le fichier.
/api/v1/regression
GET /api/v1/regression/suites
The workspace's regression suites
Authentification
Clé API
Portée de la clé
regression:readRéponses
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
Authentification
Clé API
Portée de la clé
regression:writeCorps
name (obligatoire) · description · provider · model · cases (obligatoire)Réponses
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
Authentification
Clé API
Portée de la clé
regression:writeParamètres
suiteId (obligatoire)Corps
name · description · provider · modelRéponses
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
Authentification
Clé API
Portée de la clé
regression:writeParamètres
suiteId (obligatoire)Réponses
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
Authentification
Clé API
Portée de la clé
regression:readParamètres
suiteIdRéponses
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
Authentification
Clé API
Portée de la clé
regression:writeCorps
suiteId (obligatoire) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (obligatoire)Réponses
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
Authentification
Clé API
Portée de la clé
regression:readParamètres
id (obligatoire)Réponses
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)
Authentification
Clé API
Portée de la clé
usecases:readModule
Servie là où le déploiement fait tourner
FEATURE_MODEL_CHANGE_CONTROL.Réponses
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
Authentification
Clé API
Portée de la clé
usecases:writeModule
Servie là où le déploiement fait tourner
FEATURE_MODEL_CHANGE_CONTROL.Corps
runId (obligatoire) · servedVersion · results (obligatoire)Réponses
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