VirMesh Protocol

Appearance

me.virmesh.social.removeFriend ​

指定した mutual friend 関係を削除します。

from に紐づく既存の mutual friend 関係を削除する private action です。 payload.friendId には削除対象の相手 player identifier を入れます。 top-level の signature は canonical JSON of { action, from, payload } に対する署名です。 from と payload.friendId は同一にできません。 実行者または削除対象が tombstone 化済み account の場合は受理されません。

draft

Endpoint

Method
POST
Path
/private/me.virmesh.social.removeFriend
Auth
required
Host
VirMesh.PlayerServer

Request schema

fromstringRequired

action 実行者の player identifier です。

payload.friendIdstringRequired

削除対象の mutual friend の player identifier です。

signaturestringRequired

canonical JSON of { action, from, payload } に対する署名です。

Request example

{
  "from": "medi:player:ed25519:actor-public-key",
  "payload": {
    "friendId": "medi:player:ed25519:friend-public-key"
  },
  "signature": "base64-signature-for-action-envelope"
}

Responses

200
status+me.virmesh.success.friendRemoved

mutual friend 関係が削除されたことを示します。

me.virmesh.social.removeFriend が正常終了し、 from と payload.friendId の mutual friend 関係が削除されたときに返ります。

friend removed

{
  "status": "status+me.virmesh.success.friendRemoved"
}
400
status+me.virmesh.json.invalid_json

request body が JSON として解釈できないことを示します。

この status は body が壊れている、または JSON parser が受理できない形式で送られた場合に返ります。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

malformed json

{
  "status": "status+me.virmesh.json.invalid_json",
  "payload": {
    "message": "Request body must be valid JSON."
  }
}
400
status+me.virmesh.json.invalid_private_request

private request envelope の形式が不正であることを示します。

この status は private route が期待する from, payload, signature などの envelope 要件を満たさない場合に返ります。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

invalid private envelope

{
  "status": "status+me.virmesh.json.invalid_private_request",
  "payload": {
    "message": "Private request must contain the expected envelope fields."
  }
}
400
status+me.virmesh.json.unexpected_fields

許可されていない field が request に含まれていることを示します。

この status は strict validation が有効な route に未知の top-level field または payload field を送った場合に返ります。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

unexpected request fields

{
  "status": "status+me.virmesh.json.unexpected_fields",
  "payload": {
    "message": "Request contains unknown fields that are not allowed by this route."
  }
}
400
status+me.virmesh.json.invalid_payload

`payload`がactionの期待する形式ではないことを示します。

リクエストデータ自体はJSON objectとして解釈できたものの、 期待する形式と一致しない場合に使います。

Status payload

payload.messagestringRequired

検証に失敗した理由を表す詳細メッセージです。

invalid payload

{
  "status": "status+me.virmesh.json.invalid_payload",
  "payload": {
    "message": "送信されたペイロードが正しい形式ではありません。"
  }
}
400
status+me.virmesh.social.self_remove_not_allowed

自分自身を friend 削除対象に指定できないことを示します。

この status は me.virmesh.social.removeFriend で from と payload.friendId が同じ値だった場合に返ります。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

self removal rejected

{
  "status": "status+me.virmesh.social.self_remove_not_allowed",
  "payload": {
    "message": "You cannot remove yourself from your own friend list."
  }
}
401
status+me.virmesh.key.invalid_signature

署名の形式が不正、または署名検証に失敗したことを示します。

この status は署名文字列が base64 として不正な場合と、 復元できた署名が検証に失敗した場合に使われます。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

signature verification failed

{
  "status": "status+me.virmesh.key.invalid_signature",
  "payload": {
    "message": "Signature verification failed."
  }
}
404
status+me.virmesh.social.friend_not_found

指定した対象との mutual friend 関係が存在しないことを示します。

この status は me.virmesh.social.removeFriend で指定した payload.friendId との間に、 削除対象となる mutual friend 関係が見つからない場合に返ります。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

friend relation not found

{
  "status": "status+me.virmesh.social.friend_not_found",
  "payload": {
    "message": "No mutual friend relation matched the requested pair."
  }
}
410
status+me.virmesh.account.disabled

対象 account が tombstone 化済みであり、有効な主体または参照先として扱えないことを示します。

この status は account が disable 済みで、以後の更新、social 操作、migration、 公開 profile / handle 解決の対象として受理されない場合に返ります。 通常は HTTP 410 Gone と組み合わせて返します。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

account disabled

{
  "status": "status+me.virmesh.account.disabled",
  "payload": {
    "message": "The requested account has been disabled and tombstoned."
  }
}
501
status+me.virmesh.action.not_supported

要求した action が現在の server では利用できないことを示します。

指定されたactionがサーバー上で無効化されており、使用できないことを示します。

Status payload

payload.messagestringRequired

実装依存の詳細メッセージです。

action is disabled

{
  "status": "status+me.virmesh.action.not_supported",
  "payload": {
    "message": "registerAccountKeyによる登録がサポートされていません。"
  }
}