Saltar al contenido

Toda la documentación para desarrolladores

RSS y JSON Feed para tu changelog

Cada changelog de Changeloop es también un feed al que suscribirse, en RSS 2.0 y JSON Feed 1.1, y un único documento Markdown. Esta página cubre los endpoints, los filtros que comparten con el feed JSON y lo que lleva cada formato.

RSS y 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

Las mismas entradas publicadas como feed suscribible, en los dos formatos que entienden los lectores: RSS 2.0 y JSON Feed 1.1. Ambos aceptan los mismos filtros repos, category y tag que el feed del changelog y llevan el mismo Cache-Control y ETag. Ninguno pagina: un lector consulta la cabeza del feed, así que estos devuelven solo las entradas más recientes, sin cursor.

El texto de la entrada es el HTML saneado, envuelto en CDATA para RSS y como content_html para JSON Feed, con tus imágenes dentro una vez que hayas activado las imágenes. La imagen de cabecera de una entrada es un elemento media:content en RSS y la imagen del item en JSON Feed. JSON Feed lleva además los colores de tus etiquetas bajo una extensión con espacio de nombres _changelogapp; RSS no, porque ningún lector los pintaría.

La página alojada anuncia ambos como enlaces rel="alternate", así que un navegador o lector que llegue allí puede suscribirse sin que le digan las rutas.

El feed en markdown

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

Las mismas entradas publicadas como markdown plano, servido como text/markdown. Existe para lectores que no son navegadores: un LLM o un agente que responde qué ha cambiado recientemente en este producto recibe el texto sin analizar RSS ni recorrer JSON. Acepta los mismos filtros repos, category y tag que el feed del changelog, lleva el mismo Cache-Control y ETag, y responde 304 a una petición condicional igual que los otros dos.

Cada entrada es una sección: el título como encabezado, luego una sola línea con fecha, categoría y etiquetas, luego la imagen de cabecera como una línea de imagen en markdown si la entrada tiene una de un host de tu lista, luego el texto de la entrada, luego el enlace Learn more si la entrada tiene uno, luego su permalink. El documento empieza con el título y la descripción de tu feed y enlaza de vuelta a la página alojada. Si aún no hay nada publicado, lo dice en una frase en vez de devolver un cuerpo vacío, para que quien lea pueda distinguirlo de un fallo de conexión.

El sitemap

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

Un sitemap de un solo changelog, para buscadores: la página del changelog y el permalink de cada entrada publicada, en las direcciones que ven tus lectores, que están en tu propio dominio cuando has configurado uno en Ajustes, Dominio propio. El lastmod de una entrada es la fecha en que se publicó, y el de la página es la fecha de tu entrada más reciente. Incluye las 1000 entradas más recientes, no acepta filtros, lleva el mismo Cache-Control y ETag que los feeds, y responde 304 a una petición condicional.

Un buscador no encuentra este archivo por sí solo, y solo acepta un sitemap para páginas del host que sirve el archivo, o cuando el archivo se envía para ese sitio. Así que envía esta dirección en tu consola de búsqueda, para el dominio en el que está tu changelog.

El feed del changelog

Tus entradas publicadas, las más nuevas primero, con la id más reciente decidiendo los empates de marca de tiempo idéntica.

Un changelog al que suscribirse

Changeloop redacta cada entrada a partir de un pull request fusionado, la retiene para que la revises y la publica a la vez en el feed JSON, RSS, JSON Feed y Markdown. Gratis para un repositorio, sin tarjeta.

Empezar gratis

Ir a la documentación para desarrolladores