...
Esta verificação serve para garantir que não haja nenhum caracter do tipo "�", configurando um problema de enconding. Para corrigir, verifique seu arquivo OpenAPI e ajuste as ocorrências desses caracteres.
Verifique o encode do arquivo (Deve ser UTF-8).
...
As propriedades "url" e "variables" devem existir dentro da propriedade "servers". Para corrigir este erro, ajuste o arquivo OpenAPI de modo que exista a propriedade "servers", com suas respectivas propriedades "url" e "variables".
A URL descritas dentro da propriedade "url" (dentro de "servers") deve iniciar com o valor "{{host}}". Isso é importante para que o site consiga fazer substituições desse placeholder por ambientes para sandbox.
As URLs A URL descritas dentro da propriedade "url" (dentro de "servers") devem cumprir as regras da seguinte expressão regular: /(?:.*)\/api\/(?:.*)\/v[0-9]*$/ . Um erro comum é a adição desnecessária de uma barra ("/") ao final da URL. Corrija a URL do servidor para que o erro pare de ser apontado.
...
Informações |
---|
De acordo com o versionamento semântico, somente trabalhamos com versões menores enquanto não existe quebra de contrato. Quando a quebra de contrato se faz necessária, é preciso subir uma versão maior. 2.000 -> 2.001 100 : Subindo versão menor 2.000 -> 3.000 : Subindo versão maior |
...
O OpenAPI deve utilizar responses padronizadas para casos de erros (ErrorModel, ErrorModelBase e ErrorDetail). Maiores informações podem ser encontradas no nosso Guia de Implementação de Integrações.
A propriedade "x-totvs" deve existir em todos os "paths".
A propriedade "productInformation" , deve existir dentro da de "x-totvs" dos "paths", e deve ser do tipo array.
...
Para endpoints de arquivos binários, é obrigatório que o schema siga a seguinte estrutura (Com "type": "string" e "format":"binary") (https://swagger.io/docs/specification/describing-request-body/file-upload/)
...