summaryrefslogtreecommitdiff
path: root/src/docs/api/entities/note.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/api/entities/note.yaml')
-rw-r--r--src/docs/api/entities/note.yaml211
1 files changed, 0 insertions, 211 deletions
diff --git a/src/docs/api/entities/note.yaml b/src/docs/api/entities/note.yaml
deleted file mode 100644
index ce0c5de2e4..0000000000
--- a/src/docs/api/entities/note.yaml
+++ /dev/null
@@ -1,211 +0,0 @@
-name: "Note"
-
-desc:
- ja-JP: "投稿。"
- en-US: "A note."
-
-props:
- id:
- type: "id"
- optional: false
- desc:
- ja-JP: "投稿ID"
- en-US: "The ID of this note"
-
- createdAt:
- type: "date"
- optional: false
- desc:
- ja-JP: "投稿日時"
- en-US: "The posted date of this note"
-
- viaMobile:
- type: "boolean"
- optional: true
- desc:
- ja-JP: "モバイル端末から投稿したか否か(自己申告であることに留意)"
- en-US: "Whether this note sent via a mobile device"
-
- localOnly:
- type: "boolean"
- optional: true
- desc:
- ja-JP: "ローカルのみに公開する投稿か否か"
- en-US: "Whether this note is no federation"
-
- text:
- type: "string"
- optional: true
- desc:
- ja-JP: "投稿の本文"
- en-US: "The text of this note"
-
- fileIds:
- type: "id(DriveFile)[]"
- optional: true
- desc:
- ja-JP: "添付されているファイルのID (なければレスポンスでは空配列)"
- en-US: "The IDs of the attached files (empty array for response if no files is attached)"
-
- files:
- type: "entity(DriveFile)[]"
- optional: true
- desc:
- ja-JP: "添付されているファイル"
- en-US: "The attached files"
-
- userId:
- type: "id(User)"
- optional: false
- desc:
- ja-JP: "投稿者ID"
- en-US: "The ID of author of this note"
-
- user:
- type: "entity(User)"
- optional: true
- desc:
- ja-JP: "投稿者"
- en-US: "The author of this note"
-
- myReaction:
- type: "string"
- optional: true
- desc:
- ja-JP: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
- en-US: "The your <a href='/docs/api/reactions'>reaction</a> of this note"
-
- renoteCount:
- type: "number"
- optional: false
- desc:
- ja-JP: "この投稿がRenoteされた数"
- en-US: "The number of renotes for this post"
-
- repliesCount:
- type: "number"
- optional: false
- desc:
- ja-JP: "この投稿に返信された数"
- en-US: "The number of replies to this post"
-
- reactionCounts:
- type: "object"
- optional: false
- desc:
- ja-JP: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
-
- replyId:
- type: "id(Note)"
- optional: true
- desc:
- ja-JP: "返信した投稿のID"
- en-US: "The ID of the replyed note"
-
- reply:
- type: "entity(Note)"
- optional: true
- desc:
- ja-JP: "返信した投稿"
- en-US: "The replyed note"
-
- renoteId:
- type: "id(Note)"
- optional: true
- desc:
- ja-JP: "引用した投稿のID"
- en-US: "The ID of the quoted note"
-
- renote:
- type: "entity(Note)"
- optional: true
- desc:
- ja-JP: "引用した投稿"
- en-US: "The quoted note"
-
- poll:
- type: "object"
- optional: true
- desc:
- ja-JP: "投票"
- en-US: "The poll"
-
- props:
- choices:
- type: "object[]"
- optional: false
- desc:
- ja-JP: "投票の選択肢"
- en-US: "The choices of this poll"
-
- props:
- id:
- type: "number"
- optional: false
- desc:
- ja-JP: "選択肢ID"
- en-US: "The ID of this choice"
-
- isVoted:
- type: "boolean"
- optional: true
- desc:
- ja-JP: "自分がこの選択肢に投票したかどうか"
- en-US: "Whether you voted to this choice"
-
- text:
- type: "string"
- optional: false
- desc:
- ja-JP: "選択肢本文"
- en-US: "The text of this choice"
-
- votes:
- type: "number"
- optional: false
- desc:
- ja-JP: "この選択肢に投票された数"
- en-US: "The number voted for this choice"
- geo:
- type: "object"
- optional: true
- desc:
- ja-JP: "位置情報"
- en-US: "Geo location"
-
- props:
- coordinates:
- type: "number[]"
- optional: false
- desc:
- ja-JP: "座標。最初に経度:-180〜180で表す。最後に緯度:-90〜90で表す。"
-
- altitude:
- type: "number"
- optional: false
- desc:
- ja-JP: "高度。メートル単位で表す。"
-
- accuracy:
- type: "number"
- optional: false
- desc:
- ja-JP: "緯度、経度の精度。メートル単位で表す。"
-
- altitudeAccuracy:
- type: "number"
- optional: false
- desc:
- ja-JP: "高度の精度。メートル単位で表す。"
-
- heading:
- type: "number"
- optional: false
- desc:
- ja-JP: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
-
- speed:
- type: "number"
- optional: false
- desc:
- ja-JP: "速度。メートル / 秒数で表す。"