Breaking Change na API do TabNews sobre o objeto "Content"
Turma, tudo bem?
Gostaria de oficialmente anunciar uma breaking change na API do TabNews e antecipar outra que provavelmente estará por vir antes de oficializarmos a primeira versão estável dela, então vou separar o que vai acontecer em dois tópicos:
1) Breaking Change no objeto content
Como anunciado na publicação de melhorias, iremos renomear um campo no objeto content
que é a propriedade username
. Ela será renomeada para owner_username
, pois é o username do dono do conteúdo, e não o username do conteúdo. Isto é uma alteração semântica para que as propriedades façam um par melhor, por exemplo:
owner_id
owner_username
parent_username
Neste exato momento, as propriedades username
e owner_username
estão sendo retornadas ao mesmo tempo no objeto content
. Veja um exemplo ao vivo disso clicando aqui.
Mas a partir do dia 19 de Agosto, a propriedade username
não estará mais disponível no objeto content
e apenas irá permanecer a propriedade owner_username
. Dado a isso, sugerimos que quem esteja utilizando a API do TabNew já mude a integração para utilizar a propriedade owner_username
por já estar pública.
Caso queira acompanhar o progresso desta implementação, acompanhe essa issue*
2) Breaking Change na propriedade strategy
(RFC)
Hoje o endpoint /api/v1/contents
aceita 3 tipos de estratégia:
Estratégia | Descrição |
---|---|
/api/v1/contents?strategy=best | Ordena pelos conteúdos mais relevantes. |
/api/v1/contents?strategy=new | Ordena dos conteúdos mais novos para os mais antigos. |
/api/v1/contents?strategy=old | Ordena dos conteúdos mais antigos para os mais novos. |
Mas o nome da estratégia best
não acredito ser o melhor e deveríamos mudar o nome para relevant
, pois não são os melhores conteúdos e sim os mais relevantes para aquele momento. Isto fará um par muito melhor lá no menu principal superior, pois poderíamos colocar os itens Relevantes e Recentes.
Fora que a estratégia best
poderia ser usada para ordenar as publicações apenas pelas tabcoins
para um dia em específico. Por exemplo, mostrar qual foi a publicação mais popular do dia X
.
O que acham?
⚠️ O repositório Open Source do TabNews ainda está em Modo Privado. Caso queira receber um convite para participar, leia esta publicação.