Přeskočit na obsah

Celá dokumentace pro vývojáře

RSS a JSON Feed pro tvůj changelog

Každý changelog v Changeloop je také kanál k odebírání, v RSS 2.0 a JSON Feed 1.1, a jeden dokument v Markdownu. Tato stránka popisuje endpointy, filtry, které sdílejí s JSON kanálem, a co nese každý formát.

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

Stejné publikované záznamy jako feed k odběru, ve dvou formátech, kterým čtenáři rozumí: RSS 2.0 a JSON Feed 1.1. Oba přijímají stejné filtry repos, category a tag jako feed changelogu a nesou stejný Cache-Control a ETag. Žádný nestránkuje: čtenář dotazuje začátek feedu, takže tyto vracejí pouze nejnovější záznamy, bez kurzoru.

Text záznamu je sanitizovaný HTML, obalený v CDATA pro RSS a jako content_html pro JSON Feed, a jakmile zapneš obrázky, obsahuje i tvé obrázky. Obrázek záhlaví záznamu je v RSS element media:content a v JSON Feed obrázek položky. JSON Feed navíc nese barvy tvých tagů pod rozšířením s jmenným prostorem _changelogapp; RSS ne, protože žádný čtenář by je nevymaloval.

Hostovaná stránka oznamuje oba jako odkazy rel="alternate", takže prohlížeč nebo čtenář, který na ni přistane, se může přihlásit k odběru, aniž by mu byly řečeny cesty.

Feed markdown

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

Stejné publikované záznamy jako obyčejný markdown, poskytovaný jako text/markdown. Existuje pro čtenáře, kteří nejsou prohlížeči: LLM nebo agent odpovídající na „co se v tomto produktu nedávno změnilo“ dostane text bez parsování RSS nebo procházení JSON. Přijímá stejné filtry repos, category a tag jako feed changelogu, nese stejný Cache-Control a ETag a odpovídá 304 na podmíněný požadavek přesně jako oba ostatní.

Každý záznam je sekce: název jako nadpis, pak jeden řádek nesoucí datum, kategorii a jakékoliv tagy, pak obrázek záhlaví jako řádek obrázku v markdownu, pokud ho záznam má z hostitele na tvém seznamu, pak text záznamu, pak odkaz Learn more, pokud ho záznam má, pak jeho trvalý odkaz. Dokument se otevírá názvem a popisem tvého feedu a vede zpět na hostovanou stránku. Když ještě nic nebylo publikováno, řekne to jednou větou místo vrácení prázdného těla, takže čtenář to dokáže odlišit od neúspěšného načtení.

Soubor sitemap

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

Sitemap jednoho changelogu pro vyhledávače: stránka changelogu a trvalý odkaz každého publikovaného záznamu, na adresách, které vidí tví čtenáři, tedy na tvé vlastní doméně, jakmile ji nastavíš v Nastavení, sekce Vlastní doména. Hodnota lastmod záznamu je datum jeho publikování a u stránky je to datum tvého nejnovějšího záznamu. Obsahuje 1000 nejnovějších záznamů, nepřijímá žádné filtry, nese stejný Cache-Control a ETag jako feedy a na podmíněný požadavek odpovídá 304.

Vyhledávač tento soubor sám nenajde a sitemap přijímá jen pro stránky na hostu, který soubor poskytuje, nebo když je soubor odeslán pro daný web. Odešli proto tuto adresu ve své konzoli pro vyhledávání, pro doménu, na které tvůj changelog běží.

Feed changelogu

Tvé publikované záznamy, od nejnovějšího, přičemž nejnovější ID rozhoduje shody u identických časových razítek.

Changelog, který jde odebírat

Changeloop sepíše každý záznam ze sloučeného pull requestu, podrží ho ke tvé kontrole a zveřejní ho najednou v JSON kanálu, v RSS, v JSON Feed i v Markdownu. Zdarma pro jeden repozitář, bez karty.

Začít zdarma

Přečti si dokumentaci pro vývojáře