summaryrefslogtreecommitdiff
path: root/src/web/docs/api/endpoints/posts
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-12-16 05:04:02 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-12-16 05:04:02 +0900
commit446b6a4f6bb376abdd6ebee5546f568d8c5dbc83 (patch)
treefb2e515aca023618f7c29cdcda0cff14d864bd62 /src/web/docs/api/endpoints/posts
parent:v: (diff)
downloadsharkey-446b6a4f6bb376abdd6ebee5546f568d8c5dbc83.tar.gz
sharkey-446b6a4f6bb376abdd6ebee5546f568d8c5dbc83.tar.bz2
sharkey-446b6a4f6bb376abdd6ebee5546f568d8c5dbc83.zip
:v:
Diffstat (limited to 'src/web/docs/api/endpoints/posts')
-rw-r--r--src/web/docs/api/endpoints/posts/timeline.yaml32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/web/docs/api/endpoints/posts/timeline.yaml b/src/web/docs/api/endpoints/posts/timeline.yaml
new file mode 100644
index 0000000000..e1d78c082e
--- /dev/null
+++ b/src/web/docs/api/endpoints/posts/timeline.yaml
@@ -0,0 +1,32 @@
+endpoint: "posts/timeline"
+
+desc:
+ ja: "タイムラインを取得します。"
+ en: "Get your timeline."
+
+params:
+ - name: "limit"
+ type: "number"
+ optional: true
+ desc:
+ ja: "取得する最大の数"
+ - name: "since_id"
+ type: "id(Post)"
+ optional: true
+ desc:
+ ja: "指定すると、この投稿を基点としてより新しい投稿を取得します"
+ - name: "max_id"
+ type: "id(Post)"
+ optional: true
+ desc:
+ ja: "指定すると、この投稿を基点としてより古い投稿を取得します"
+ - name: "since_date"
+ type: "number"
+ optional: true
+ desc:
+ ja: "指定した時間を基点としてより新しい投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
+ - name: "max_date"
+ type: "number"
+ optional: true
+ desc:
+ ja: "指定した時間を基点としてより古い投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"