Zum Inhalt springen

Alle Entwicklerdokumente

RSS und JSON Feed für Ihr Changelog

Jedes Changeloop-Changelog ist auch ein abonnierbarer Feed, in RSS 2.0 und JSON Feed 1.1, und ein einzelnes Markdown-Dokument. Diese Seite behandelt die Endpoints, die Filter, die sie mit dem JSON-Feed teilen, und was jedes Format enthält.

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

Dieselben veröffentlichten Einträge als abonnierbarer Feed, in den beiden Formaten, die Reader verstehen: RSS 2.0 und JSON Feed 1.1. Beide nehmen dieselben repos-, category- und tag-Filter wie der Changelog-Feed und tragen dasselbe Cache-Control und ETag. Keiner von beiden blättert: Ein Reader fragt den Kopf des Feeds ab, diese liefern also nur die neuesten Einträge, ohne Cursor.

Der Eintragstext ist das bereinigte HTML, bei RSS in CDATA verpackt und bei JSON Feed als content_html, und sobald Sie Bilder eingeschaltet haben, stehen Ihre Bilder darin. Das Titelbild eines Eintrags ist in RSS ein media:content-Element und in JSON Feed das image des Items. JSON Feed trägt zusätzlich Ihre Tag-Farben unter einer namensraumbezogenen _changelogapp-Erweiterung; RSS nicht, weil kein Reader sie zeichnen würde.

Die gehostete Seite weist beide als rel="alternate"-Links aus, sodass ein Browser oder Reader, der dort landet, abonnieren kann, ohne die Pfade zu kennen.

Der Markdown-Feed

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

Dieselben veröffentlichten Einträge als reines Markdown, ausgeliefert als text/markdown. Es gibt ihn für Leser, die keine Browser sind: Ein LLM oder ein Agent, der beantwortet, was sich zuletzt an diesem Produkt geändert hat, bekommt den Text, ohne RSS zu parsen oder JSON zu durchlaufen. Er nimmt dieselben repos-, category- und tag-Filter wie der Changelog-Feed, trägt dasselbe Cache-Control und ETag und antwortet auf eine bedingte Anfrage genauso mit 304 wie die anderen beiden.

Jeder Eintrag ist ein Abschnitt: der Titel als Überschrift, dann eine einzelne Zeile mit Datum, Kategorie und etwaigen Tags, dann das Titelbild als Markdown-Bildzeile, falls der Eintrag eines von einem Host auf Ihrer Liste hat, dann der Eintragstext, dann der Learn-more-Link, falls der Eintrag einen hat, dann sein Permalink. Das Dokument beginnt mit Titel und Beschreibung Ihres Feeds und verlinkt zurück auf die gehostete Seite. Ist noch nichts veröffentlicht, sagt es das in einem Satz, statt einen leeren Body zu liefern, damit ein Leser das von einem fehlgeschlagenen Abruf unterscheiden kann.

Die Sitemap

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

Eine Sitemap für ein einzelnes Changelog, für Suchmaschinen: die Changelog-Seite und der Permalink jedes veröffentlichten Eintrags, unter den Adressen, die Ihre Leser sehen, also auf Ihrer eigenen Domain, sobald Sie unter Einstellungen, Eigene Domain eine eingetragen haben. Das lastmod eines Eintrags ist das Datum seiner Veröffentlichung, das der Seite das Datum Ihres neuesten Eintrags. Sie führt die neuesten 1000 Einträge auf, nimmt keine Filter, trägt dasselbe Cache-Control und ETag wie die Feeds und antwortet auf eine bedingte Anfrage mit 304.

Eine Suchmaschine findet diese Datei nicht von selbst, und sie akzeptiert eine Sitemap nur für Seiten auf dem Host, der die Datei ausliefert, oder wenn die Datei für diese Website eingereicht wird. Reichen Sie diese Adresse deshalb in Ihrer Search Console ein, für die Domain, auf der Ihr Changelog liegt.

Der Changelog-Feed

Ihre veröffentlichten Einträge, neueste zuerst, wobei bei identischen Zeitstempeln die neuere id den Ausschlag gibt.

Ein Changelog, das man abonnieren kann

Changeloop entwirft jeden Eintrag aus einem gemergten Pull Request, hält ihn für Ihre Prüfung zurück und veröffentlicht ihn gleichzeitig im JSON-Feed, als RSS, als JSON Feed und als Markdown. Kostenlos für ein Repository, ohne Karte.

Kostenlos starten

Zur Entwicklerdokumentation