summaryrefslogtreecommitdiff
path: root/src/client/docs/api/endpoints
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
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')
-rw-r--r--src/client/docs/api/endpoints/notes/create.yaml (renamed from src/client/docs/api/endpoints/posts/create.yaml)22
-rw-r--r--src/client/docs/api/endpoints/notes/timeline.yaml (renamed from src/client/docs/api/endpoints/posts/timeline.yaml)6
2 files changed, 14 insertions, 14 deletions
diff --git a/src/client/docs/api/endpoints/posts/create.yaml b/src/client/docs/api/endpoints/notes/create.yaml
index d2d6e27fc7..04ada2ecd5 100644
--- a/src/client/docs/api/endpoints/posts/create.yaml
+++ b/src/client/docs/api/endpoints/notes/create.yaml
@@ -1,8 +1,8 @@
-endpoint: "posts/create"
+endpoint: "notes/create"
desc:
ja: "投稿します。"
- en: "Compose new post."
+ en: "Compose new note."
params:
- name: "text"
@@ -10,7 +10,7 @@ params:
optional: true
desc:
ja: "投稿の本文"
- en: "The text of your post"
+ en: "The text of your note"
- name: "cw"
type: "string"
optional: true
@@ -24,17 +24,17 @@ params:
ja: "添付するメディア(1~4つ)"
en: "Media you want to attach (1~4)"
- name: "replyId"
- type: "id(Post)"
+ type: "id(Note)"
optional: true
desc:
ja: "返信する投稿"
- en: "The post you want to reply"
- - name: "repostId"
- type: "id(Post)"
+ en: "The note you want to reply"
+ - name: "renoteId"
+ type: "id(Note)"
optional: true
desc:
ja: "引用する投稿"
- en: "The post you want to quote"
+ en: "The note you want to quote"
- name: "poll"
type: "object"
optional: true
@@ -51,9 +51,9 @@ params:
en: "Choices of a poll"
res:
- - name: "createdPost"
- type: "entity(Post)"
+ - name: "createdNote"
+ type: "entity(Note)"
optional: false
desc:
ja: "作成した投稿"
- en: "A post that created"
+ en: "A note that created"
diff --git a/src/client/docs/api/endpoints/posts/timeline.yaml b/src/client/docs/api/endpoints/notes/timeline.yaml
index 9c44dd736a..71c346f355 100644
--- a/src/client/docs/api/endpoints/posts/timeline.yaml
+++ b/src/client/docs/api/endpoints/notes/timeline.yaml
@@ -1,4 +1,4 @@
-endpoint: "posts/timeline"
+endpoint: "notes/timeline"
desc:
ja: "タイムラインを取得します。"
@@ -11,12 +11,12 @@ params:
desc:
ja: "取得する最大の数"
- name: "sinceId"
- type: "id(Post)"
+ type: "id(Note)"
optional: true
desc:
ja: "指定すると、この投稿を基点としてより新しい投稿を取得します"
- name: "untilId"
- type: "id(Post)"
+ type: "id(Note)"
optional: true
desc:
ja: "指定すると、この投稿を基点としてより古い投稿を取得します"