Lewati ke konten

Semua dokumentasi developer

RSS dan JSON Feed untuk changelog-mu

Setiap changelog Changeloop juga merupakan feed yang bisa dilanggan, dalam RSS 2.0 dan JSON Feed 1.1, serta satu dokumen Markdown. Halaman ini membahas endpoint, filter yang sama dengan feed JSON, dan isi tiap format.

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

Entri yang sama yang dipublikasikan sebagai feed yang bisa dilanggan, dalam dua format yang dipahami pembaca: RSS 2.0 dan JSON Feed 1.1. Keduanya menerima filter repos, category, dan tag yang sama seperti feed changelog dan membawa Cache-Control serta ETag yang sama. Tidak ada yang berhalaman: pembaca menyurvei bagian atas feed, jadi ini hanya mengembalikan entri terbaru, tanpa cursor.

Teks entri adalah HTML yang disanitasi, dibungkus dalam CDATA untuk RSS dan sebagai content_html untuk JSON Feed, lengkap dengan gambarmu setelah kamu mengaktifkan gambar. Gambar header sebuah entri menjadi elemen media:content di RSS dan image milik item di JSON Feed. JSON Feed juga membawa warna tagmu di bawah ekstensi ber-namespace _changelogapp; RSS tidak, karena tidak ada pembaca yang akan mewarnainya.

Halaman hosting mengiklankan keduanya sebagai tautan rel="alternate", jadi browser atau pembaca yang mendarat di sana bisa berlangganan tanpa perlu diberi tahu jalurnya.

Feed markdown

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

Entri publikasi yang sama sebagai markdown biasa, disajikan sebagai text/markdown. Ini ada untuk pembaca yang bukan browser: LLM atau agen yang menjawab "apa yang baru berubah di produk ini" mendapat teksnya tanpa mengurai RSS atau menyusuri JSON. Menerima filter repos, category, dan tag yang sama seperti feed changelog, membawa Cache-Control dan ETag yang sama, dan merespons 304 pada permintaan bersyarat persis seperti dua lainnya.

Setiap entri adalah sebuah bagian: judul sebagai heading, lalu satu baris yang membawa tanggal, kategori, dan tag mana pun, lalu gambar header sebagai baris gambar markdown jika entrinya punya gambar header dari host di daftarmu, lalu teks entri, lalu tautan Learn more jika entrinya punya, lalu tautan permanennya. Dokumennya dibuka dengan judul dan deskripsi feedmu dan mengarah kembali ke halaman hosting. Saat belum ada yang dipublikasikan, ini mengatakannya dalam satu kalimat alih-alih mengembalikan isi kosong, jadi pembaca bisa membedakannya dari pengambilan yang gagal.

Sitemap

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

Sitemap untuk satu changelog, bagi mesin pencari: halaman changelog dan tautan permanen setiap entri yang dipublikasikan, di alamat yang dilihat pembacamu, yaitu di domainmu sendiri setelah kamu mengaturnya di Pengaturan, Domain kustom. Nilai lastmod sebuah entri adalah tanggal entri itu dipublikasikan, dan untuk halaman adalah tanggal entri terbarumu. Isinya 1000 entri terbaru, tidak menerima filter, membawa Cache-Control dan ETag yang sama seperti feed, dan merespons 304 pada permintaan bersyarat.

Mesin pencari tidak akan menemukan file ini sendiri, dan hanya menerima sitemap untuk halaman di host yang menyajikan file itu, atau saat file itu dikirimkan untuk situs tersebut. Jadi kirimkan alamat ini di konsol penelusuranmu, untuk domain tempat changelog-mu berada.

Feed changelog

Entri yang kamu publikasikan, dari yang terbaru, dengan ID terbaru memutus seri pada stempel waktu yang identik.

Changelog yang bisa dilanggan

Changeloop menyusun setiap entri dari pull request yang di-merge, menahannya untuk kamu tinjau, lalu menerbitkannya sekaligus di feed JSON, RSS, JSON Feed, dan Markdown. Gratis untuk satu repositori, tanpa kartu.

Mulai gratis

Baca dokumentasi developer