summaryrefslogtreecommitdiff
path: root/src/server/web/docs/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-03-29 14:48:47 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-03-29 14:48:47 +0900
commitbfc193d8cd9aecdb82d585e8b4e101deac60a5bb (patch)
tree8b4dac3a56cf703650c8207f9279028a8560a96b /src/server/web/docs/api
parentresolve conflict (diff)
downloadsharkey-bfc193d8cd9aecdb82d585e8b4e101deac60a5bb.tar.gz
sharkey-bfc193d8cd9aecdb82d585e8b4e101deac60a5bb.tar.bz2
sharkey-bfc193d8cd9aecdb82d585e8b4e101deac60a5bb.zip
Resolve conflicts
Diffstat (limited to 'src/server/web/docs/api')
-rw-r--r--src/server/web/docs/api/endpoints/posts/create.yaml8
-rw-r--r--src/server/web/docs/api/endpoints/posts/timeline.yaml8
-rw-r--r--src/server/web/docs/api/entities/drive-file.yaml6
-rw-r--r--src/server/web/docs/api/entities/post.yaml18
-rw-r--r--src/server/web/docs/api/entities/user.yaml36
5 files changed, 38 insertions, 38 deletions
diff --git a/src/server/web/docs/api/endpoints/posts/create.yaml b/src/server/web/docs/api/endpoints/posts/create.yaml
index 5e2307dab4..11d9f40c54 100644
--- a/src/server/web/docs/api/endpoints/posts/create.yaml
+++ b/src/server/web/docs/api/endpoints/posts/create.yaml
@@ -11,19 +11,19 @@ params:
desc:
ja: "投稿の本文"
en: "The text of your post"
- - name: "media_ids"
+ - name: "mediaIds"
type: "id(DriveFile)[]"
optional: true
desc:
ja: "添付するメディア(1~4つ)"
en: "Media you want to attach (1~4)"
- - name: "reply_id"
+ - name: "replyId"
type: "id(Post)"
optional: true
desc:
ja: "返信する投稿"
en: "The post you want to reply"
- - name: "repost_id"
+ - name: "repostId"
type: "id(Post)"
optional: true
desc:
@@ -45,7 +45,7 @@ params:
en: "Choices of a poll"
res:
- - name: "created_post"
+ - name: "createdPost"
type: "entity(Post)"
optional: false
desc:
diff --git a/src/server/web/docs/api/endpoints/posts/timeline.yaml b/src/server/web/docs/api/endpoints/posts/timeline.yaml
index 01976b0611..9c44dd736a 100644
--- a/src/server/web/docs/api/endpoints/posts/timeline.yaml
+++ b/src/server/web/docs/api/endpoints/posts/timeline.yaml
@@ -10,22 +10,22 @@ params:
optional: true
desc:
ja: "取得する最大の数"
- - name: "since_id"
+ - name: "sinceId"
type: "id(Post)"
optional: true
desc:
ja: "指定すると、この投稿を基点としてより新しい投稿を取得します"
- - name: "until_id"
+ - name: "untilId"
type: "id(Post)"
optional: true
desc:
ja: "指定すると、この投稿を基点としてより古い投稿を取得します"
- - name: "since_date"
+ - name: "sinceDate"
type: "number"
optional: true
desc:
ja: "指定した時間を基点としてより新しい投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
- - name: "until_date"
+ - name: "untilDate"
type: "number"
optional: true
desc:
diff --git a/src/server/web/docs/api/entities/drive-file.yaml b/src/server/web/docs/api/entities/drive-file.yaml
index 2ebbb089ab..02ab0d608e 100644
--- a/src/server/web/docs/api/entities/drive-file.yaml
+++ b/src/server/web/docs/api/entities/drive-file.yaml
@@ -11,13 +11,13 @@ props:
desc:
ja: "ファイルID"
en: "The ID of this file"
- - name: "created_at"
+ - name: "createdAt"
type: "date"
optional: false
desc:
ja: "アップロード日時"
en: "The upload date of this file"
- - name: "user_id"
+ - name: "userId"
type: "id(User)"
optional: false
desc:
@@ -59,7 +59,7 @@ props:
desc:
ja: "ファイルのURL"
en: "The URL of this file"
- - name: "folder_id"
+ - name: "folderId"
type: "id(DriveFolder)"
optional: true
desc:
diff --git a/src/server/web/docs/api/entities/post.yaml b/src/server/web/docs/api/entities/post.yaml
index f780263144..71b6a64123 100644
--- a/src/server/web/docs/api/entities/post.yaml
+++ b/src/server/web/docs/api/entities/post.yaml
@@ -11,13 +11,13 @@ props:
desc:
ja: "投稿ID"
en: "The ID of this post"
- - name: "created_at"
+ - name: "createdAt"
type: "date"
optional: false
desc:
ja: "投稿日時"
en: "The posted date of this post"
- - name: "via_mobile"
+ - name: "viaMobile"
type: "boolean"
optional: true
desc:
@@ -29,7 +29,7 @@ props:
desc:
ja: "投稿の本文"
en: "The text of this post"
- - name: "media_ids"
+ - name: "mediaIds"
type: "id(DriveFile)[]"
optional: true
desc:
@@ -41,7 +41,7 @@ props:
desc:
ja: "添付されているメディア"
en: "The attached media"
- - name: "user_id"
+ - name: "userId"
type: "id(User)"
optional: false
desc:
@@ -53,18 +53,18 @@ props:
desc:
ja: "投稿者"
en: "The author of this post"
- - name: "my_reaction"
+ - name: "myReaction"
type: "string"
optional: true
desc:
ja: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
en: "The your <a href='/docs/api/reactions'>reaction</a> of this post"
- - name: "reaction_counts"
+ - name: "reactionCounts"
type: "object"
optional: false
desc:
ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
- - name: "reply_id"
+ - name: "replyId"
type: "id(Post)"
optional: true
desc:
@@ -76,7 +76,7 @@ props:
desc:
ja: "返信した投稿"
en: "The replyed post"
- - name: "repost_id"
+ - name: "repostId"
type: "id(Post)"
optional: true
desc:
@@ -110,7 +110,7 @@ props:
desc:
ja: "選択肢ID"
en: "The ID of this choice"
- - name: "is_voted"
+ - name: "isVoted"
type: "boolean"
optional: true
desc:
diff --git a/src/server/web/docs/api/entities/user.yaml b/src/server/web/docs/api/entities/user.yaml
index a451a40807..a1fae1482b 100644
--- a/src/server/web/docs/api/entities/user.yaml
+++ b/src/server/web/docs/api/entities/user.yaml
@@ -11,7 +11,7 @@ props:
desc:
ja: "ユーザーID"
en: "The ID of this user"
- - name: "created_at"
+ - name: "createdAt"
type: "date"
optional: false
desc:
@@ -29,77 +29,77 @@ props:
desc:
ja: "アカウントの説明(自己紹介)"
en: "The description of this user"
- - name: "avatar_id"
+ - name: "avatarId"
type: "id(DriveFile)"
optional: true
desc:
ja: "アバターのID"
en: "The ID of the avatar of this user"
- - name: "avatar_url"
+ - name: "avatarUrl"
type: "string"
optional: false
desc:
ja: "アバターのURL"
en: "The URL of the avatar of this user"
- - name: "banner_id"
+ - name: "bannerId"
type: "id(DriveFile)"
optional: true
desc:
ja: "バナーのID"
en: "The ID of the banner of this user"
- - name: "banner_url"
+ - name: "bannerUrl"
type: "string"
optional: false
desc:
ja: "バナーのURL"
en: "The URL of the banner of this user"
- - name: "followers_count"
+ - name: "followersCount"
type: "number"
optional: false
desc:
ja: "フォロワーの数"
en: "The number of the followers for this user"
- - name: "following_count"
+ - name: "followingCount"
type: "number"
optional: false
desc:
ja: "フォローしているユーザーの数"
en: "The number of the following users for this user"
- - name: "is_following"
+ - name: "isFollowing"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーをフォローしているか"
- - name: "is_followed"
+ - name: "isFollowed"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーにフォローされているか"
- - name: "is_muted"
+ - name: "isMuted"
type: "boolean"
optional: true
desc:
ja: "自分がこのユーザーをミュートしているか"
en: "Whether you muted this user"
- - name: "posts_count"
+ - name: "postsCount"
type: "number"
optional: false
desc:
ja: "投稿の数"
en: "The number of the posts of this user"
- - name: "pinned_post"
+ - name: "pinnedPost"
type: "entity(Post)"
optional: true
desc:
ja: "ピン留めされた投稿"
en: "The pinned post of this user"
- - name: "pinned_post_id"
+ - name: "pinnedPostId"
type: "id(Post)"
optional: true
desc:
ja: "ピン留めされた投稿のID"
en: "The ID of the pinned post of this user"
- - name: "drive_capacity"
+ - name: "driveCapacity"
type: "number"
optional: false
desc:
@@ -119,13 +119,13 @@ props:
en: "The account of this user on this server"
defName: "account"
def:
- - name: "last_used_at"
+ - name: "lastUsedAt"
type: "date"
optional: false
desc:
ja: "最終利用日時"
en: "The last used date of this user"
- - name: "is_bot"
+ - name: "isBot"
type: "boolean"
optional: true
desc:
@@ -139,13 +139,13 @@ props:
en: "The info of the connected twitter account of this user"
defName: "twitter"
def:
- - name: "user_id"
+ - name: "userId"
type: "string"
optional: false
desc:
ja: "ユーザーID"
en: "The user ID"
- - name: "screen_name"
+ - name: "screenName"
type: "string"
optional: false
desc: