コンテンツへスキップ

開発者向けドキュメント一覧

changelogのRSSとJSON Feed

Changeloopのchangelogはどれも、RSS 2.0とJSON Feed 1.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

同じ公開エントリを、読者が理解する2つの形式:RSS 2.0とJSON Feed 1.1で購読可能なフィードとして提供します。どちらもchangelogフィードと同じrepos、category、tagフィルターを受け付け、同じCache-ControlとETagを持ちます。どちらもページネーションしません:読者はフィードの先頭をポーリングするため、これらはカーソルなしで最新のエントリのみを返します。

エントリのテキストはサニタイズされたHTMLで、RSSではCDATAに包まれ、JSON Feedではcontent_htmlとして提供されます。画像をオンにすると、そこに画像も含まれます。エントリのヘッダー画像は、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

同じ公開エントリを、text/markdownとして提供されるプレーンなmarkdownとして提供します。これはブラウザではない読者のために存在します:「この製品に最近何が変わったか」に答えるLLMやエージェントは、RSSをパースしたりJSONをたどったりすることなくテキストを取得します。changelogフィードと同じrepos、category、tagフィルターを受け付け、同じCache-ControlとETagを持ち、他の2つとまったく同じように条件付きリクエストに304で応答します。

各エントリはセクションです:見出しとしてのタイトル、次に日付・カテゴリ・任意のタグを含む1行、次にリストにあるホストのヘッダー画像がエントリにあればmarkdownの画像行としてのヘッダー画像、次にエントリテキスト、次にエントリにあればLearn moreリンク、次にその永続リンク。ドキュメントはあなたのフィードのタイトルと説明で始まり、ホスト型ページへのリンクで戻ります。まだ何も公開されていない場合、空の本文を返す代わりに一文でそれを述べるため、読者はそれを失敗した取得と区別できます。

サイトマップ

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

1つのchangelogのサイトマップで、検索エンジン向けです。changelogページと、公開エントリそれぞれの永続リンクを、読者に見えるアドレスで掲載します。設定の「カスタムドメイン」で独自ドメインを設定している場合は、そのドメインのアドレスになります。エントリのlastmodはその公開日で、ページのlastmodは最新エントリの公開日です。最新の1000件のエントリを掲載し、フィルターは受け付けず、フィードと同じCache-ControlとETagを持ち、条件付きリクエストには304で応答します。

検索エンジンがこのファイルを自動的に見つけることはありません。また、サイトマップが受け付けられるのは、そのファイルを配信するホスト上のページについてか、そのサイト用に送信された場合だけです。そのため、changelogを置いているドメインについて、このアドレスをサーチコンソールで送信してください。

changelogフィード

公開されたエントリを最新のものから順に、同一のタイムスタンプの場合は最新のIDで同点を解消します。

購読できるchangelog

Changeloopはマージされたプルリクエストから各エントリーを下書きし、あなたのレビューまで保留して、JSONフィード、RSS、JSON Feed、Markdownに同時に公開します。1リポジトリまで無料、カード不要。

無料で始める

開発者向けドキュメントを読む