JSON Schema validation

Realiza a validação da estrutura de um JSON a partir de um JSON Schema configurado no conector.

Para obter informações detalhadas e referências sobre o JSON Schema, recomendamos acessar a documentação oficial disponível em https://json-schema.org/. Essa fonte é essencial para compreender a estrutura e a validação de dados JSON de maneira padronizada.

Parâmetros

Parâmetros de configuração

Campo	Tipo	Descrição
Descrição	Campo de texto	Descrição visual do conector na construção do fluxo.
Conteúdo JSON	Campo de texto	Conteúdo em forma de string ou o caminho do conteúdo, dentro do objeto msg, que servirá como entrada para validação.
JSON Schema	Campo de texto	Campo para definir o esquema de validação de um JSON de entrada.
Nível de validação	Seletor	Define o nível de complexidade da saída da validação. Ao optar por Simplificada retornará um campo booleano true/false e a mensagem de erro de acordo com a validação. Ao selecionar Completa, irá retornar informações adicionais na saída do conector.
Output Path	Campo de texto	Refere-se ao caminho do resultado da validação na saída do conector no contexto de execução do fluxo

Payload

Visão simplificada

Na visão simplificada, será retornado o campo isValid,, e em casos de erro, irá também retornar um array errors.

isValid

Valor booleano, true false, indicando sucesso ou falha na validação.

errors [ ]

Um array com os atributos property que indica qual propriedade está apresentando erro e o message, que oferece detalhes sobre a validação.

Retorno da validação do Schema

Visão completa

A visão completa permite ter acesso, em um único objeto JSON, a todas as propriedades validadas pela biblioteca JSON Schema Validation, além de atributos adicionais como a instância do objeto original que foi validado.

Visão completa da validação do Schema

instance { }

Representa a instância do conteúdo JSON que está sendo validada.

schema { }

Refere-se ao esquema JSON usado para validar a instância. Ele define as regras e restrições que a instância deve seguir.

options { }

Pode conter opções ou configurações adicionais que foram fornecidas durante o processo de validação.

path [ ]

Indica o caminho dentro do documento JSON onde o erro foi encontrado. Caso esteja vazio, indica que o erro ocorreu na raiz do documento.

propertyPath

Indica a propriedade específica do objeto que causou o erro.

disableFormat

Pode indicar se a formatação dos dados foi desativada durante o processo de validação.

errors [ { } ]

Lista de objetos que representam os erros encontrados durante a validação. Cada objeto na lista contém informações detalhadas sobre um erro específico.

Propriedades do array errors [ {} ]

O array errors, na visão completa, apresenta todos os campos relacionados ao erro encontrado na validação. Segue um exemplo de erro na validação, e a descrição dos campos.

path [ ]

Um array que representa o caminho até a propriedade onde o erro ocorreu. Neste caso, está vazio ([]), indicando que o erro está na raiz do objeto.

property

O nome da propriedade onde o erro aconteceu. No exemplo caso de exemplo o valor “instance” representa todo o objeto.

message

Mensagem do erro. No caso "instance is not of a type(s) array" indica que a instância deveria ser um array, mas é um objeto.

schema { }

O schema JSON usado para validar o objeto. No caso, está configurado com "type": "array", causando o erro. instance: O valor real que está sendo validado.

instance

O valor real que está sendo validado.

name

O tipo de erro encontrado. Neste caso, "type".

argument [ ]

Um array contendo o(s) tipo(s) esperado(s). Neste caso, ["array"], indica que a validação esperava um array.

stack

Mensagem de erro completa.

Propriedades do array errors