Sharkey/src/server/web/docs/api/endpoints/posts/create.yaml
2018-03-29 14:48:47 +09:00

53 lines
1.1 KiB
YAML

endpoint: "posts/create"
desc:
ja: "投稿します。"
en: "Compose new post."
params:
- name: "text"
type: "string"
optional: true
desc:
ja: "投稿の本文"
en: "The text of your post"
- name: "mediaIds"
type: "id(DriveFile)[]"
optional: true
desc:
ja: "添付するメディア(1~4つ)"
en: "Media you want to attach (1~4)"
- name: "replyId"
type: "id(Post)"
optional: true
desc:
ja: "返信する投稿"
en: "The post you want to reply"
- name: "repostId"
type: "id(Post)"
optional: true
desc:
ja: "引用する投稿"
en: "The post you want to quote"
- name: "poll"
type: "object"
optional: true
desc:
ja: "投票"
en: "The poll"
defName: "poll"
def:
- name: "choices"
type: "string[]"
optional: false
desc:
ja: "投票の選択肢"
en: "Choices of a poll"
res:
- name: "createdPost"
type: "entity(Post)"
optional: false
desc:
ja: "作成した投稿"
en: "A post that created"