summaryrefslogtreecommitdiff
path: root/src/web/docs/api/entities
diff options
context:
space:
mode:
authorAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-26 00:19:07 +0900
committerAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-26 14:07:16 +0900
commit19b9cb105d49e2a00ae19e3dc1f2d36dc394f148 (patch)
tree5faa9ad213bbf2efdcb4d06cf4fc941a501ab7f8 /src/web/docs/api/entities
parentAllow to use domain whose prefix is not misskey (diff)
downloadsharkey-19b9cb105d49e2a00ae19e3dc1f2d36dc394f148.tar.gz
sharkey-19b9cb105d49e2a00ae19e3dc1f2d36dc394f148.tar.bz2
sharkey-19b9cb105d49e2a00ae19e3dc1f2d36dc394f148.zip
Introduce account document to user document
An account document is attached to a user document if an account of the user is on the server. It may be missing if the user is on a remote server.
Diffstat (limited to 'src/web/docs/api/entities')
-rw-r--r--src/web/docs/api/entities/user.yaml94
1 files changed, 51 insertions, 43 deletions
diff --git a/src/web/docs/api/entities/user.yaml b/src/web/docs/api/entities/user.yaml
index 528b9b0e13..f0d5fdbba1 100644
--- a/src/web/docs/api/entities/user.yaml
+++ b/src/web/docs/api/entities/user.yaml
@@ -81,12 +81,6 @@ props:
desc:
ja: "自分がこのユーザーをミュートしているか"
en: "Whether you muted this user"
- - name: "last_used_at"
- type: "date"
- optional: false
- desc:
- ja: "最終利用日時"
- en: "The last used date of this user"
- name: "posts_count"
type: "number"
optional: false
@@ -111,49 +105,63 @@ props:
desc:
ja: "ドライブの容量(bytes)"
en: "The capacity of drive of this user (bytes)"
- - name: "is_bot"
- type: "boolean"
- optional: true
- desc:
- ja: "botか否か(自己申告であることに留意)"
- en: "Whether is bot or not"
- - name: "twitter"
+ - name: "account"
type: "object"
- optional: true
+ optional: false
desc:
- ja: "連携されているTwitterアカウント情報"
- en: "The info of the connected twitter account of this user"
- defName: "twitter"
+ ja: "このサーバーにおけるアカウント"
+ en: "The account of this user on this server"
+ defName: "account"
def:
- - name: "user_id"
- type: "string"
+ - name: "last_used_at"
+ type: "date"
optional: false
desc:
- ja: "ユーザーID"
- en: "The user ID"
- - name: "screen_name"
- type: "string"
- optional: false
- desc:
- ja: "ユーザー名"
- en: "The screen name of this user"
- - name: "profile"
- type: "object"
- optional: false
- desc:
- ja: "プロフィール"
- en: "The profile of this user"
- defName: "profile"
- def:
- - name: "location"
- type: "string"
+ ja: "最終利用日時"
+ en: "The last used date of this user"
+ - name: "is_bot"
+ type: "boolean"
optional: true
desc:
- ja: "場所"
- en: "The location of this user"
- - name: "birthday"
- type: "string"
+ ja: "botか否か(自己申告であることに留意)"
+ en: "Whether is bot or not"
+ - name: "twitter"
+ type: "object"
optional: true
desc:
- ja: "誕生日 (YYYY-MM-DD)"
- en: "The birthday of this user (YYYY-MM-DD)"
+ ja: "連携されているTwitterアカウント情報"
+ en: "The info of the connected twitter account of this user"
+ defName: "twitter"
+ def:
+ - name: "user_id"
+ type: "string"
+ optional: false
+ desc:
+ ja: "ユーザーID"
+ en: "The user ID"
+ - name: "screen_name"
+ type: "string"
+ optional: false
+ desc:
+ ja: "ユーザー名"
+ en: "The screen name of this user"
+ - name: "profile"
+ type: "object"
+ optional: false
+ desc:
+ ja: "プロフィール"
+ en: "The profile of this user"
+ defName: "profile"
+ def:
+ - name: "location"
+ type: "string"
+ optional: true
+ desc:
+ ja: "場所"
+ en: "The location of this user"
+ - name: "birthday"
+ type: "string"
+ optional: true
+ desc:
+ ja: "誕生日 (YYYY-MM-DD)"
+ en: "The birthday of this user (YYYY-MM-DD)"