Abrasel-Nacional / docs

https://abrasel-nacional.github.io/docs/
Apache License 2.0
11 stars 4 forks source link

[QUIQ] Remoção da Obrigatoriedade de campos de Descrição em entidades de Cardápio #96

Closed Gregcjni closed 2 years ago

Gregcjni commented 2 years ago

Olá,

Me chamo Gregory e faço parte do setor de engenharia da empresa Quiq.

Estou abrindo esta Issue para questionarmos a obrigatoriedade dos campos Description e Disclaimer na entidade Menu, nos "Merchant Endpoints" como segue-se na imagem abaixo.

image

Acreditamos que em algumas vezes realmente há a necessidade de uma descrição para um cardápio, porém há vezes em que já subentende-se o objetivo do cardápio sem que seja necessária uma descrição, como por exemplo "Almoço";

Além disso, temos também o campo descrição como obrigatório na entidade "Categories", onde em nossa percepção temos o mesmo problema: Há vezes em que se faz necessária uma descrição, mas outras vezes o título da categoria já é clara o suficiente, como "Yakisobas", por exemplo.

image

Há o mesmo cenário também no campo de descrição da entidade "Option Groups", onde muitas vezes um grupo de opcionais já tem um nome que torna clara a informação, como "Bebida" dentro de um item.

image

Por isso, gostaríamos de indicar que estes campo se tornassem opcionais e não obrigatórios.

Obs.: Sobre o campo Disclaimer, o conceito está pouco descrito na documentação, mas pelo que nos passa, não parece ser um dado obrigatório na entidade de Menus, por isso incluímos dentro desta mesma Issue.

Obrigado!

gui-camargo commented 2 years ago

Olá @Gregcjni ,

Muito obrigado pelas sugestões. Vamos leva-las para conversar no comite.

Sobre as descrições dos campos, vou deixa-las mais claras na documentação. A questão do Disclaimer é justamente para uma descrição mais completa, e pode ser colocado questões como por exemplo questão da dieta (como itens veganos ou gluten-frre) ou questões alergicas, etc. Mas o texto é livre.

Apenas para lembrar, como já fizemos o lançamento da versão 1.0.0 de cardápios e pedidos, as próximas atualizações irão entrar num cronograma de releases, a ser ainda divulgado.

gui-camargo commented 2 years ago

Solicitação será incluída na próxima versão.

gui-camargo commented 2 years ago

Olá @Gregcjni,

As obrigatoriedades foram retiradas na versão 1.0.1. Documentação já está atualizada.