Sharkey/src/web/docs/api/endpoints/posts/create.yaml

54 lines
1.1 KiB
YAML
Raw Normal View History

2017-12-14 13:31:17 +09:00
endpoint: "posts/create"
desc:
ja: "投稿します。"
en: "Compose new post."
params:
- name: "text"
type: "string"
2017-12-14 22:36:04 +09:00
optional: true
2017-12-14 13:31:17 +09:00
desc:
ja: "投稿の本文"
en: "Text of a post"
- name: "media_ids"
type: "id(DriveFile)[]"
2017-12-14 16:24:41 +09:00
optional: true
2017-12-14 13:31:17 +09:00
desc:
2017-12-14 22:50:41 +09:00
ja: "添付するメディア(1~4つ)"
en: "Media you want to attach (1~4)"
2017-12-14 13:31:17 +09:00
- name: "reply_id"
type: "id(Post)"
2017-12-14 16:24:41 +09:00
optional: true
2017-12-14 13:31:17 +09:00
desc:
ja: "返信する投稿"
en: "A post you want to reply"
- name: "repost_id"
type: "id(Post)"
2017-12-14 16:24:41 +09:00
optional: true
2017-12-14 13:31:17 +09:00
desc:
ja: "引用する投稿"
en: "A post you want to quote"
- name: "poll"
2017-12-14 22:36:04 +09:00
type: "object"
2017-12-14 16:24:41 +09:00
optional: true
2017-12-14 13:31:17 +09:00
desc:
ja: "投票"
en: "A poll"
2017-12-14 22:36:04 +09:00
defName: "poll"
def:
- name: "choices"
type: "string[]"
optional: false
desc:
ja: "投票の選択肢"
en: "Choices of a poll"
2017-12-14 13:31:17 +09:00
res:
- name: "created_post"
type: "entity(Post)"
2017-12-14 16:24:41 +09:00
optional: false
2017-12-14 13:31:17 +09:00
desc:
ja: "作成した投稿"
en: "A post that created"