Mensagens de erro
Exemplos das mensagens de erro ou validações retornadas pela API e quais são.
As respostas retornadas pela API apresentam o seguinte padrão de resposta:
1
{
2
"errors": { ... },
3
"data": { ... }
4
}
Copied!
Porém o atributo errors somente é retornado quando ocorre alguma excessão na requisição.
Quando um erro de query inválida em GraphQL acontece, as excessões são semelhantes ao exemplo abaixo: (Ao deixar de enviar um valor para name, que é obrigatório na especificação da query)
1
{
2
"errors": [
3
{
4
"message": "Variable \"$folder\" got invalid value {\"name\":null}; Expected non-nullable type String! not to be null at value.name.",
5
"extensions": {
6
"category": "graphql"
7
},
8
"locations": [
9
{
10
"line": 1,
11
"column": 31
12
}
13
]
14
}
15
]
16
}
Copied!
A seguir, temos um exemplo de erro comum, ao buscar uma pasta inexistente:
1
{
2
"errors": [
3
{
4
"message": "folder_not_found",
5
"extensions": {
6
"category": "graphql"
7
},
8
"locations": [
9
{
10
"line": 2,
11
"column": 3
12
}
13
],
14
"path": [
15
"folder"
16
]
17
}
18
],
19
"data": {
20
"folder": null
21
}
22
}
Copied!
E também temos erros de validação (quando o atributo "message" possui o valor "validation"), criando uma pasta definindo o valor de string vazio:
1
{
2
"errors": [
3
{
4
"message": "validation",
5
"extensions": {
6
"category": "graphql"
7
},
8
"locations": [
9
{
10
"line": 2,
11
"column": 3
12
}
13
],
14
"path": [
15
"createFolder"
16
],
17
"validation": {
18
"folder.name": [
19
"field_required"
20
]
21
}
22
}
23
],
24
"data": {
25
"createFolder": null
26
}
27
}
Copied!
No seguinte exemplo, também temos um erro de validação, porém com variáveis, que acontece ao definir um nome muito curto para uma pasta:
1
{
2
"errors": [
3
{
4
"message": "validation",
5
"extensions": {
6
"category": "graphql"
7
},
8
"locations": [
9
{
10
"line": 2,
11
"column": 3
12
}
13
],
14
"path": [
15
"createFolder"
16
],
17
"validation": {
18
"folder.name": [
19
{
20
"must_be_at_least": {
21
"min": 3
22
}
23
}
24
]
25
}
26
}
27
],
28
"data": {
29
"createFolder": null
30
}
31
}
Copied!

Erros de validação

Por último, segue um JSON com todas as possíveis mensagens de erro ou de validação que podem ser retornadas pela API, junto com o que cada uma delas significa e possíveis variáveis entre chaves (Ex: {{variavel}}). Lembrando que não incluem erros de query GraphQL.
1
{
2
"unauthorized": "Você não está mais autenticado",
3
"document_not_found": "Documento não encontrado",
4
"folder_not_found": "Pasta não encontrada",
5
"document_signed": "O documento já foi assinado",
6
"not_your_turn": "Não é a sua vez de assinar o documento",
7
"must_be_a_string": "É somente permitido texto",
8
"must_be_an_array": "Não é uma lista",
9
"not_a_valid_date": "Não é uma data válida",
10
"must_be_a_valid_email_address": "Não é um email válido",
11
"must_be_a_file": "Não é um arquivo",
12
"failed_to_upload": "Erro ao enviar o arquivo",
13
"could_not_upload_file": "Não foi possível enviar o arquivo",
14
"field_required": "Este campo é obrigatório",
15
"unavailable_credits": "Os seus créditos esgotaram",
16
"may_not_be_greater_than": "Não pode ter mais que {{max}} caracteres",
17
"must_be_at_least": "Não pode ter menos que {{min}} caracteres",
18
"format_is_invalid": "O formato do campo está incorreto",
19
"invalid_date": "Não é uma data válida",
20
"without_permission": "Você precisa ser um administrador da organização para executar esta ação.",
21
"must_be_a_valid_file": "Somente são permitidos arquivos com as extenções {{extensions}}",
22
"not_a_member_of_organization": "Você precisa ser um membro da mesma organização para executar esta ação."
23
}
Copied!
Last modified 1yr ago
Copy link