# JSON Schema validation

{% hint style="info" %}
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/](https://json-schema.org/). Essa fonte é essencial para compreender a estrutura e a validação de dados JSON de maneira padronizada.
{% endhint %}

{% tabs %}
{% tab title="Parâmetros" %}

<div data-full-width="true"><figure><img src="/files/EC0JGxDY5HQufx3NDXL9" alt="" width="371"><figcaption><p>Parâmetros de configuração</p></figcaption></figure></div>

<table><thead><tr><th width="177">Campo</th><th width="144.66666666666666" align="center">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>Descrição</td><td align="center">Campo de texto</td><td>Descrição visual do conector na construção do fluxo.</td></tr><tr><td>Conteúdo JSON</td><td align="center">Campo de texto</td><td>Conteúdo em forma de string ou o caminho do conteúdo, dentro do objeto msg, que servirá como entrada para validação.</td></tr><tr><td>JSON Schema</td><td align="center">Campo de texto</td><td>Campo para definir o esquema de validação de um JSON de entrada.</td></tr><tr><td>Nível de validação</td><td align="center">Seletor</td><td>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.</td></tr><tr><td>Output Path</td><td align="center">Campo de texto</td><td>Refere-se ao caminho do resultado da validação na saída do conector no contexto de execução do fluxo</td></tr></tbody></table>
{% endtab %}

{% tab title="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.&#x20;

<table data-column-title-hidden data-view="cards" data-full-width="true"><thead><tr><th>Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>isValid</strong></td><td>Valor booleano, <code>true false</code>, indicando sucesso ou falha na validação.</td></tr><tr><td><strong>errors [ ]</strong></td><td>Um array com os atributos property que indica qual propriedade está apresentando erro e o message, que oferece detalhes sobre a validação. </td></tr></tbody></table>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdQbRIYhK7JQPlbw5VBeDMGmNVGvGJOmdQjFl7zBFXz7AWvy-etyUFT-E9toOTMNxHHnQ-_okvWogll2h5WMcAI68hqohzhU8HWNrDie0a315mxos8Mzfj5wFKZ28TSfGnPAt_WCg?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Retorno da validação do Schema</p></figcaption></figure>

## 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.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfIOJqgMxURIeYi_MUW-BrVpzt7lq838ovVlZDpA5vhUT6INqj7j1ZqM0vcvoMhTKa37m2f-pJE8elsiKRJ9RoAK_fb-Cb4ng1r9OS6i7UsecbWnkMQ_hC-QHH4D8zBtawEKAA1WA?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Visão completa da validação do Schema</p></figcaption></figure>

<table data-column-title-hidden data-view="cards"><thead><tr><th>Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>instance </strong><mark style="color:blue;"><strong>{ }</strong></mark></td><td>Representa a instância do conteúdo JSON que está sendo validada.</td></tr><tr><td><strong>schema </strong><mark style="color:blue;"><strong>{ }</strong></mark></td><td>Refere-se ao esquema JSON usado para validar a instância. Ele define as regras e restrições que a instância deve seguir.</td></tr><tr><td><strong>options </strong><mark style="color:blue;"><strong>{ }</strong></mark></td><td>Pode conter opções ou configurações adicionais que foram fornecidas durante o processo de validação.</td></tr><tr><td><strong>path </strong><mark style="color:orange;"><strong>[ ]</strong></mark></td><td>Indica o caminho dentro do documento JSON onde o erro foi encontrado. Caso esteja vazio, indica que o erro ocorreu na raiz do documento.</td></tr><tr><td><strong>propertyPath</strong></td><td>Indica a propriedade específica do objeto que causou o erro.</td></tr><tr><td><strong>disableFormat</strong></td><td>Pode indicar se a formatação dos dados foi desativada durante o processo de validação.</td></tr><tr><td><strong>errors </strong><mark style="color:orange;"><strong>[</strong></mark><strong> </strong><mark style="color:blue;"><strong>{ }</strong></mark><strong> </strong><mark style="color:orange;"><strong>]</strong></mark></td><td>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.</td></tr></tbody></table>

## 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.

<table data-column-title-hidden data-view="cards"><thead><tr><th>Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>path </strong><mark style="color:orange;"><strong>[ ]</strong></mark> </td><td>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.</td></tr><tr><td><strong>property</strong></td><td>O nome da propriedade onde o erro aconteceu. No exemplo caso de exemplo o valor “instance” representa todo o objeto.</td></tr><tr><td><strong>message</strong></td><td>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.</td></tr><tr><td><strong>schema </strong><mark style="color:blue;"><strong>{ }</strong></mark></td><td>O schema JSON usado para validar o objeto. No caso, está configurado com "type": "array", causando o erro.<br>instance: O valor real que está sendo validado.</td></tr><tr><td><strong>instance</strong></td><td>O valor real que está sendo validado.</td></tr><tr><td><strong>name</strong></td><td>O tipo de erro encontrado. Neste caso, "type".</td></tr><tr><td><strong>argument </strong><mark style="color:orange;"><strong>[ ]</strong></mark></td><td>Um array contendo o(s) tipo(s) esperado(s). Neste caso, ["array"], indica que a validação esperava um array.</td></tr><tr><td><strong>stack</strong></td><td>Mensagem de erro completa.</td></tr></tbody></table>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdAtGosjKu2xeIHsQDEclc7LPgYnsKTJAq4wuQmAAJKwzI2QIRecmWjyQZBgz6P33xyDbyxzq4sZSUeg8av12Nn6yFfSsus2p5_-P3a3evNAgkw_Bfwjp6toJoKrnMSw4S0HekeiA?key=yLogrgEbXy0K_a4zmB9ApgKO" alt=""><figcaption><p>Propriedades do array errors</p></figcaption></figure>

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.floui.io/guia/conectores/categorias/manipulacao-de-dados/json-schema-validation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
