summaryrefslogtreecommitdiff
path: root/src/web/docs/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-12-15 05:07:21 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-12-15 05:07:21 +0900
commit5725e39a707af39c0a5118a04282bbaf186ee922 (patch)
tree48c06548f05837b3c71571cc7bb1493d4e83e403 /src/web/docs/api
parent:art: (diff)
downloadsharkey-5725e39a707af39c0a5118a04282bbaf186ee922.tar.gz
sharkey-5725e39a707af39c0a5118a04282bbaf186ee922.tar.bz2
sharkey-5725e39a707af39c0a5118a04282bbaf186ee922.zip
:v:
Diffstat (limited to 'src/web/docs/api')
-rw-r--r--src/web/docs/api/entities/user.pug122
-rw-r--r--src/web/docs/api/entities/user.yaml10
2 files changed, 10 insertions, 122 deletions
diff --git a/src/web/docs/api/entities/user.pug b/src/web/docs/api/entities/user.pug
deleted file mode 100644
index a37886bb19..0000000000
--- a/src/web/docs/api/entities/user.pug
+++ /dev/null
@@ -1,122 +0,0 @@
-extend ../../BASE
-
-block title
- | Entity: User
-
-block content
- h1 User
- p ユーザーを表します。
-
- section
- h2 Properties
- table.entity
- thead: tr
- td Name
- td Type
- td Description
- tbody
- tr.nullable.optional
- td avatar_id
- td ID
- td アバターに設定しているドライブのファイルのID
- tr.nullable
- td avatar_url
- td String
- td アバターURL
- tr.nullable.optional
- td banner_id
- td ID
- td バナーに設定しているドライブのファイルのID
- tr.nullable
- td banner_url
- td String
- td バナーURL
- tr.nullable
- td bio
- td String
- td プロフィール
- tr.nullable
- td birthday
- td String
- td 誕生日(YYYY-MM-DD)
- tr
- td created_at
- td Date
- td アカウント作成日時
- tr.optional
- td drive_capacity
- td Number
- td ドライブの最大容量(byte単位)
- tr
- td followers_count
- td Number
- td フォロワー数
- tr
- td following_count
- td Number
- td フォロー数
- tr
- td id
- td ID
- td ユーザーID
- tr.optional
- td is_bot
- td Boolean
- td botかどうか
- tr.optional
- td is_followed
- td Boolean
- td フォローされているか
- tr.optional
- td is_following
- td Boolean
- td フォローしているか
- tr
- td liked_count
- td Number
- td 投稿にいいねされた数
- tr
- td likes_count
- td Number
- td 投稿にいいねした数
- tr.nullable
- td location
- td String
- td 住処
- tr
- td name
- td String
- td ニックネーム
- tr
- td posts_count
- td Number
- td 投稿数
- tr
- td username
- td String
- td ユーザー名
-
- section
- h2 Example
- pre: code.
- {
- "avatar_id": "583ddc6e64df272771f74c1a",
- "avatar_url": "https://file.himasaku.net/583ddc6e64df272771f74c1a",
- "banner_id": "584bfc82d8e5186f8f755ec5",
- "banner_url": "https://file.himasaku.net/584bfc82d8e5186f8f755ec5",
- "bio": "どうすれば君だけのために生きていけるの",
- "birthday": "1997-12-06",
- "created_at": "2016-09-07T13:46:56.605Z",
- "drive_capacity": 1073741824,
- "email": null,
- "followers_count": 51,
- "following_count": 97,
- "id": "57d01a501fdf2d07be417afe",
- "liked_count": 750,
- "likes_count": 3130,
- "links": null,
- "location": "川崎",
- "name": "きな子",
- "posts_count": 4811,
- "username": "syuilo"
- }
diff --git a/src/web/docs/api/entities/user.yaml b/src/web/docs/api/entities/user.yaml
index 9b1efd1fe6..abc3f300d2 100644
--- a/src/web/docs/api/entities/user.yaml
+++ b/src/web/docs/api/entities/user.yaml
@@ -65,6 +65,16 @@ props:
desc:
ja: "フォローしているユーザーの数"
en: "The number of the following users for this user"
+ - name: "is_following"
+ type: "boolean"
+ optional: true
+ desc:
+ ja: "自分がこのユーザーをフォローしているか"
+ - name: "is_followed"
+ type: "boolean"
+ optional: true
+ desc:
+ ja: "自分がこのユーザーにフォローされているか"
- name: "last_used_at"
type: "date"
optional: false