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.

...

should contain xtotvs/productinformation as an array inside 'paths'

A propriedade "productInformation", dentro da "x-totvs" dos "paths", deve ser do tipo array.

should contain 'product' as a key in productInformation, inside 'paths'

Dentro da propriedade "productInformation", da "x-totvs" dos "paths", deve existir a propriedade "product".

should contain 'available' inside productInformation, inside 'paths'

Dentro da propriedade "productInformation", da "x-totvs" dos "paths", deve existir a propriedade "available".

all products declared inside 'info' should also exist inside 'paths' x-totvs

Todos os produtos que forem declarados no "productInformation" da "info" do OpenAPI devem estar presentes em pelo menos um dos "x-totvs" dos "paths". Essa verificação se faz necessária pois não há sentido em se declarar um produto na "info" do OpenAPI quando não há nenhum endpoint implementado para aquele produto.

all 'available' properties must be boolean

Todas as propriedades "available" dos "x-totvs" dos "paths" devem ser do tipo boolean. 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.

info:

should have 'product' in the correct pattern

...