Referencia de la API
Pruebas y cambios de modelo
Gestionar las suites de regresión y ejecutarlas, o comparar modelos en una; leer las ejecuciones de conjuntos de referencia que esperan a tu sistema cuando cambia un modelo, y enviar sus resultados.
Los resúmenes de las rutas y los nombres de los campos están en inglés, aquí y en el archivo.
/api/v1/regression
GET /api/v1/regression/suites
The workspace's regression suites
Autenticación
Clave API
Ámbito de la clave
regression:readRespuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:writeCuerpo
name (obligatorio) · description · provider · model · cases (obligatorio)Respuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:writeParámetros
suiteId (obligatorio)Cuerpo
name · description · provider · modelRespuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:writeParámetros
suiteId (obligatorio)Respuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:readParámetros
suiteIdRespuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:writeCuerpo
suiteId (obligatorio) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (obligatorio)Respuestas
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
Autenticación
Clave API
Ámbito de la clave
regression:readParámetros
id (obligatorio)Respuestas
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)
Autenticación
Clave API
Ámbito de la clave
usecases:readMódulo
Disponible donde el despliegue ejecuta
FEATURE_MODEL_CHANGE_CONTROL.Respuestas
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
Autenticación
Clave API
Ámbito de la clave
usecases:writeMódulo
Disponible donde el despliegue ejecuta
FEATURE_MODEL_CHANGE_CONTROL.Cuerpo
runId (obligatorio) · servedVersion · results (obligatorio)Respuestas
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