検索許可API - kmycode/mastodon GitHub Wiki

対応可否の判定方法

下記のエンドポイントで取得できるJSONについて

/api/v1/instance
/api/v2/instance

下記の配列に値があるかで判定してください

{
  "fedibird_capabilities": [
    "searchability",
    "kmyblue_searchability"
  ]
}

kmyblueはFedibird互換APIの一部にしか対応しておらす、またkmyblue独自の追加機能も存在します。それを区別するために、kmyblue_searchabilityを追加しています。
kmyblueにおけるSearchabiliyは、あくまで各投稿ごとの設定をサポートしています。

Fedibirdとの互換情報

kmyblueは、アカウント全体、ならびに全文検索API呼び出し時のsearchabilityパラメータをサポートしません。（※正確には内部で処理は記述済でREST APIもFedibirdと同仕様で呼び出し可能ですが、十分な動作確認は行っておりません）
また、limitedはFedibirdにはありませんが、kmyblueでは独自にサポートします。

searchability列挙値

以下の文字列のいずれかを指定します。

値	説明
public	全文検索において、すべての人がこの投稿を検索可能である
private	全文検索において、フォロワーのみがこの投稿を検索可能である
direct	全文検索において、リアクションした人のみがこの投稿を検索可能である
limited	全文検索において、投稿者以外はこの投稿を検索できない（kmyblue独自）

既存のオブジェクトに追加されたプロパティ

statusオブジェクトに以下のプロパティが追加されています。

{
  "searchability": "（文字列・列挙）この投稿の検索許可"
}

既存のAPIに追加されたプロパティ

新規statusを作成するAPI（投稿するAPI）に、下記のプロパティが追加されています。

POST /api/v1/statuses

{
  "searchability": "（文字列・列挙）この投稿の検索許可"
}