mobile/api-spec.yaml at develop · LuminaaChat/mobile · GitHub

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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
openapi: '3.0.2'
info:
  title: Olsberg Messaging Service
  version: '1.0'
servers:
  - url: https://olsberg.xyz/
tags:
 - name: Chat
   description: Methods for managing chats
 - name: Admin
   description: Admin Endpoint
 - name: FCM
   description: Firebase Cloud Messaging
paths:
  /admin/user:
    post:
      tags:
        - Admin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/user'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user'
  /admin/user/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Admin
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user'
    put:
      tags:
       - Admin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/user'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user'
    delete:
      tags:
        - Admin
      responses:
        '200':
          description: OK
  /admin/group:
    post:
      tags:
        - Admin
      description: Creates a new group
      requestBody:
        description: New Group
        required: true
        content:
          text/plain:
            schema:
              type: string
              description: Group name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/group'
  /admin/group/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Admin
      description: List of users in the group
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/group'
  /admin/group/{id}/users:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Admin
      description: List of users to be added to group
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/groupChat'
    delete:
      tags:
        - Admin
      description: List of users to be removed from group
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#components/schemas/user'
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user'

    post:
      tags:
        - Admin
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#components/schemas/user'
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/user'
  /admin/group/{id}/groupChats:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Admin
      description: List of group chats to be added to group
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/groupChat'
    delete:
      tags:
        - Admin
      description: List of group chats to be removed from group
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#components/schemas/groupChat'
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/groupChat'

    post:
      tags:
        - Admin
      requestBody:
        content:
          text/plain::
            schema:
              type: string
              description: Name of the to be created group chat
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groupChat'
  /chat/user/{id}:
    get:
      description: Gets the user for the specified id.
      tags:
        - Chat
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
       '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/displayUser'
  /chat/groupChats:
    get:
      description: Gets all group chats for the logged in user.
      tags:
        - Chat
      responses:
        '200':
          description: Group chats of the logged in user
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/groupChat'
  /chat/addressBook:
    get:
      description: Returns a list of all employees. This method is only available for users with the type employee.
      tags:
        - Chat
      responses:
        '200':
          description: List of all employees
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/displayUser'
  /saveFCMToken:
    post:
      tags:
       - FCM
      requestBody:
        content:
          text/plain:
            schema:
              type: string
              description: Firebase Cloud Messaging registration token
      responses:
        '200':
          description: OK
components:
  schemas:
    group:
      type: object
      description: Group for living group or case or whatever
      properties:
        groupId:
          type: string
          description: Group ID
        groupName:
          type: string
          description: Name of the group
        users:
          description: List of all users in this group
          type: array
          items:
            $ref: '#components/schemas/user'
        groupChats:
          description: List of all group chats related to this group
          type: array
          items:
            $ref: '#components/schemas/groupChat'
    user:
      type: object
      properties:
        userId:
          type: string
          description: User ID
        displayName:
          type: string
          description: User name to be displayed
        userType:
          $ref: '#/components/schemas/userType'
    groupChat:
      type: object
      properties:
        groupChatId:
          type: string
          description: id of the group chat
        groupChatName:
          type: string
          description: Name of the group chat
        users:
          type: array
          items:
            type: string
            description: id of the user
        mutedUsers:
          type: array
          items:
            type: string
            description: id of the user
    displayUser:
      type: object
      properties:
        userId:
          type: string
          description: User ID
        displayName:
          type: string
          description: User name to be displayed
        userType:
          $ref: '#/components/schemas/userType'
    userType:
      type: string
      enum:
        - employee
        - client
        - legalGuardian