Skip to content

利用可能機能一覧開示AP仕様

KMY(雪あすか) edited this page Apr 18, 2024 · 9 revisions

kmyblueで認識できるようにするためにあなたのサーバーで利用可能な機能一覧を開示するには、NodeInfoに以下のデータを追加します。

{
  "metadata": {
    "features": "(文字列配列)あなたのサーバーが対応する機能一覧"
  }
}

現在kmyblueでは、以下の文字列がfeaturesにあるかを確認します。

配列の要素 説明 備考
emoji_reaction この要素があるサーバーは、絵文字リアクション機能に対応しているとみなされます Misskey、Fedibirdなどが実装
quote この要素があるサーバーは、引用機能に対応しているとみなされます Misskey、Fedibirdなどが実装
status_reference この要素があるサーバーは、ひかえめな引用(参照)機能に対応しているとみなされます Fedibirdが実装
circle この要素があるサーバーは、サークル投稿の読み取りが可能であるとみなされます Mastodon、misskey.ioが実装

設定例

{
  "metadata": { "features":
    ["emoji_reaction", "quote"]
  }
}

例外となるソフトウェアの挙動

例外として、主要なソフトウェアまたはそのフォークの一部(例:misskeyfedibird)はあらかじめkmyblueに登録されているため、ソフトウェア開発側がNodeInfoを変更しなくても、上記機能のすべてまたは一部に対応しているとみなされます。

ただしこれはNodeInfoのfeaturesに設定された情報が上書きされることを意味するため、特定のソフトウェア名を利用しかつ一部機能をオプションで無効にしていてもkmyblue側は認識しません。例えばkmyblueでは管理者がサーバー全体の絵文字リアクション機能を無効にすることができ、その設定はNodeInfoのmetadata.featuresにも反映され他のkmyblueが認識することができます。

予約されたソフトウェア名からあなたの開発するソフトウェア名を外してほしい場合はご連絡戴くか、新しいプルリクエストを作成してください。ただし同時にあなたのソフトウェア側でも適切なmetadata.featuresを公開してください。

ソフトウェア開発者の皆さまへのお願い

あなたの開発保守するソフトウェア名の機能をkmyblueで認識されるようにするために、kmyblueにソフトウェア名を能動的に登録することはおすすめしません。あなたのソフトウェアをさらに誰かがフォークしてソフトウェア名を変更するようなケースにおいて、そのフォークの名前を新規にkmyblueに登録する必要が発生するためです。

そもそもkmyblue開発者はすべてのMisskeyフォークを把握しているわけではなく、特に新興のMisskeyフォークはkmyblueへの名前登録が遅れるため、kmyblue側で絵文字リアクション利用不可と認識されます。

各種のケースに対応するため、ぜひNodeInfoのmetadata.featuresに文字列配列を追加してください。また、あなたのソフトウェアがすでにkmyblueに登録されていた場合は、削除するよう依頼してください。開発者( https://kmy.blue/@askyq )に直接ご連絡いただくか、新たにIssueを起票いただくか、プルリクエストの場合はこちらを参考に変更してください。

Clone this wiki locally