Skip to main content

Formato do erro

A API de gestão /v1 retorna os erros como um documento de problema RFC 9457, servido com o tipo de conteúdo application/problem+json. As rotas de webhook respondem no formato configurado no trigger — consulte Erros em rotas de webhook.

Definições dos campos

  • code – O código de erro estável do Flowker. Use este campo para ramificar sua integração.
  • type – Um URI que identifica o erro. É sempre https://errors.lerian.studio/v1/ seguido do code.
  • title – A frase padrão do status HTTP de status, como Not Found ou Conflict. Ela não muda conforme o código de erro.
  • status – O código de status HTTP, repetido no corpo.
  • detail – Uma explicação legível desta ocorrência. Respostas com status 500 ou superior trazem uma mensagem genérica fixa, então use code para diferenciá-las.
  • instance – Um URI que identifica esta ocorrência específica, quando o endpoint fornece um.
  • errors – Um array opcional com 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 traz um array errors. Cada entrada identifica o dado que causou o problema.
Cada entrada traz um location (onde está o problema, como body.nodes ou path.id), um message e o value que causou o erro quando é seguro incluí-lo.

Erros em rotas de webhook

Uma rota de webhook responde no formato configurado no trigger. Uma rota de webhook JSON retorna um objeto de erro compacto com o tipo de conteúdo application/json:
  • code – O código de erro estável do Flowker, retirado das tabelas abaixo. Baseie as ramificações da sua integração neste campo.
  • title – A frase de status HTTP correspondente ao status da resposta, como Not Found ou Payload Too Large.
  • message – Uma explicação legível desta ocorrência.
Uma rota de webhook XML retorna um documento <error> em vez disso, porque toda a rota trabalha em XML.
O elemento code traz um código do Flowker das tabelas abaixo ou um dos 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ções


Esses erros são retornados quando a requisição à API não atende aos requisitos de validação.

Erros de entidade


Erros de workflow


Erros de condição de workflow


Esses erros são retornados quando o objeto condition estruturado de um node falha na validação ao criar ou atualizar o workflow.

Erros de catálogo, executors e triggers


Erros de configuração de executor


Erros de configuração de provider


Erros de configuração de provider OpenAPI externo


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

Erros de vínculo de schemas de provider


Erros de execução de workflows


Erros de requisições de saída


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

Erros de concorrência


Erros de webhook


Erros de contrato de trigger de webhook


Esses erros são retornados ao salvar o input_contract de um trigger de webhook, ao ativar o workflow, ou ao validar uma carga recebida contra ele.

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


Erros de schemas XSD


Erros de schemas OpenAPI externos


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

Erros do registro de especificações OpenAPI


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

Erros de ocorrências agendadas