summaryrefslogtreecommitdiff
path: root/src/client/docs/api/endpoints/notes/create.yaml
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-04-08 02:30:37 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-04-08 02:30:37 +0900
commita1b490afa756a71b9cef4afa424575bc223bc612 (patch)
tree06de4d839e17b1e08e0891542af7360c701a154a /src/client/docs/api/endpoints/notes/create.yaml
parentMerge pull request #1392 from syuilo/greenkeeper/element-ui-2.3.3 (diff)
downloadsharkey-a1b490afa756a71b9cef4afa424575bc223bc612.tar.gz
sharkey-a1b490afa756a71b9cef4afa424575bc223bc612.tar.bz2
sharkey-a1b490afa756a71b9cef4afa424575bc223bc612.zip
Post --> Note
Closes #1411
Diffstat (limited to 'src/client/docs/api/endpoints/notes/create.yaml')
-rw-r--r--src/client/docs/api/endpoints/notes/create.yaml59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/client/docs/api/endpoints/notes/create.yaml b/src/client/docs/api/endpoints/notes/create.yaml
new file mode 100644
index 0000000000..04ada2ecd5
--- /dev/null
+++ b/src/client/docs/api/endpoints/notes/create.yaml
@@ -0,0 +1,59 @@
+endpoint: "notes/create"
+
+desc:
+ ja: "投稿します。"
+ en: "Compose new note."
+
+params:
+ - name: "text"
+ type: "string"
+ optional: true
+ desc:
+ ja: "投稿の本文"
+ en: "The text of your note"
+ - name: "cw"
+ type: "string"
+ optional: true
+ desc:
+ ja: "コンテンツの警告。このパラメータを指定すると設定したテキストで投稿のコンテンツを隠す事が出来ます。"
+ en: "Content Warning"
+ - name: "mediaIds"
+ type: "id(DriveFile)[]"
+ optional: true
+ desc:
+ ja: "添付するメディア(1~4つ)"
+ en: "Media you want to attach (1~4)"
+ - name: "replyId"
+ type: "id(Note)"
+ optional: true
+ desc:
+ ja: "返信する投稿"
+ en: "The note you want to reply"
+ - name: "renoteId"
+ type: "id(Note)"
+ optional: true
+ desc:
+ ja: "引用する投稿"
+ en: "The note 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: "createdNote"
+ type: "entity(Note)"
+ optional: false
+ desc:
+ ja: "作成した投稿"
+ en: "A note that created"