Sari la conținut

Toată documentația pentru dezvoltatori

RSS și JSON Feed pentru changelog-ul tău

Orice changelog Changeloop este și un feed la care te poți abona, în RSS 2.0 și JSON Feed 1.1, plus un singur document Markdown. Pagina aceasta acoperă endpoint-urile, filtrele comune cu feedul JSON și ce conține fiecare format.

RSS și 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

Aceleași intrări publicate ca un feed la care se poate abona, în cele două formate pe care le înțeleg cititoarele: RSS 2.0 și JSON Feed 1.1. Ambele acceptă aceleași filtre repos, category și tag ca feedul de changelog și poartă același Cache-Control și ETag. Niciunul nu paginare: un cititor interoghează capătul feedului, deci acestea returnează doar cele mai recente intrări, fără cursor.

Textul intrării este HTML-ul sanitizat, învelit în CDATA pentru RSS și ca content_html pentru JSON Feed, cu imaginile tale incluse odată ce ai activat imaginile. Imaginea de antet a unei intrări este un element media:content în RSS și imaginea elementului în JSON Feed. JSON Feed poartă în plus culorile tagurilor tale sub o extensie cu namespace _changelogapp; RSS nu, deoarece niciun cititor nu le-ar colora.

Pagina găzduită anunță ambele ca linkuri rel="alternate", deci un browser sau cititor care ajunge acolo se poate abona fără să i se spună căile.

Feedul markdown

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

Aceleași intrări publicate ca markdown simplu, servit ca text/markdown. Există pentru cititori care nu sunt browsere: un LLM sau un agent care răspunde la „ce s-a schimbat recent în acest produs” primește textul fără să analizeze RSS sau să parcurgă JSON. Acceptă aceleași filtre repos, category și tag ca feedul de changelog, poartă același Cache-Control și ETag, și răspunde 304 la o cerere condiționată exact ca celelalte două.

Fiecare intrare este o secțiune: titlul ca antet, apoi o singură linie care poartă data, categoria și orice etichete, apoi imaginea de antet ca linie de imagine markdown, dacă intrarea are una de pe un host din lista ta, apoi textul intrării, apoi linkul Learn more dacă intrarea îl are, apoi linkul său permanent. Documentul se deschide cu titlul și descrierea feedului tău și duce înapoi la pagina găzduită. Când nimic nu este încă publicat, spune asta într-o propoziție în loc să returneze un corp gol, deci un cititor poate distinge asta de o preluare eșuată.

Sitemap-ul

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

Un sitemap al unui singur changelog, pentru motoarele de căutare: pagina de changelog și linkul permanent al fiecărei intrări publicate, la adresele pe care le văd cititorii, adică pe domeniul tău după ce ai setat unul în Setări, Domeniu propriu. Valoarea lastmod a unei intrări este data la care a fost publicată, iar a paginii este data celei mai noi intrări. Conține cele mai noi 1000 de intrări, nu acceptă filtre, poartă același Cache-Control și ETag ca feedurile și răspunde 304 la o cerere condiționată.

Un motor de căutare nu găsește singur acest fișier și acceptă un sitemap doar pentru paginile de pe hostul care servește fișierul, sau atunci când fișierul este trimis pentru acel site. Așa că trimite această adresă în consola ta de căutare, pentru domeniul pe care se află changelog-ul tău.

Feedul de changelog

Intrările tale publicate, de la cea mai nouă, cu ID-ul cel mai nou rezolvând egalitățile la marcaje de timp identice.

Un changelog la care te poți abona

Changeloop scrie fiecare intrare dintr-un pull request unit, o ține pentru revizuirea ta și o publică deodată în feedul JSON, în RSS, în JSON Feed și în Markdown. Gratuit pentru un repository, fără card.

Începe gratuit

Citește documentația pentru dezvoltatori