~cypheon/nextcloud-chores-app

nextcloud-chores-app/openapi.yaml -rw-r--r-- 12.6 KiB
d19a6603 — Johann Rudloff Make overdue sidebar badge dynamic, switch badges to `CounterBubble` component 4 months ago
                                                                                
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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
openapi: "3.0.0"
info:
  version: "1.0"
  title: Nextcloud Chores
  license:
    name: AGPL-3.0-only
servers:
  - url: http://localhost:8000/index.php/apps/chores/api/v1.0
security:
  - BasicAuth: []
paths:
  /team:
    get:
      summary: Get team information for the current user
      operationId: getTeam
      tags:
        - team
      responses:
        200:
          description: Team info
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Team"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Create a team
      operationId: createTeam
      tags:
        - team
      requestBody:
        required: true
        content:
          application/json:
            schema: {$ref: '#/components/schemas/Team'}
      responses:
        201:
          description: Team created successfully
        409:
          description: "Conflict: User is already member of a team"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /team/{teamId}:
    parameters:
      - name: teamId
        in: path
        required: true
        schema:
          type: integer
          format: teamId
    patch:
      summary: Modify team information
      operationId: modifyTeam
      tags:
        - team
      requestBody:
        required: true
        content:
          application/json:
            schema: {$ref: '#/components/schemas/Team'}
      responses:
        204:
          description: Team updated successfully
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /account/team:
    get:
      summary: Get team information for the current user
      operationId: getOwnTeam
      tags:
        - user
      responses:
        200:
          description: Team info
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Team"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /account/invites:
    get:
      summary: List own pending invitations
      operationId: getOwnInvitations
      tags:
        - user
      responses:
        200:
          description: List of pending invites
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/TeamInvite"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /account/invites/accept:
    post:
      summary: Accept a pending invite
      operationId: acceptInvitation
      tags:
        - user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required: [teamId, inviteId]
              properties:
                teamId:
                  type: integer
                  format: teamId
                  example: 1
                inviteId:
                  type: string
                  format: inviteId
                  example: "0yTrbZcQOEHBiAMC"
      responses:
        200:
          description: User successfully joined the team
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /team/{teamId}/invites:
    parameters:
      - name: teamId
        in: path
        required: true
        schema:
          type: integer
          format: teamId
    post:
      summary: Invite a user into a team
      operationId: inviteUserToTeam
      tags:
        - team
        - user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required: [userId]
              properties:
                userId:
                  type: string
                  format: userId
      responses:
        204:
          description: User invited successfully or invitation already existed
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /team/{teamId}/chores:
    parameters:
      - name: teamId
        in: path
        required: true
        schema:
          type: integer
          format: teamId
    get:
      summary: Get all chores of given team
      operationId: getChoresByTeam
      tags:
        - chores
      responses:
        200:
          description: An array of chores
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Chore"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Add new chore(s)
      operationId: addChoresForTeam
      tags:
        - chores
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required: [chores]
              properties:
                chores:
                  type: array
                  items: {$ref: '#/components/schemas/Chore'}
      responses:
        200:
          description: Saved Successfully
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /team/{teamId}/chores/{choreId}:
    parameters:
      - name: teamId
        in: path
        required: true
        schema:
          type: integer
          format: teamId
      - name: choreId
        in: path
        required: true
        schema:
          type: integer
          format: choreId
    patch:
      summary: Modify chore properties
      operationId: modifyChore
      tags:
        - chores
      description: All properties are optional
      requestBody:
        required: true
        content:
          application/json:
            schema: {$ref: '#/components/schemas/Chore'}
      responses:
        200:
          description: Saved Successfully
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /team/{teamId}/work:
    parameters:
      - name: teamId
        in: path
        required: true
        schema:
          type: integer
          format: teamId
      - name: since
        in: query
        schema:
          type: string
          format: date-time
        description: |
          Only return worklog items with a submit_time starting from this time

          Clients can use this to fetch only "new" worklog items by passing the
          `MAX()` of their locally known work items' `submit_time`s
    get:
      summary: Get worklog
      operationId: getWorklog
      tags:
        - worklog
      responses:
        200:
          description: An array of worklog items (may be empty)
          content:
            application/json:
              schema:
                required: [worklog]
                properties:
                  worklog:
                    type: array
                    items:
                      $ref: "#/components/schemas/WorklogItem"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Submit worklog item(s)
      operationId: submitWork
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - work
              properties:
                work:
                  type: array
                  items: {$ref: '#/components/schemas/WorklogSubmissionItem'}
      tags:
        - worklog
      responses:
        200:
          description: Saved Successfully
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
  schemas:
    Chore:
      required:
        - id
        - name
        - points
        - due
        - repeat
      properties:
        id:
          type: integer
          format: choreId
          example: 42
          readOnly: true
        name:
          type: string
          example: "Clean the dishes"
        assignee:
          type: string
          format: userId
          example: alice
        points:
          type: integer
          example: 4
        due:
          type: string
          format: date-time
          description: |
            *Note:* For on-demand tasks, this field holds the "last execution" date
        repeat:
          type: string
          format: repeatSchedule
          example: "w:2:-"
          description: |
            Schedule syntax:
             * "s:0:-" -> single occurence, do not repeat
             * "o:0:-" -> on-demand, repeat indefinetely
             * "d:3:-" -> every three days
             * "w:2:-" -> every two weeks
             * "w:3:1" -> every three weeks, always on Mondays
             * "m:5:22" -> every five months, always on the 22nd
    Member:
      required:
        - id
        - name
      properties:
        teamId:
          type: integer
          format: teamId
          example: 1
          readOnly: true
        member:
          type: string
          format: userId
          example: bob
        displayName:
          type: string
          example: Robert Bobacious
        points:
          type: integer
          example: 102
    Team:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: teamId
          example: 1
          readOnly: true
        name:
          type: string
          example: "Team Awesome"
        owner:
          type: string
          format: userId
          example: bob
        members:
          type: array
          minItems: 1
          uniqueItems: true
          readOnly: true
          items:
            $ref: "#/components/schemas/Member"
    TeamInvite:
      required:
        - teamId
        - inviteId
      properties:
        teamId:
          type: integer
          format: teamId
          example: 1
          readOnly: true
        teamName:
          type: string
          example: "Super Team"
          readOnly: true
        userId:
          type: string
          format: userId
          example: "eve"
        inviteId:
          type: string
          example: "0yTrbZcQOEHBiAMC"
          readOnly: true
    WorklogItem:
      required:
        - id
        - work_time
        - chore_id
        - member
      properties:
        id:
          type: string
          format: uuid
          example: 22d1d25c-050e-4076-930e-480a6cd997ec
        work_time:
          type: string
          format: date-time
          description: When the task was done according to the submitting client
        submit_time:
          type: string
          format: date-time
          description: When the worklog item was received by the server
        name:
          type: string
          description: Title of the chore that was completed
          example: "Clean the dishes"
        member:
          type: string
          format: userId
          example: bob
        points:
          type: integer
          example: 4
    WorklogSubmissionItem:
      required:
        - id
        - work_time
        - chore_id
        - member
      properties:
        id:
          type: string
          format: uuid
          example: 22d1d25c-050e-4076-930e-480a6cd997ec
        work_time:
          type: string
          format: date-time
          description: When the task was done according to the submitting client
        chore_id:
          type: integer
          format: choreId
          example: 42
        member:
          type: string
          format: userId
          example: "charlie"
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string