diff --git a/src/docs/api/entities/drive-file.yaml b/src/docs/api/entities/drive-file.yaml
index 02ab0d608..bb39e9011 100644
--- a/src/docs/api/entities/drive-file.yaml
+++ b/src/docs/api/entities/drive-file.yaml
@@ -5,67 +5,77 @@ desc:
en: "A file of Drive."
props:
- - name: "id"
+ id:
type: "id"
optional: false
desc:
ja: "ファイルID"
en: "The ID of this file"
- - name: "createdAt"
+
+ createdAt:
type: "date"
optional: false
desc:
ja: "アップロード日時"
en: "The upload date of this file"
- - name: "userId"
+
+ userId:
type: "id(User)"
optional: false
desc:
ja: "所有者ID"
en: "The ID of the owner of this file"
- - name: "user"
+
+ user:
type: "entity(User)"
optional: true
desc:
ja: "所有者"
en: "The owner of this file"
- - name: "name"
+
+ name:
type: "string"
optional: false
desc:
ja: "ファイル名"
en: "The name of this file"
- - name: "md5"
+
+ md5:
type: "string"
optional: false
desc:
ja: "ファイルのMD5ハッシュ値"
en: "The md5 hash value of this file"
- - name: "type"
+
+ type:
type: "string"
optional: false
desc:
ja: "ファイルの種類"
en: "The type of this file"
- - name: "datasize"
+
+ datasize:
type: "number"
optional: false
desc:
ja: "ファイルサイズ(bytes)"
en: "The size of this file (bytes)"
- - name: "url"
+
+ url:
type: "string"
optional: false
desc:
ja: "ファイルのURL"
en: "The URL of this file"
- - name: "folderId"
+
+ folderId:
type: "id(DriveFolder)"
optional: true
desc:
ja: "フォルダID"
en: "The ID of the folder of this file"
- - name: "folder"
+
+ folder:
type: "entity(DriveFolder)"
optional: true
desc:
diff --git a/src/docs/api/entities/note.yaml b/src/docs/api/entities/note.yaml
index c508dab3d..04cb3c982 100644
--- a/src/docs/api/entities/note.yaml
+++ b/src/docs/api/entities/note.yaml
@@ -5,163 +5,185 @@ desc:
en: "A note."
props:
- - name: "id"
+ id:
type: "id"
optional: false
desc:
ja: "投稿ID"
en: "The ID of this note"
- - name: "createdAt"
+
+ createdAt:
type: "date"
optional: false
desc:
ja: "投稿日時"
en: "The posted date of this note"
- - name: "viaMobile"
+
+ viaMobile:
type: "boolean"
optional: true
desc:
ja: "モバイル端末から投稿したか否か(自己申告であることに留意)"
en: "Whether this note sent via a mobile device"
- - name: "text"
+
+ text:
type: "string"
optional: true
desc:
ja: "投稿の本文"
en: "The text of this note"
- - name: "mediaIds"
+
+ mediaIds:
type: "id(DriveFile)[]"
optional: true
desc:
ja: "添付されているメディアのID (なければレスポンスでは空配列)"
en: "The IDs of the attached media (empty array for response if no media is attached)"
- - name: "media"
+
+ media:
type: "entity(DriveFile)[]"
optional: true
desc:
ja: "添付されているメディア"
en: "The attached media"
- - name: "userId"
+
+ userId:
type: "id(User)"
optional: false
desc:
ja: "投稿者ID"
en: "The ID of author of this note"
- - name: "user"
+
+ user:
type: "entity(User)"
optional: true
desc:
ja: "投稿者"
en: "The author of this note"
- - name: "myReaction"
+
+ myReaction:
type: "string"
optional: true
desc:
ja: "この投稿に対する自分のリアクション"
en: "The your reaction of this note"
- - name: "reactionCounts"
+
+ reactionCounts:
type: "object"
optional: false
desc:
ja: "リアクションをキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
- - name: "replyId"
+
+ replyId:
type: "id(Note)"
optional: true
desc:
ja: "返信した投稿のID"
en: "The ID of the replyed note"
- - name: "reply"
+
+ reply:
type: "entity(Note)"
optional: true
desc:
ja: "返信した投稿"
en: "The replyed note"
- - name: "renoteId"
+
+ renoteId:
type: "id(Note)"
optional: true
desc:
ja: "引用した投稿のID"
en: "The ID of the quoted note"
- - name: "renote"
+
+ renote:
type: "entity(Note)"
optional: true
desc:
ja: "引用した投稿"
en: "The quoted note"
- - name: "poll"
+
+ poll:
type: "object"
optional: true
desc:
ja: "投票"
en: "The poll"
- defName: "poll"
- def:
- - name: "choices"
+
+ props:
+ choices:
type: "object[]"
optional: false
desc:
ja: "投票の選択肢"
en: "The choices of this poll"
- defName: "choice"
- def:
- - name: "id"
+
+ props:
+ id:
type: "number"
optional: false
desc:
ja: "選択肢ID"
en: "The ID of this choice"
- - name: "isVoted"
+
+ isVoted:
type: "boolean"
optional: true
desc:
ja: "自分がこの選択肢に投票したかどうか"
en: "Whether you voted to this choice"
- - name: "text"
+
+ text:
type: "string"
optional: false
desc:
ja: "選択肢本文"
en: "The text of this choice"
- - name: "votes"
+
+ votes:
type: "number"
optional: false
desc:
ja: "この選択肢に投票された数"
en: "The number voted for this choice"
- - name: "geo"
+ geo:
type: "object"
optional: true
desc:
ja: "位置情報"
en: "Geo location"
- defName: "geo"
- def:
- - name: "coordinates"
+
+ props:
+ coordinates:
type: "number[]"
optional: false
desc:
ja: "座標。最初に経度:-180〜180で表す。最後に緯度:-90〜90で表す。"
- - name: "altitude"
+
+ altitude:
type: "number"
optional: false
desc:
ja: "高度。メートル単位で表す。"
- - name: "accuracy"
+
+ accuracy:
type: "number"
optional: false
desc:
ja: "緯度、経度の精度。メートル単位で表す。"
- - name: "altitudeAccuracy"
+
+ altitudeAccuracy:
type: "number"
optional: false
desc:
ja: "高度の精度。メートル単位で表す。"
- - name: "heading"
+
+ heading:
type: "number"
optional: false
desc:
ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
- - name: "speed"
+
+ speed:
type: "number"
optional: false
desc:
diff --git a/src/docs/api/entities/post.yaml b/src/docs/api/entities/post.yaml
deleted file mode 100644
index 6fd26543b..000000000
--- a/src/docs/api/entities/post.yaml
+++ /dev/null
@@ -1,168 +0,0 @@
-name: "Note"
-
-desc:
- ja: "投稿。"
- en: "A note."
-
-props:
- - name: "id"
- type: "id"
- optional: false
- desc:
- ja: "投稿ID"
- en: "The ID of this note"
- - name: "createdAt"
- type: "date"
- optional: false
- desc:
- ja: "投稿日時"
- en: "The posted date of this note"
- - name: "viaMobile"
- type: "boolean"
- optional: true
- desc:
- ja: "モバイル端末から投稿したか否か(自己申告であることに留意)"
- en: "Whether this note sent via a mobile device"
- - name: "text"
- type: "string"
- optional: true
- desc:
- ja: "投稿の本文 (ローカルの場合Markdown風のフォーマット)"
- en: "The text of this note (in Markdown like format if local)"
- - name: "mediaIds"
- type: "id(DriveFile)[]"
- optional: true
- desc:
- ja: "添付されているメディアのID (なければレスポンスでは空配列)"
- en: "The IDs of the attached media (empty array for response if no media is attached)"
- - name: "media"
- type: "entity(DriveFile)[]"
- optional: true
- desc:
- ja: "添付されているメディア"
- en: "The attached media"
- - name: "userId"
- type: "id(User)"
- optional: false
- desc:
- ja: "投稿者ID"
- en: "The ID of author of this note"
- - name: "user"
- type: "entity(User)"
- optional: true
- desc:
- ja: "投稿者"
- en: "The author of this note"
- - name: "myReaction"
- type: "string"
- optional: true
- desc:
- ja: "この投稿に対する自分のリアクション"
- en: "The your reaction of this note"
- - name: "reactionCounts"
- type: "object"
- optional: false
- desc:
- ja: "リアクションをキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
- - name: "replyId"
- type: "id(Note)"
- optional: true
- desc:
- ja: "返信した投稿のID"
- en: "The ID of the replyed note"
- - name: "reply"
- type: "entity(Note)"
- optional: true
- desc:
- ja: "返信した投稿"
- en: "The replyed note"
- - name: "renoteId"
- type: "id(Note)"
- optional: true
- desc:
- ja: "引用した投稿のID"
- en: "The ID of the quoted note"
- - name: "renote"
- type: "entity(Note)"
- optional: true
- desc:
- ja: "引用した投稿"
- en: "The quoted note"
- - name: "poll"
- type: "object"
- optional: true
- desc:
- ja: "投票"
- en: "The poll"
- defName: "poll"
- def:
- - name: "choices"
- type: "object[]"
- optional: false
- desc:
- ja: "投票の選択肢"
- en: "The choices of this poll"
- defName: "choice"
- def:
- - name: "id"
- type: "number"
- optional: false
- desc:
- ja: "選択肢ID"
- en: "The ID of this choice"
- - name: "isVoted"
- type: "boolean"
- optional: true
- desc:
- ja: "自分がこの選択肢に投票したかどうか"
- en: "Whether you voted to this choice"
- - name: "text"
- type: "string"
- optional: false
- desc:
- ja: "選択肢本文"
- en: "The text of this choice"
- - name: "votes"
- type: "number"
- optional: false
- desc:
- ja: "この選択肢に投票された数"
- en: "The number voted for this choice"
- - name: "geo"
- type: "object"
- optional: true
- desc:
- ja: "位置情報"
- en: "Geo location"
- defName: "geo"
- def:
- - name: "coordinates"
- type: "number[]"
- optional: false
- desc:
- ja: "座標。最初に経度:-180〜180で表す。最後に緯度:-90〜90で表す。"
- - name: "altitude"
- type: "number"
- optional: false
- desc:
- ja: "高度。メートル単位で表す。"
- - name: "accuracy"
- type: "number"
- optional: false
- desc:
- ja: "緯度、経度の精度。メートル単位で表す。"
- - name: "altitudeAccuracy"
- type: "number"
- optional: false
- desc:
- ja: "高度の精度。メートル単位で表す。"
- - name: "heading"
- type: "number"
- optional: false
- desc:
- ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
- - name: "speed"
- type: "number"
- optional: false
- desc:
- ja: "速度。メートル / 秒数で表す。"
diff --git a/src/docs/api/entities/user.yaml b/src/docs/api/entities/user.yaml
index 3328734d2..22613e02f 100644
--- a/src/docs/api/entities/user.yaml
+++ b/src/docs/api/entities/user.yaml
@@ -135,6 +135,7 @@ props:
desc:
ja: "連携されているTwitterアカウント情報"
en: "The info of the connected twitter account of this user"
+
props:
userId:
type: "string"
@@ -142,6 +143,7 @@ props:
desc:
ja: "ユーザーID"
en: "The user ID"
+
screenName:
type: "string"
optional: false
@@ -162,6 +164,7 @@ props:
desc:
ja: "プロフィール"
en: "The profile of this user"
+
props:
location:
type: "string"
@@ -169,6 +172,7 @@ props:
desc:
ja: "場所"
en: "The location of this user"
+
birthday:
type: "string"
optional: true