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 have 'product' in the correct pattern

A propriedade "productInformation" deve ser um array de objetos. Além disso, a propriedade "product" deve existir dentro da "productInformation" do "x-totvs" da info. Essas verificações se fizeram necessárias pois, em convenções anteriores de desenvolvimento de especificações de API, os produtos eram declarados como objetos, tendo o nome do produto como chave.

segment name should be standardized

Para evitar inconsistência no armazenamento e visualização de nossas APIs, a grafia do campo "segment" deve estar de acordo com padrões previamente determinados. Para saber qual a grafia correta do segmento que deseja declarar, visite a lista de referências do portal de APIs e verifique no menu lateral (sob o título "Agrupadores") os padrões de grafia aceitos.

product name should be standardized

Para evitar inconsistência no armazenamento e visualização de nossas APIs, a grafia do campo "product" deve estar de acordo com padrões previamente determinados. Para saber qual a grafia correta do produto que deseja declarar, visite a lista de referências do portal de APIs e verifique no menu lateral (sob o título "Produtos") os padrões de grafia aceitos.

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

Todos os produtos que forem declarados no "productInformation" dos "paths" do OpenAPI devem estar presentes também no "x-totvs" da "info". 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.


Schemas:

Filename:

should start with uppercase letter

...