Pular para o conteúdo

Toda a documentação para desenvolvedores

RSS e JSON Feed para o seu changelog

Todo changelog do Changeloop também é um feed que dá para assinar, em RSS 2.0 e JSON Feed 1.1, e um único documento Markdown. Esta página cobre os endpoints, os filtros que eles compartilham com o feed JSON e o que cada formato leva.

RSS e JSON Feed

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/rss.xml
GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/feed.json

As mesmas entradas publicadas como um feed assinável, nos dois formatos que os leitores entendem: RSS 2.0 e JSON Feed 1.1. Ambos aceitam os mesmos filtros repos, category e tag do feed de changelog e carregam o mesmo Cache-Control e ETag. Nenhum pagina: um leitor consulta o topo do feed, então retornam apenas as entradas mais recentes, sem cursor.

O texto da entrada é o HTML sanitizado, envolvido em CDATA para RSS e como content_html para JSON Feed, com as suas imagens dentro dele depois que você ativa as imagens. A imagem de cabeçalho de uma entrada é um elemento media:content no RSS e a imagem do item no JSON Feed. O JSON Feed também carrega as cores das suas tags sob uma extensão com namespace _changelogapp; o RSS não, porque nenhum leitor as pintaria.

A página hospedada anuncia ambos como links rel="alternate", então um navegador ou leitor que chegue nela pode se inscrever sem que os caminhos sejam informados.

O feed de markdown

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/changelog.md

As mesmas entradas publicadas como markdown simples, servido como text/markdown. Existe para leitores que não são navegadores: um LLM ou um agente respondendo "o que mudou recentemente neste produto" recebe o texto sem precisar analisar RSS ou percorrer JSON. Aceita os mesmos filtros repos, category e tag do feed de changelog, carrega o mesmo Cache-Control e ETag, e responde 304 a uma solicitação condicional exatamente como os outros dois.

Cada entrada é uma seção: o título como cabeçalho, depois uma única linha com a data, a categoria e quaisquer tags, depois a imagem de cabeçalho como uma linha de imagem em markdown, se a entrada tiver uma de um host da sua lista, depois o texto da entrada, depois o link Learn more se a entrada tiver um, depois seu link permanente. O documento abre com o título e a descrição do seu feed e leva de volta à página hospedada. Quando nada foi publicado ainda, diz isso em uma frase em vez de retornar um corpo vazio, então um leitor consegue distinguir isso de uma busca falha.

O sitemap

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/sitemap.xml

Um sitemap de um único changelog, para mecanismos de busca: a página do changelog e o link permanente de cada entrada publicada, nos endereços que seus leitores veem, que ficam no seu próprio domínio depois que você configura um em Configurações, Domínio próprio. O lastmod de uma entrada é a data em que ela foi publicada, e o da página é a data da sua entrada mais recente. Ele lista as 1000 entradas mais recentes, não aceita filtros, carrega o mesmo Cache-Control e ETag dos feeds, e responde 304 a uma solicitação condicional.

Um mecanismo de busca não encontra esse arquivo sozinho, e só aceita um sitemap para páginas do host que serve o arquivo, ou quando o arquivo é enviado para aquele site. Então envie este endereço no seu console de busca, para o domínio em que seu changelog está.

O feed de changelog

Suas entradas publicadas, da mais nova para a mais antiga, com o ID mais recente desempatando carimbos de data/hora idênticos.

Um changelog que dá para assinar

O Changeloop escreve cada entrada a partir de um pull request mesclado, guarda para sua revisão e publica ao mesmo tempo no feed JSON, em RSS, em JSON Feed e em Markdown. Grátis para um repositório, sem cartão.

Começar grátis

Ler a documentação para desenvolvedores