CamaraDosDeputados / dados-abertos

Repositório do serviço de Dados Abertos da Câmara. Consulte as "Issues" para atendimento a dúvidas e sugestões.
http://dadosabertos.camara.leg.br
198 stars 13 forks source link

Comunicação sobre atualizações nos serviços #158

Open AlessandraFernandes opened 6 years ago

AlessandraFernandes commented 6 years ago

Boa tarde!

Primeiramente gostaria de agradecer e elogiar a equipe da CD por disponibilizar este canal de comunicação, que tem se mostrado muito útil e eficaz.

Trabalho na CNI e a alguns anos consumimos informações da CD, que alimentam processos importantíssimos e essenciais para as rotinas diárias das áreas de negócio da Entidade.

O meu questionamento é a respeito das atualizações realizadas nos serviços. Tendo em vista a criticidade das informações que consumimos, pergunto se seria possível nos comunicar com antecedência sobre as mudanças realizadas nos web services. Também gostaria de saber se há ambiente de homologação disponível, para realização de testes.

Assim teremos condições de nos preparar para as mudanças e isso causaria menos impacto para nossos clientes.

Desde já, agradeço a atenção.

EquipeDadosAbertosCD commented 6 years ago

Olá, Alessandra!

O questionamento é bem válido, mesmo considerando-se que a nova API do Dados Abertos continua em alpha: ainda é esperado que haja mudanças significativas em algumas estruturas de dados e em identificadores, e dependendo da criticidade da aplicação pode ser mais seguro usar a versão anterior da API se for cabível.

Não temos um ambiente público de homologação. Outros usuários já sugeriram que a forma de desenvolvimento da nova API fosse mais transparente, mas, honestamente, nossa estrutura (duas pessoas, basicamente, eu inclusive) mal permite que tenhamos uma documentação própria das mudanças de cada atualização -- que dirá para torná-las públicas e, pior ainda, compromissos ou algo assim.

Mas estou pensando em o que poderíamos fazer para atender pelo menos a uma parte dessa demanda. Talvez termos um issue aqui, a cada atualização da API, para anunciar o que pode causar quebras na versão seguinte?

Eu também já quis publicar no portal do Dados Abertos as especificações Swagger pelas quais orientamos o desenvolvimento dos endpoints e suas respostas, mas o portal foi ao ar sem isso e acabou ficando assim por inércia. Podemos voltar a tentar implementar isso se houver interesse em saber o que vem pela frente e debater as soluções propostas.

Não sei. Você e/ou demais usuários, por favor, dêem ideias. Pode ser que algumas delas a gente consiga implementar rapidamente...

Abraço!

Fabricio Rocha Equipe Dados Abertos

henriquecoutobsb commented 6 years ago
EquipeDadosAbertosCD commented 6 years ago

Salve, moçada! Deem uma olhada no #163 .

Abraços!

Fabricio Rocha Equipe Dados Abertos - Câmara

AlessandraFernandes commented 6 years ago

Fabricio, boa tarde.

Muito obrigada pela atenção prestada aos nossos questionamentos.

Mais uma vez, parabenizo a equipe da Câmara por esta iniciativa.

Abraço.