Démarrer gratuitement →

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.

Toute la référence de l’API

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:read

POST /api/v1/regression/suites

Create a regression suite

Authentification
Clé API
Portée de la clé
regression:write
Corps
name (obligatoire) · description · provider · model · cases (obligatoire)

PATCH /api/v1/regression/suites

Change a suite's name, description, provider or model

Authentification
Clé API
Portée de la clé
regression:write
Paramètres
suiteId (obligatoire)
Corps
name · description · provider · model

DELETE /api/v1/regression/suites

Delete a suite and its runs

Authentification
Clé API
Portée de la clé
regression:write
Paramètres
suiteId (obligatoire)

GET /api/v1/regression/runs

The latest regression runs, newest first

Authentification
Clé API
Portée de la clé
regression:read
Paramètres
suiteId

POST /api/v1/regression/runs

Run a suite, or compare 2 to 5 models on it

Authentification
Clé API
Portée de la clé
regression:write
Corps
suiteId (obligatoire) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (obligatoire)

GET /api/v1/regression/runs/{id}

One run, with each case's result

Authentification
Clé API
Portée de la clé
regression:read
Paramètres
id (obligatoire)

/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:read
Module
Servie là où le déploiement fait tourner FEATURE_MODEL_CHANGE_CONTROL.

POST /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:write
Module
Servie là où le déploiement fait tourner FEATURE_MODEL_CHANGE_CONTROL.
Corps
runId (obligatoire) · servedVersion · results (obligatoire)