feat: ジャーナル機能

[MikuroXina]

Before requesting

• Checked same request already has not already been reported
• Understand that this request is not certain to be adopted.

Problem

Pulsate チームが提唱する課題 (ピッチ資料 を参照) として, 分散型 SNS では中央集権のものよりコミュニティが分断されやすいという点を挙げていました.

Proposed Solution

これを解決するためにジャーナルという機能を提案していました. ここではその具体的な設計を述べます.

ジャーナルの属性:

• ID
• スラグ - 言語圏に拘らず検索しやすいようにするための [a-zA-Z0-9_] の文字列
• タイトル
• 説明文
• トピックのリスト
  • トピック
    • 名前
    • 色 (空文字列だと既定の色
    • アイコン (空文字列だとアイコン無し)

ジャーナルの ER 図:

erDiagram
  Journal {
    string id
    string slug
    string title
    string description
  }
  NoteCast {
    string journalId
    string noteId
  }
  Topic {
    string name
    string color
    string icon
  }
  Account }o--o{ Journal : follows
  Journal ||--o{ NoteCast : recieves
  NoteCast }o--|| Note : belongs
  Journal }|--o{ Topic : labels

Loading

APIエンドポイント:

• クエリ
  • インスタンス内のジャーナルを一覧する
    GET /v0/journals
  • インスタンス内の特定のジャーナルを取得する
    GET /v0/journals/:journal_id
  • ジャーナルの投稿を取得する
    GET /v0/timeline/journals/:journal_id
• 投稿
  • ジャーナル向けに投稿する
    POST /v0/notes
    • リクエスト本文の任意パラメータに, ジャーナルの ID を追加する
• 購読
  • ジャーナルをフォローする
    POST /v0/journals/:journal_id/follow
  • ジャーナルをフォロー解除する
    DELETE /v0/journals/:journal_id/follow
• 管理
  • ジャーナルを追加する
    POST /v0/journals
  • ジャーナル情報を更新する
    PATCH /v0/journals
  • ジャーナルをアーカイブする
    PUT /v0/journals/archive
    • 他多くのインスタンスから参照されるジャーナルは, 完全に削除できないほうがよさそう

Other information

No response

[laminne]

ジャーナルをフォローしているユーザーリストもあると良さそう
GET /v0/journals/:journal_id/followers

[MikuroXina]

ジャーナルをフォローしているユーザーリスト

ジャーナルは外部のインスタンスからもフォローされ得る想定だったはずです. フォローしているという条件だけだとあらゆる連合に問い合わせるように見ますが, 同じインスタンス内でそれをフォローしているアカウントに限定する想定でしょうか?

[laminne]

おそらく，「(ユーザーが問い合わせる)インスタンスが知っている範囲で全員を返す」というような実装になると思っています

• ジャーナルと同じインスタンスのアカウント: 全員分のフォローを把握できる
• 別のインスタンスのアカウント: 一部のフォローを把握できる

ジャーナルの完全なフォローリストをジャーナルが存在するインスタンスに問い合わせることも実装可能ではあると思いますが，多くの場合で必要ないキャッシュになるので，どこまで情報を把握するかを調整したりできるようにしたほうが良いかもしれません

[MikuroXina]

それなら, ホップ数を指定できるようにするとどうでしょうか.

• GET /v0/journals/:journal_id/followers?hop_limit={n}
  • n 個までのインスタンス間の接続をまたいでフォローしているアカウントを把握する
  • n = 0 のときは同じインスタンスで :journal_id のジャーナルをフォローするアカウントすべてを返す
  • 必要ならば連合に GET /v0/journals/:journal_id/followers?hop_limit={n - 1} を問い合わせる

[laminne]

一般的にホップの概念は存在しない(インスタンスは基本的に投稿をリレーしない)ので、インスタンスの動作設定パラメーターで「外部ジャーナルのフォロー関係の取得制限」みたいな値を与えるとかそういうことしかできないと思っています

[MikuroXina]

ではこういう感じでどうでしょう.

• GET /v0/journals/:journal_id/followers?scope={s}
  • ID journal_id のジャーナルの, フォロワーのアカウントを配列で返す
  • s = domestic のときは, インスタンス内のジャーナルのフォロワーのみ
  • s = foreign のときは, インスタンス外のジャーナルのフォロワーのみ
  • s = all のときは, すべてのフォロワー