Skip to main content

Formato de erro

A API de gestão /v1 retorna erros como um documento de problema RFC 9457, servido com o content type application/problem+json. As rotas de webhook respondem no formato configurado do seu trigger. Veja Erros em rotas de webhook.

Definições de campo

  • code – O código de erro estável do Flowker. Baseie sua integração nesse campo.
  • type – Uma URI que identifica o erro. É sempre https://errors.lerian.studio/v1/ mais o code.
  • title – A frase-padrão de motivo HTTP para status, como Not Found ou Conflict. Não muda por código de erro.
  • status – O código de status HTTP, repetido no corpo.
  • detail – Uma explicação legível por humanos dessa ocorrência. Respostas com status 500 ou acima carregam uma mensagem genérica fixa, então use code para diferenciá-las.
  • instance – Uma URI que identifica essa ocorrência específica, quando o endpoint fornece uma.
  • errors – Um array opcional de entradas por campo. Veja Detalhes de erro por campo.

Detalhes de erro por campo

Quando uma requisição falha na validação de campos específicos, o documento de problema carrega um array errors. Cada entrada nomeia a entrada com problema.
Cada entrada carrega uma location (onde está o problema, como body.nodes ou path.id), uma message, e o value com problema quando é seguro reproduzi-lo.

Erros em rotas de webhook

Uma rota de webhook responde no formato configurado do seu trigger. Uma rota de webhook JSON retorna um objeto de erro compacto com o content type application/json:
  • code – O código de erro estável do Flowker, obtido nas tabelas abaixo. Baseie sua integração nesse campo.
  • title – A frase-padrão de motivo HTTP para o status da resposta, como Not Found ou Payload Too Large.
  • message – Uma explicação legível por humanos dessa ocorrência.
Uma rota de webhook XML retorna um documento <error> em vez disso, porque toda a rota funciona em XML.
O elemento code carrega um código do Flowker das tabelas abaixo ou um de dois códigos específicos de XML:

Erros gerais


Esses erros se aplicam a todos os endpoints da API do Flowker.

Erros de validação de requisição


A API retorna esses erros quando a requisição não atende aos requisitos de validação.

Erros de entidade


Erros de workflow


Erros de condição de workflow


A API retorna esses erros quando o objeto condition estruturado de um nó falha na validação durante a criação ou atualização do workflow.

Erros de catálogo, executor e trigger


Erros de configuração de executor


Erros de configuração de provedor


Erros de configuração de provedor OpenAPI externo


Esses erros se aplicam a configurações de provedor do tipo external_openapi, que chamam uma operação declarada por um schema OpenAPI armazenado.

Erros de vínculo de schema de provedor


Erros de execução de workflow


Erros de requisição de saída


Esses erros ocorrem enquanto um nó chama um serviço externo. Eles aparecem como falhas de nó nos detalhes da execução.

Erros de concorrência


Erros de webhook


Erros de contrato de trigger de webhook


A API retorna esses erros quando você salva o input_contract de um trigger de webhook ou ativa o workflow. Ela também os retorna durante a validação de um payload recebido contra o contrato.

Erros de requisição e configuração de OpenAPI externo


Erros de schema XSD


Erros de schema OpenAPI externo


Esses erros se aplicam aos schemas OpenAPI que você armazena por tenant e referencia a partir de triggers, configurações de provedor e nós.

Erros de registro de spec OpenAPI


Esses erros se aplicam ao registro compartilhado de specs OpenAPI, que fixa a versão da spec que o Flowker usa para enriquecer os schemas de saída de um serviço.

Erros de ocorrência agendada