Update docs

This commit is contained in:
syuilo 2018-07-16 05:47:41 +09:00
parent 9e438ed674
commit 1e921a9fd5
4 changed files with 80 additions and 212 deletions

View File

@ -5,67 +5,77 @@ desc:
en: "A file of Drive." en: "A file of Drive."
props: props:
- name: "id" id:
type: "id" type: "id"
optional: false optional: false
desc: desc:
ja: "ファイルID" ja: "ファイルID"
en: "The ID of this file" en: "The ID of this file"
- name: "createdAt"
createdAt:
type: "date" type: "date"
optional: false optional: false
desc: desc:
ja: "アップロード日時" ja: "アップロード日時"
en: "The upload date of this file" en: "The upload date of this file"
- name: "userId"
userId:
type: "id(User)" type: "id(User)"
optional: false optional: false
desc: desc:
ja: "所有者ID" ja: "所有者ID"
en: "The ID of the owner of this file" en: "The ID of the owner of this file"
- name: "user"
user:
type: "entity(User)" type: "entity(User)"
optional: true optional: true
desc: desc:
ja: "所有者" ja: "所有者"
en: "The owner of this file" en: "The owner of this file"
- name: "name"
name:
type: "string" type: "string"
optional: false optional: false
desc: desc:
ja: "ファイル名" ja: "ファイル名"
en: "The name of this file" en: "The name of this file"
- name: "md5"
md5:
type: "string" type: "string"
optional: false optional: false
desc: desc:
ja: "ファイルのMD5ハッシュ値" ja: "ファイルのMD5ハッシュ値"
en: "The md5 hash value of this file" en: "The md5 hash value of this file"
- name: "type"
type:
type: "string" type: "string"
optional: false optional: false
desc: desc:
ja: "ファイルの種類" ja: "ファイルの種類"
en: "The type of this file" en: "The type of this file"
- name: "datasize"
datasize:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "ファイルサイズ(bytes)" ja: "ファイルサイズ(bytes)"
en: "The size of this file (bytes)" en: "The size of this file (bytes)"
- name: "url"
url:
type: "string" type: "string"
optional: false optional: false
desc: desc:
ja: "ファイルのURL" ja: "ファイルのURL"
en: "The URL of this file" en: "The URL of this file"
- name: "folderId"
folderId:
type: "id(DriveFolder)" type: "id(DriveFolder)"
optional: true optional: true
desc: desc:
ja: "フォルダID" ja: "フォルダID"
en: "The ID of the folder of this file" en: "The ID of the folder of this file"
- name: "folder"
folder:
type: "entity(DriveFolder)" type: "entity(DriveFolder)"
optional: true optional: true
desc: desc:

View File

@ -5,163 +5,185 @@ desc:
en: "A note." en: "A note."
props: props:
- name: "id" id:
type: "id" type: "id"
optional: false optional: false
desc: desc:
ja: "投稿ID" ja: "投稿ID"
en: "The ID of this note" en: "The ID of this note"
- name: "createdAt"
createdAt:
type: "date" type: "date"
optional: false optional: false
desc: desc:
ja: "投稿日時" ja: "投稿日時"
en: "The posted date of this note" en: "The posted date of this note"
- name: "viaMobile"
viaMobile:
type: "boolean" type: "boolean"
optional: true optional: true
desc: desc:
ja: "モバイル端末から投稿したか否か(自己申告であることに留意)" ja: "モバイル端末から投稿したか否か(自己申告であることに留意)"
en: "Whether this note sent via a mobile device" en: "Whether this note sent via a mobile device"
- name: "text"
text:
type: "string" type: "string"
optional: true optional: true
desc: desc:
ja: "投稿の本文" ja: "投稿の本文"
en: "The text of this note" en: "The text of this note"
- name: "mediaIds"
mediaIds:
type: "id(DriveFile)[]" type: "id(DriveFile)[]"
optional: true optional: true
desc: desc:
ja: "添付されているメディアのID (なければレスポンスでは空配列)" ja: "添付されているメディアのID (なければレスポンスでは空配列)"
en: "The IDs of the attached media (empty array for response if no media is attached)" en: "The IDs of the attached media (empty array for response if no media is attached)"
- name: "media"
media:
type: "entity(DriveFile)[]" type: "entity(DriveFile)[]"
optional: true optional: true
desc: desc:
ja: "添付されているメディア" ja: "添付されているメディア"
en: "The attached media" en: "The attached media"
- name: "userId"
userId:
type: "id(User)" type: "id(User)"
optional: false optional: false
desc: desc:
ja: "投稿者ID" ja: "投稿者ID"
en: "The ID of author of this note" en: "The ID of author of this note"
- name: "user"
user:
type: "entity(User)" type: "entity(User)"
optional: true optional: true
desc: desc:
ja: "投稿者" ja: "投稿者"
en: "The author of this note" en: "The author of this note"
- name: "myReaction"
myReaction:
type: "string" type: "string"
optional: true optional: true
desc: desc:
ja: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>" ja: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
en: "The your <a href='/docs/api/reactions'>reaction</a> of this note" en: "The your <a href='/docs/api/reactions'>reaction</a> of this note"
- name: "reactionCounts"
reactionCounts:
type: "object" type: "object"
optional: false optional: false
desc: desc:
ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト" ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
- name: "replyId"
replyId:
type: "id(Note)" type: "id(Note)"
optional: true optional: true
desc: desc:
ja: "返信した投稿のID" ja: "返信した投稿のID"
en: "The ID of the replyed note" en: "The ID of the replyed note"
- name: "reply"
reply:
type: "entity(Note)" type: "entity(Note)"
optional: true optional: true
desc: desc:
ja: "返信した投稿" ja: "返信した投稿"
en: "The replyed note" en: "The replyed note"
- name: "renoteId"
renoteId:
type: "id(Note)" type: "id(Note)"
optional: true optional: true
desc: desc:
ja: "引用した投稿のID" ja: "引用した投稿のID"
en: "The ID of the quoted note" en: "The ID of the quoted note"
- name: "renote"
renote:
type: "entity(Note)" type: "entity(Note)"
optional: true optional: true
desc: desc:
ja: "引用した投稿" ja: "引用した投稿"
en: "The quoted note" en: "The quoted note"
- name: "poll"
poll:
type: "object" type: "object"
optional: true optional: true
desc: desc:
ja: "投票" ja: "投票"
en: "The poll" en: "The poll"
defName: "poll"
def: props:
- name: "choices" choices:
type: "object[]" type: "object[]"
optional: false optional: false
desc: desc:
ja: "投票の選択肢" ja: "投票の選択肢"
en: "The choices of this poll" en: "The choices of this poll"
defName: "choice"
def: props:
- name: "id" id:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "選択肢ID" ja: "選択肢ID"
en: "The ID of this choice" en: "The ID of this choice"
- name: "isVoted"
isVoted:
type: "boolean" type: "boolean"
optional: true optional: true
desc: desc:
ja: "自分がこの選択肢に投票したかどうか" ja: "自分がこの選択肢に投票したかどうか"
en: "Whether you voted to this choice" en: "Whether you voted to this choice"
- name: "text"
text:
type: "string" type: "string"
optional: false optional: false
desc: desc:
ja: "選択肢本文" ja: "選択肢本文"
en: "The text of this choice" en: "The text of this choice"
- name: "votes"
votes:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "この選択肢に投票された数" ja: "この選択肢に投票された数"
en: "The number voted for this choice" en: "The number voted for this choice"
- name: "geo" geo:
type: "object" type: "object"
optional: true optional: true
desc: desc:
ja: "位置情報" ja: "位置情報"
en: "Geo location" en: "Geo location"
defName: "geo"
def: props:
- name: "coordinates" coordinates:
type: "number[]" type: "number[]"
optional: false optional: false
desc: desc:
ja: "座標。最初に経度:-180〜180で表す。最後に緯度-90〜90で表す。" ja: "座標。最初に経度:-180〜180で表す。最後に緯度-90〜90で表す。"
- name: "altitude"
altitude:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "高度。メートル単位で表す。" ja: "高度。メートル単位で表す。"
- name: "accuracy"
accuracy:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "緯度、経度の精度。メートル単位で表す。" ja: "緯度、経度の精度。メートル単位で表す。"
- name: "altitudeAccuracy"
altitudeAccuracy:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "高度の精度。メートル単位で表す。" ja: "高度の精度。メートル単位で表す。"
- name: "heading"
heading:
type: "number" type: "number"
optional: false optional: false
desc: desc:
ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。" ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
- name: "speed"
speed:
type: "number" type: "number"
optional: false optional: false
desc: desc:

View File

@ -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: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
en: "The your <a href='/docs/api/reactions'>reaction</a> of this note"
- name: "reactionCounts"
type: "object"
optional: false
desc:
ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
- 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: "速度。メートル / 秒数で表す。"

View File

@ -135,6 +135,7 @@ props:
desc: desc:
ja: "連携されているTwitterアカウント情報" ja: "連携されているTwitterアカウント情報"
en: "The info of the connected twitter account of this user" en: "The info of the connected twitter account of this user"
props: props:
userId: userId:
type: "string" type: "string"
@ -142,6 +143,7 @@ props:
desc: desc:
ja: "ユーザーID" ja: "ユーザーID"
en: "The user ID" en: "The user ID"
screenName: screenName:
type: "string" type: "string"
optional: false optional: false
@ -162,6 +164,7 @@ props:
desc: desc:
ja: "プロフィール" ja: "プロフィール"
en: "The profile of this user" en: "The profile of this user"
props: props:
location: location:
type: "string" type: "string"
@ -169,6 +172,7 @@ props:
desc: desc:
ja: "場所" ja: "場所"
en: "The location of this user" en: "The location of this user"
birthday: birthday:
type: "string" type: "string"
optional: true optional: true