Errores - Brein

Brein usa una misma forma JSON de error en la API REST. Decide con el code legible por máquinas, no con el message para humanos.

Forma del error

{
  "statusCode": 422,
  "code": "VALIDATION_FAILED",
  "message": "The request contains a field value the server cannot accept.",
  "request_id": "a1b2c3d4",
  "retryable": false,
  "endpoint": "POST /api/v1/workspaces/acme/..."
}

Campo	Significado
`statusCode`	Estado HTTP.
`code`	Código estable legible por máquinas.
`message`	Contexto para humanos. Puede cambiar.
`request_id`	Inclúyelo cuando pidas ayuda.
`retryable`	Indica si la misma operación puede funcionar después.
`endpoint`	Método y ruta que produjeron el error.

Códigos comunes

Estado	Significado	Qué hacer
`400`	La solicitud es inválida.	Corrige el input antes de reintentar.
`401`	Falta la key o el token, o no es válido.	Reconecta o reemplaza la credencial.
`403`	El caller está autenticado, pero no tiene permiso.	Revisa membresía y rol del workspace.
`404`	El recurso no está disponible para este caller.	Revisa el workspace y el id.
`402`	El workspace alcanzó un límite comercial.	Muestra el uso y la siguiente acción.
`409`	El recurso cambió o ya existe.	Lee el estado actual antes de reintentar.
`429`	Demasiadas solicitudes.	Espera y sigue la guía de la respuesta.
`500`	El servidor no pudo completar la solicitud.	Conserva el `request_id` al reportarlo.

Relacionado