summaryrefslogtreecommitdiff
path: root/src/web/docs/api/entities/post.yaml
blob: 551f3b7c3e5e6aa2b0d8fc2f942100cc50abac28 (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
name: "Post"

desc:
  ja: "投稿。"
  en: "A post."

props:
  - name: "id"
    type: "id"
    optional: false
    desc:
      ja: "投稿ID"
      en: "The ID of this post"
  - name: "created_at"
    type: "date"
    optional: false
    desc:
      ja: "投稿日時"
      en: "The posted date of this post"
  - name: "text"
    type: "string"
    optional: true
    desc:
      ja: "投稿の本文"
      en: "The text of this post"
  - name: "media_ids"
    type: "id(DriveFile)[]"
    optional: true
    desc:
      ja: "添付されているメディアのID"
      en: "The IDs of the attached media"
  - name: "media"
    type: "entity(DriveFile)[]"
    optional: true
    desc:
      ja: "添付されているメディア"
      en: "The attached media"
  - name: "user_id"
    type: "id(User)"
    optional: false
    desc:
      ja: "投稿者ID"
      en: "The ID of author of this post"
  - name: "user"
    type: "entity(User)"
    optional: true
    desc:
      ja: "投稿者"
      en: "The author of this post"
  - name: "my_reaction"
    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"
    type: "object"
    optional: false
    desc:
      ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
  - name: "reply_id"
    type: "id(Post)"
    optional: true
    desc:
      ja: "返信した投稿のID"
      en: "The ID of the replyed post"
  - name: "reply"
    type: "entity(Post)"
    optional: true
    desc:
      ja: "返信した投稿"
      en: "The replyed post"
  - name: "repost_id"
    type: "id(Post)"
    optional: true
    desc:
      ja: "引用した投稿のID"
      en: "The ID of the quoted post"
  - name: "repost"
    type: "entity(Post)"
    optional: true
    desc:
      ja: "引用した投稿"
      en: "The quoted post"
  - name: "poll"
    type: "object"
    optional: true
    desc:
      ja: "投票"
      en: "The poll"
    defName: "poll"
    def:
      - name: "choices"
        type: "object[]"
        optional: false
        desc:
          ja: "投票の選択肢"
          en: "The choices of this poll"
        defName: "choice"
        def:
          - name: "id"
            type: "number"
            optional: false
            desc:
              ja: "選択肢ID"
              en: "The ID of this choice"
          - name: "is_voted"
            type: "boolean"
            optional: true
            desc:
              ja: "自分がこの選択肢に投票したかどうか"
              en: "Whether you voted to this choice"
          - name: "text"
            type: "string"
            optional: false
            desc:
              ja: "選択肢本文"
              en: "The text of this choice"
          - name: "votes"
            type: "number"
            optional: false
            desc:
              ja: "この選択肢に投票された数"
              en: "The number voted for this choice"