Páginas filhas
  • Validador Automatizado de APIs: Validações realizadas e formas de correção

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Todas as propriedades "canUpdate" dos "x-totvs" dos types devem ser do tipo boolean (true ou false). Essa verificação se fez necessária pelo fato de alguns OpenAPIs estarem especificando os campos available com strings (ex. "true"/"false"), fazendo com que a informação pudesse ser interpretada de forma equivocada.

Enum:

should be a string

A propriedade "enum" deve ser descrita como um array de strings. Um erro comum é a inserção de números ao invés de strings no array.

Required:

should have the 'required' field as an array

Dentro das "definitions", ao existir a propriedade "required", esta deve ser descrita como um array. Os types descritos nesse array serão sinalizados como obrigatórios/requeridos.

should have every 'required' element as strings

Dentro das "definitions", ao existir a propriedade "required", cada um dos elementos deste array deve ser uma string. Os types descritos nesse array serão sinalizados como obrigatórios/requeridos.

should have every element of the 'required' array as a property

Cada um dos elementos descritos dentro da propriedade "required" (caso haja) das "definitions", deve existir como um type nas "properties" desta definição.