Aller au contenu

Toute la documentation développeurs

RSS et JSON Feed pour ton changelog

Chaque changelog Changeloop est aussi un flux auquel s'abonner, en RSS 2.0 et JSON Feed 1.1, et un document Markdown unique. Cette page couvre les endpoints, les filtres qu'ils partagent avec le flux JSON et ce que contient chaque format.

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

Les mêmes entrées publiées comme flux abonnable, dans les deux formats que comprennent les lecteurs de flux : RSS 2.0 et JSON Feed 1.1. Les deux acceptent les mêmes filtres repos, category et tag que le flux du changelog et portent le même Cache-Control et ETag. Aucun des deux ne pagine : un lecteur interroge la tête du flux, ils ne renvoient donc que les entrées les plus récentes, sans curseur.

Le texte de l'entrée est le HTML nettoyé, enveloppé en CDATA pour RSS et comme content_html pour JSON Feed, avec tes images dedans une fois que tu as activé les images. L'image d'en-tête d'une entrée est un élément media:content en RSS et l'image de l'item en JSON Feed. JSON Feed porte en plus les couleurs de tes étiquettes sous une extension avec espace de noms _changelogapp ; pas RSS, car aucun lecteur ne les peindrait.

La page hébergée signale les deux comme liens rel="alternate", donc un navigateur ou un lecteur qui y atterrit peut s'abonner sans qu'on lui indique les chemins.

Le flux markdown

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

Les mêmes entrées publiées en markdown simple, servies comme text/markdown. Il existe pour les lecteurs qui ne sont pas des navigateurs : un LLM ou un agent qui répond à ce qui a changé récemment dans ce produit reçoit le texte sans analyser du RSS ni parcourir du JSON. Il accepte les mêmes filtres repos, category et tag que le flux du changelog, porte le même Cache-Control et ETag, et répond 304 à une requête conditionnelle exactement comme les deux autres.

Chaque entrée est une section : le titre en en-tête, puis une seule ligne avec date, catégorie et étiquettes éventuelles, puis l'image d'en-tête sous forme de ligne d'image markdown si l'entrée en a une venant d'un hôte de ta liste, puis le texte de l'entrée, puis le lien Learn more si l'entrée en a un, puis son permalien. Le document commence par le titre et la description de ton flux et renvoie vers la page hébergée. Si rien n'est encore publié, ça le dit en une phrase au lieu de renvoyer un corps vide, pour qu'un lecteur puisse distinguer ça d'une requête échouée.

Le sitemap

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

Un sitemap pour un seul changelog, destiné aux moteurs de recherche : la page du changelog et le permalien de chaque entrée publiée, aux adresses que voient tes lecteurs, donc sur ton propre domaine dès que tu en as défini un dans Paramètres, Domaine personnalisé. Le lastmod d'une entrée est sa date de publication, et celui de la page est la date de ton entrée la plus récente. Il liste les 1000 entrées les plus récentes, n'accepte aucun filtre, porte le même Cache-Control et ETag que les flux, et répond 304 à une requête conditionnelle.

Un moteur de recherche ne trouve pas ce fichier tout seul, et il n'accepte un sitemap que pour les pages de l'hôte qui sert le fichier, ou quand le fichier est soumis pour ce site. Soumets donc cette adresse dans ta console de recherche, pour le domaine où se trouve ton changelog.

Le flux du changelog

Tes entrées publiées, de la plus récente à la plus ancienne, l'id la plus récente départageant les égalités d'horodatage identique.

Un changelog auquel s'abonner

Changeloop rédige chaque entrée à partir d'une pull request mergée, la garde pour ta relecture et la publie en même temps dans le flux JSON, en RSS, en JSON Feed et en Markdown. Gratuit pour un dépôt, sans carte.

Commencer gratuitement

Lire la documentation développeurs