diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-04-08 02:30:37 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-04-08 02:30:37 +0900 |
| commit | a1b490afa756a71b9cef4afa424575bc223bc612 (patch) | |
| tree | 06de4d839e17b1e08e0891542af7360c701a154a /src/client/docs/api/entities | |
| parent | Merge pull request #1392 from syuilo/greenkeeper/element-ui-2.3.3 (diff) | |
| download | sharkey-a1b490afa756a71b9cef4afa424575bc223bc612.tar.gz sharkey-a1b490afa756a71b9cef4afa424575bc223bc612.tar.bz2 sharkey-a1b490afa756a71b9cef4afa424575bc223bc612.zip | |
Post --> Note
Closes #1411
Diffstat (limited to 'src/client/docs/api/entities')
| -rw-r--r-- | src/client/docs/api/entities/note.yaml | 174 | ||||
| -rw-r--r-- | src/client/docs/api/entities/post.yaml | 40 | ||||
| -rw-r--r-- | src/client/docs/api/entities/user.yaml | 16 |
3 files changed, 202 insertions, 28 deletions
diff --git a/src/client/docs/api/entities/note.yaml b/src/client/docs/api/entities/note.yaml new file mode 100644 index 0000000000..718d331d13 --- /dev/null +++ b/src/client/docs/api/entities/note.yaml @@ -0,0 +1,174 @@ +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: "textHtml" + type: "string" + optional: true + desc: + ja: "投稿の本文 (HTML) (投稿時は無視)" + en: "The text of this note (in HTML. Ignored when posting.)" + - 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: "速度。メートル / 秒数で表す。" diff --git a/src/client/docs/api/entities/post.yaml b/src/client/docs/api/entities/post.yaml index 7077700129..718d331d13 100644 --- a/src/client/docs/api/entities/post.yaml +++ b/src/client/docs/api/entities/post.yaml @@ -1,8 +1,8 @@ -name: "Post" +name: "Note" desc: ja: "投稿。" - en: "A post." + en: "A note." props: - name: "id" @@ -10,31 +10,31 @@ props: optional: false desc: ja: "投稿ID" - en: "The ID of this post" + en: "The ID of this note" - name: "createdAt" type: "date" optional: false desc: ja: "投稿日時" - en: "The posted date of this post" + en: "The posted date of this note" - name: "viaMobile" type: "boolean" optional: true desc: ja: "モバイル端末から投稿したか否か(自己申告であることに留意)" - en: "Whether this post sent via a mobile device" + en: "Whether this note sent via a mobile device" - name: "text" type: "string" optional: true desc: ja: "投稿の本文 (ローカルの場合Markdown風のフォーマット)" - en: "The text of this post (in Markdown like format if local)" + en: "The text of this note (in Markdown like format if local)" - name: "textHtml" type: "string" optional: true desc: ja: "投稿の本文 (HTML) (投稿時は無視)" - en: "The text of this post (in HTML. Ignored when posting.)" + en: "The text of this note (in HTML. Ignored when posting.)" - name: "mediaIds" type: "id(DriveFile)[]" optional: true @@ -52,48 +52,48 @@ props: optional: false desc: ja: "投稿者ID" - en: "The ID of author of this post" + en: "The ID of author of this note" - name: "user" type: "entity(User)" optional: true desc: ja: "投稿者" - en: "The author of this post" + 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 post" + 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(Post)" + type: "id(Note)" optional: true desc: ja: "返信した投稿のID" - en: "The ID of the replyed post" + en: "The ID of the replyed note" - name: "reply" - type: "entity(Post)" + type: "entity(Note)" optional: true desc: ja: "返信した投稿" - en: "The replyed post" - - name: "repostId" - type: "id(Post)" + en: "The replyed note" + - name: "renoteId" + type: "id(Note)" optional: true desc: ja: "引用した投稿のID" - en: "The ID of the quoted post" - - name: "repost" - type: "entity(Post)" + en: "The ID of the quoted note" + - name: "renote" + type: "entity(Note)" optional: true desc: ja: "引用した投稿" - en: "The quoted post" + en: "The quoted note" - name: "poll" type: "object" optional: true diff --git a/src/client/docs/api/entities/user.yaml b/src/client/docs/api/entities/user.yaml index a1fae1482b..cccf42f221 100644 --- a/src/client/docs/api/entities/user.yaml +++ b/src/client/docs/api/entities/user.yaml @@ -81,24 +81,24 @@ props: desc: ja: "自分がこのユーザーをミュートしているか" en: "Whether you muted this user" - - name: "postsCount" + - name: "notesCount" type: "number" optional: false desc: ja: "投稿の数" - en: "The number of the posts of this user" - - name: "pinnedPost" - type: "entity(Post)" + en: "The number of the notes of this user" + - name: "pinnedNote" + type: "entity(Note)" optional: true desc: ja: "ピン留めされた投稿" - en: "The pinned post of this user" - - name: "pinnedPostId" - type: "id(Post)" + en: "The pinned note of this user" + - name: "pinnedNoteId" + type: "id(Note)" optional: true desc: ja: "ピン留めされた投稿のID" - en: "The ID of the pinned post of this user" + en: "The ID of the pinned note of this user" - name: "driveCapacity" type: "number" optional: false |