summaryrefslogtreecommitdiff
path: root/src/web/docs/api/entities/user.yaml
blob: abc3f300d26ff3e170de786db07c175308f30dbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
name: "User"

desc:
  ja: "ユーザー。"
  en: "A user."

props:
  - name: "id"
    type: "id"
    optional: false
    desc:
      ja: "ユーザーID"
      en: "The ID of this user"
  - name: "created_at"
    type: "date"
    optional: false
    desc:
      ja: "アカウント作成日時"
      en: "The registered date of this user"
  - name: "username"
    type: "string"
    optional: false
    desc:
      ja: "ユーザー名"
      en: "The username of this user"
  - name: "description"
    type: "string"
    optional: false
    desc:
      ja: "アカウントの説明(自己紹介)"
      en: "The description of this user"
  - name: "avatar_id"
    type: "id(DriveFile)"
    optional: true
    desc:
      ja: "アバターのID"
      en: "The ID of the avatar of this user"
  - name: "avatar_url"
    type: "string"
    optional: false
    desc:
      ja: "アバターのURL"
      en: "The URL of the avatar of this user"
  - name: "banner_id"
    type: "id(DriveFile)"
    optional: true
    desc:
      ja: "バナーのID"
      en: "The ID of the banner of this user"
  - name: "banner_url"
    type: "string"
    optional: false
    desc:
      ja: "バナーのURL"
      en: "The URL of the banner of this user"
  - name: "followers_count"
    type: "number"
    optional: false
    desc:
      ja: "フォロワーの数"
      en: "The number of the followers for this user"
  - name: "following_count"
    type: "number"
    optional: false
    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
    desc:
      ja: "最終利用日時"
      en: "The last used date of this user"
  - name: "posts_count"
    type: "number"
    optional: false
    desc:
      ja: "投稿の数"
      en: "The number of the posts of this user"
  - name: "pinned_post"
    type: "entity(Post)"
    optional: true
    desc:
      ja: "ピン留めされた投稿"
      en: "The pinned post of this user"
  - name: "pinned_post_id"
    type: "id(Post)"
    optional: true
    desc:
      ja: "ピン留めされた投稿のID"
      en: "The ID of the pinned post of this user"
  - name: "drive_capacity"
    type: "number"
    optional: false
    desc:
      ja: "ドライブの容量(bytes)"
      en: "The capacity of drive of this user (bytes)"
  - name: "twitter"
    type: "object"
    optional: true
    desc:
      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)"