-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
wekan.yml
4312 lines (4294 loc) · 105 KB
/
wekan.yml
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: Wekan REST API
version: v6.83
description: |
The REST API allows you to control and extend Wekan with ease.
If you are an end-user and not a dev or a tester, [create an issue](https://github.com/wekan/wekan/issues/new) to request new APIs.
> All API calls in the documentation are made using `curl`. However, you are free to use Java / Python / PHP / Golang / Ruby / Swift / Objective-C / Rust / Scala / C# or any other programming languages.
# Production Security Concerns
When calling a production Wekan server, ensure it is running via HTTPS and has a valid SSL Certificate. The login method requires you to post your username and password in plaintext, which is why we highly suggest only calling the REST login api over HTTPS. Also, few things to note:
* Only call via HTTPS
* Implement a timed authorization token expiration strategy
* Ensure the calling user only has permissions for what they are calling and no more
schemes:
- http
securityDefinitions:
UserSecurity:
type: apiKey
in: header
name: Authorization
paths:
/users/login:
post:
operationId: login
summary: Login with REST API
consumes:
- application/x-www-form-urlencoded
- application/json
tags:
- Login
parameters:
- name: username
in: formData
required: true
description: |
Your username
type: string
- name: password
in: formData
required: true
description: |
Your password
type: string
format: password
responses:
200:
description: |-
Successful authentication
schema:
items:
properties:
id:
type: string
token:
type: string
tokenExpires:
type: string
400:
description: |
Error in authentication
schema:
items:
properties:
error:
type: number
reason:
type: string
default:
description: |
Error in authentication
/users/register:
post:
operationId: register
summary: Register with REST API
description: |
Notes:
- You will need to provide the token for any of the authenticated methods.
consumes:
- application/x-www-form-urlencoded
- application/json
tags:
- Login
parameters:
- name: username
in: formData
required: true
description: |
Your username
type: string
- name: password
in: formData
required: true
description: |
Your password
type: string
format: password
- name: email
in: formData
required: true
description: |
Your email
type: string
responses:
200:
description: |-
Successful registration
schema:
items:
properties:
id:
type: string
token:
type: string
tokenExpires:
type: string
400:
description: |
Error in registration
schema:
items:
properties:
error:
type: number
reason:
type: string
default:
description: |
Error in registration
/api/boards:
get:
operationId: get_public_boards
summary: Get all public boards
tags:
- Boards
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
_id:
type: string
title:
type: string
post:
operationId: new_board
summary: Create a board
description: |
This allows to create a board.
The color has to be chosen between `belize`, `nephritis`, `pomegranate`,
`pumpkin`, `wisteria`, `moderatepink`, `strongcyan`,
`limegreen`, `midnight`, `dark`, `relax`, `corteza`:
<img src="https://wekan.github.io/board-colors.png" width="40%" alt="Wekan logo" />
tags:
- Boards
consumes:
- multipart/form-data
- application/json
parameters:
- name: title
in: formData
description: |
the new title of the board
type: string
required: true
- name: owner
in: formData
description: |
"ABCDE12345" <= User ID in Wekan.
(Not username or email)
type: string
required: true
- name: isAdmin
in: formData
description: |
is the owner an admin of the board (default true)
type: boolean
required: false
- name: isActive
in: formData
description: |
is the board active (default true)
type: boolean
required: false
- name: isNoComments
in: formData
description: |
disable comments (default false)
type: boolean
required: false
- name: isCommentOnly
in: formData
description: |
only enable comments (default false)
type: boolean
required: false
- name: isWorker
in: formData
description: |
only move cards, assign himself to card and comment (default false)
type: boolean
required: false
- name: permission
in: formData
description: |
"private" board <== Set to "public" if you
want public Wekan board
type: string
required: false
- name: color
in: formData
description: |
the color of the board
type: string
required: false
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
defaultSwimlaneId:
type: string
/api/boards/{board}:
get:
operationId: get_board
summary: Get the board with that particular ID
tags:
- Boards
parameters:
- name: board
in: path
description: |
the ID of the board to retrieve the data
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
$ref: "#/definitions/Boards"
delete:
operationId: delete_board
summary: Delete a board
tags:
- Boards
parameters:
- name: board
in: path
description: |
the ID of the board
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
/api/boards/{board}/attachments:
get:
operationId: get_board_attachments
summary: Get the list of attachments of a board
tags:
- Boards
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
attachmentId:
type: string
attachmentName:
type: string
attachmentType:
type: string
cardId:
type: string
listId:
type: string
swimlaneId:
type: string
/api/boards/{board}/attachments/{attachment}/export:
get:
operationId: exportJson
summary: This route is used to export a attachement to a json file format.
description: |
If user is already logged-in, pass loginToken as param
"authToken": '/api/boards/:boardId/attachments/:attachmentId/export?authToken=:token'
tags:
- Boards
parameters:
- name: board
in: path
description: |
the ID of the board we are exporting
type: string
required: true
- name: attachment
in: path
description: |
the ID of the attachment we are exporting
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
/api/boards/{board}/cards/{card}/checklists:
get:
operationId: get_all_checklists
summary: Get the list of checklists attached to a card
tags:
- Checklists
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
_id:
type: string
title:
type: string
post:
operationId: new_checklist
summary: create a new checklist
tags:
- Checklists
consumes:
- multipart/form-data
- application/json
parameters:
- name: title
in: formData
description: |
the title of the new checklist
type: string
required: true
- name: items
in: formData
description: |
the list of items on the new checklist
type: string
required: false
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
/api/boards/{board}/cards/{card}/checklists/{checklist}:
get:
operationId: get_checklist
summary: Get a checklist
tags:
- Checklists
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
- name: checklist
in: path
description: |
the ID of the checklist
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
cardId:
type: string
title:
type: string
finishedAt:
type: string
createdAt:
type: string
sort:
type: number
items:
type: array
items:
type: object
properties:
_id:
type: string
title:
type: string
isFinished:
type: boolean
delete:
operationId: delete_checklist
summary: Delete a checklist
description: |
The checklist will be removed, not put in the recycle bin.
tags:
- Checklists
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
- name: checklist
in: path
description: |
the ID of the checklist to remove
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}:
get:
operationId: get_checklist_item
summary: Get a checklist item
tags:
- ChecklistItems
- Checklists
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
- name: checklist
in: path
description: |
the checklist ID
type: string
required: true
- name: item
in: path
description: |
the ID of the item
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
$ref: "#/definitions/ChecklistItems"
put:
operationId: edit_checklist_item
summary: Edit a checklist item
tags:
- ChecklistItems
- Checklists
consumes:
- multipart/form-data
- application/json
parameters:
- name: isFinished
in: formData
description: |
is the item checked?
type: string
required: false
- name: title
in: formData
description: |
the new text of the item
type: string
required: false
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
- name: checklist
in: path
description: |
the checklist ID
type: string
required: true
- name: item
in: path
description: |
the ID of the item
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
delete:
operationId: delete_checklist_item
summary: Delete a checklist item
description: |
Note: this operation can't be reverted.
tags:
- ChecklistItems
- Checklists
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: card
in: path
description: |
the card ID
type: string
required: true
- name: checklist
in: path
description: |
the checklist ID
type: string
required: true
- name: item
in: path
description: |
the ID of the item to be removed
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
/api/boards/{board}/cards/{card}/comments:
get:
operationId: get_all_comments
summary: Get all comments attached to a card
tags:
- CardComments
parameters:
- name: board
in: path
description: |
the board ID of the card
type: string
required: true
- name: card
in: path
description: |
the ID of the card
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
_id:
type: string
comment:
type: string
authorId:
type: string
post:
operationId: new_comment
summary: Add a comment on a card
tags:
- CardComments
consumes:
- multipart/form-data
- application/json
parameters:
- name: authorId
in: formData
description: |
the user who 'posted' the comment
type: string
required: true
- name: comment
in: formData
description: the comment value
type: string
required: true
- name: board
in: path
description: |
the board ID of the card
type: string
required: true
- name: card
in: path
description: |
the ID of the card
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
/api/boards/{board}/cards/{card}/comments/{comment}:
get:
operationId: get_comment
summary: Get a comment on a card
tags:
- CardComments
parameters:
- name: board
in: path
description: |
the board ID of the card
type: string
required: true
- name: card
in: path
description: |
the ID of the card
type: string
required: true
- name: comment
in: path
description: |
the ID of the comment to retrieve
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
$ref: "#/definitions/CardComments"
delete:
operationId: delete_comment
summary: Delete a comment on a card
tags:
- CardComments
parameters:
- name: board
in: path
description: |
the board ID of the card
type: string
required: true
- name: card
in: path
description: |
the ID of the card
type: string
required: true
- name: comment
in: path
description: |
the ID of the comment to delete
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
_id:
type: string
/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}:
get:
operationId: get_cards_by_custom_field
summary: Get all Cards that matchs a value of a specific custom field
tags:
- Cards
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
- name: customField
in: path
description: |
the list ID
type: string
required: true
- name: customFieldValue
in: path
description: |
the value to look for
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
_id:
type: string
title:
type: string
description:
type: string
listId:
type: string
swinlaneId:
type: string
/api/boards/{board}/cards_count:
get:
operationId: get_board_cards_count
summary: Get a cards count to a board
tags:
- Cards
parameters:
- name: board
in: path
description: |
the board ID
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: object
properties:
board_cards_count:
type: integer
/api/boards/{board}/custom-fields:
get:
operationId: get_all_custom_fields
summary: Get the list of Custom Fields attached to a board
tags:
- CustomFields
parameters:
- name: board
in: path
description: the board value
type: string
required: true
produces:
- application/json
security:
- UserSecurity: []
responses:
'200':
description: |-
200 response
schema:
type: array
items:
type: object
properties:
_id:
type: string
name:
type: string
type:
type: string
post:
operationId: new_custom_field
summary: Create a Custom Field
tags:
- CustomFields
consumes:
- multipart/form-data
- application/json
parameters:
- name: name
in: formData
description: |
the name of the custom field
type: string
required: true
- name: type
in: formData
description: |
the type of the custom field
type: string
required: true
- name: settings
in: formData
description: |
the settings object of the custom field
type: string
required: true
- name: showOnCard
in: formData
description: |
should we show the custom field on cards?
type: boolean
required: true
- name: automaticallyOnCard
in: formData
description: |
should the custom fields automatically be added on cards?
type: boolean
required: true
- name: showLabelOnMiniCard
in: formData
description: |
should the label of the custom field be shown on minicards?
type: boolean
required: true
- name: showSumAtTopOfList
in: formData
description: |
should the sum of the custom fields be shown at top of list?
type: boolean
required: true
- name: authorId
in: formData
description: the authorId value
type: string
required: true
- name: board