Перейти к содержимому

Вся документация для разработчиков

RSS и JSON Feed для вашего changelog

Каждый changelog в Changeloop доступен и как лента для подписки, в RSS 2.0 и JSON Feed 1.1, и как единый Markdown-документ. На этой странице: эндпоинты, фильтры, общие с JSON-лентой, и что содержит каждый формат.

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

Те же опубликованные записи в виде фида для подписки, в двух форматах, понятных читателям: RSS 2.0 и JSON Feed 1.1. Оба принимают те же фильтры repos, category и tag, что и фид changelog, и несут тот же Cache-Control и ETag. Ни один не пагинируется: читатель опрашивает начало фида, поэтому эти возвращают только самые последние записи, без курсора.

Текст записи представляет собой санитизированный HTML, обёрнутый в CDATA для RSS и переданный как content_html для JSON Feed, а когда вы включите изображения, в нём будут и ваши изображения. Изображение в шапке записи в RSS передаётся элементом media:content, а в JSON Feed полем image элемента ленты. JSON Feed дополнительно несёт цвета ваших тегов под расширением с пространством имён _changelogapp, а RSS нет, потому что ни один читатель их бы не раскрасил.

Размещённая страница анонсирует оба как ссылки rel="alternate", так что браузер или читатель, попавший туда, может подписаться, не зная путей.

Фид markdown

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

Те же опубликованные записи в виде простого markdown, подаваемого как text/markdown. Существует для читателей, не являющихся браузерами: LLM или агент, отвечающий на «что недавно изменилось в этом продукте», получает текст без анализа RSS или обхода JSON. Принимает те же фильтры repos, category и tag, что и фид changelog, несёт тот же Cache-Control и ETag, и отвечает 304 на условный запрос точно так же, как два других.

Каждая запись представляет собой секцию: заголовок как заглавие, затем одна строка с датой, категорией и любыми тегами, затем изображение в шапке строкой markdown-изображения, если у записи оно есть и его хост в вашем списке, затем текст записи, затем ссылка Learn more, если у записи она есть, затем её постоянная ссылка. Документ открывается заголовком и описанием вашего фида и ведёт обратно к размещённой странице. Когда ещё ничего не опубликовано, он говорит об этом одним предложением, а не возвращает пустое тело, так что читатель может отличить это от неудачного получения.

Файл sitemap

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

Sitemap одного changelog, для поисковых систем: страница changelog и постоянная ссылка каждой опубликованной записи, по тем адресам, которые видят ваши читатели, то есть на вашем домене, если вы указали его в Настройках, раздел Свой домен. Значение lastmod записи равно дате её публикации, а у страницы это дата вашей самой новой записи. В нём 1000 самых новых записей, фильтров он не принимает, несёт тот же Cache-Control и ETag, что и фиды, и отвечает 304 на условный запрос.

Поисковая система не найдёт этот файл сама и принимает sitemap только для страниц на том хосте, который отдаёт файл, либо когда файл отправлен для этого сайта. Поэтому отправьте этот адрес в консоли поисковой системы, для домена, на котором находится ваш changelog.

Фид changelog

Ваши опубликованные записи, от самых новых, при этом самый новый ID разрешает ничьи при одинаковых временных метках.

Changelog, на который можно подписаться

Changeloop составляет каждую запись из слитого pull request, держит её до вашей проверки и публикует сразу в JSON-ленте, в RSS, в JSON Feed и в Markdown. Бесплатно для одного репозитория, без карты.

Начать бесплатно

Читать документацию для разработчиков