-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
5649 lines (5537 loc) · 145 KB
/
openapi.yaml
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
openapi: 3.0.0
info:
title: WeFitter API
description: This is the WeFitter API
version: v1.3
termsOfService: https://www.wefitter.com/privacy/
contact:
email: hello@wefitter.com
license:
name: BSD License
servers:
- url: https://api.wefitter.com/api/v1.3
tags:
- description: >
Profiles are containers for wearables data.
The profiles can be seen as an extension of users in a different system.
Profiles are anonymous objects which can participate in teams and
challenges.
Keep in mind, listing profiles and creating profiles need an
administrative bearer token, all profile specific actions
need a seperate bearer token that is returned after creating a profile.
This bearer token is used in place of the
administrative bearer token. (see profile create action for more
information)
name: profile
- description: >+
WeFitter API’s challenge engine will bring endless engagement to your
platform.
For more information about the possibilities in challenges please go to
https://www.wefitter.com/en-us/features/gamification/
Challenges have multilanguage support on the fields: `Title`, `Slogan`,
and `Description`.
By default, challenges get the default-language that is configured in the
app. Whenever a challenge is requested through the API this challenge will
be presented in the default language.
If another language is preferred, this can be requested by adding the
header parameter `Accept-Language` stating the language short code (ex.
`en` for english). If this language short code is not present in the title
of the challenge, the default language will be returned.
These translation fields contain JSON strings, for example:
```{"en":"this is the English title","nl":"this is the Dutch title"}```
So to create a multilanguage challenge, please provide the title, slogan,
and description field as json strings, be aware that because of
serialization this should be formed with backward slashes:
<table><tbody>
<tr><td>
{
"title": "{\"en\":\"this is the English title\", \"nl\":\"this is the
dutch title\"}",
"slogan": "{\"en\":\"this is the English title\", \"nl\":\"this is the
dutch slogan\"}",
"description": "{\"en\":\"this is the English title\", \"nl\":\"this is
the dutch description\"}",
}
</td></tr>
</tbody></table>
name: challenge
- name: team
- description: Connections are the links between profiles and their wearables.
name: connection
- description: |
Send a notification to all devices for the specified profiles
The data will be sent to the client in the following format:
```
{
"app": <app public id>,
"title": <title>,
"body": <body>,
"link": <optional link>
}
```
name: notification
- name: loyalty
- description: >
<p>
Before any calls can be made to wefitter, BasicAuth is needed to verify
the identity of the requesting party.
This call will result into a Bearer token which has administrator
privileges and is valid for 1 day.
This token can be used to create profiles, challenges, etc.
</p>
<p>
The returned bearer is a JWT (<a
href="https://en.wikipedia.org/wiki/JSON_Web_Token">JSON Web Token</a>).
</p>
name: token
- name: app
- name: insights
paths:
/insights/bio_age:
parameters: []
get:
tags:
- insights
summary: Get someones biological age on a weekly basis.
operationId: Insights_getBioAgeWeekly
description: ''
parameters:
- name: start_date
in: query
required: true
schema:
type: string
format: date
- name: end_date
in: query
required: true
schema:
type: string
format: date
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InsightsGetBioAgeWeeklyResponse'
/loyalty/get_recommended_products:
parameters: []
get:
tags:
- loyalty
operationId: Loyalty_getRecommendedProducts
description: ''
parameters:
- description: Number of results to return per page.
name: limit
in: query
required: false
schema:
type: integer
- description: The initial index from which to return the results.
name: offset
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LoyaltyGetRecommendedProductsResponse'
/loyalty/get_shoppingcart_link:
parameters: []
get:
tags:
- loyalty
operationId: Loyalty_getShoppingcartLink
description: ''
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ShoppingCart'
/app/totals:
parameters: []
get:
tags:
- app
summary: Totals
operationId: App_getTotals
security:
- BearerAdmin: []
description: >-
Total values for calories, distance, steps, points and activity duration
over all profiles in the app.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppGetTotalsResponse'
deprecated: false
/challenge:
parameters: []
get:
tags:
- challenge
summary: List Challenges
operationId: challenge_list
security:
- BearerAdmin: []
description: Lists all available challenges
parameters:
- description: Number of results to return per page.
name: limit
in: query
required: false
schema:
type: integer
- description: The initial index from which to return the results.
name: offset
in: query
required: false
schema:
type: integer
- description: Show challenges that have not ended in the last N weeks
name: recent
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeListResponse'
deprecated: false
post:
tags:
- challenge
summary: Create challenge
operationId: challenge_create
security:
- BearerAdmin: []
description: Creates a new challenge
requestBody:
$ref: '#/components/requestBodies/ChallengeDetail'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeDetail'
deprecated: false
/challenge/{challenge_public_id}/team:
parameters:
- name: challenge_public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Team leaderboard
operationId: Challenge_teamStandingsList
security:
- BearerAdmin: []
description: >
List the standings of different teams in challenges (don't have to be
team challenges).
This endpoint returns a list of objects.
parameters:
- description: Number of results to return per page.
name: limit
in: query
required: false
schema:
type: integer
- description: The initial index from which to return the results.
name: offset
in: query
required: false
schema:
type: integer
- description: Index of the time period use
name: date_range
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeTeamStandingsListResponse'
deprecated: false
/challenge/{challenge_public_id}/team/{team_public_id}:
parameters:
- name: challenge_public_id
in: path
required: true
schema:
type: string
- name: team_public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Team contribution
operationId: Challenge_teamContributionList
security:
- BearerAdmin: []
description: |
List team members' contribution to the challenge.
This endpoint returns a list of objects.
parameters:
- description: Index of the time period use
name: date_range
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LeaderboardProfile'
deprecated: false
/challenge/{public_id}:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Get Challenge
operationId: challenge_read
security:
- BearerAdmin: []
description: Gets a single challenge
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeDetail'
deprecated: false
put:
tags:
- challenge
summary: Edit challenge
operationId: challenge_update
security:
- BearerAdmin: []
description: Edits a challenge
requestBody:
$ref: '#/components/requestBodies/ChallengeDetail'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeDetail'
deprecated: false
patch:
tags:
- challenge
summary: Partial edit challenge
operationId: Challenge_partialEdit
security:
- BearerAdmin: []
description: Edits a challenge
requestBody:
$ref: '#/components/requestBodies/ChallengeDetail'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeDetail'
deprecated: false
delete:
tags:
- challenge
summary: Delete challenge
operationId: challenge_delete
security:
- BearerAdmin: []
description: deletes a challenge
responses:
'204':
description: ''
deprecated: false
/challenge/{public_id}/deactivate_member:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
post:
tags:
- challenge
summary: Deactivate member
operationId: Challenge_deactivateMember
security:
- BearerAdmin: []
description: Deactivate a member from the challenge
parameters:
- description: A profile public_id is expected
name: profile
in: query
required: true
schema:
type: string
format: uuid
- description: A team public_id is expected
name: team
in: query
required: false
schema:
type: string
format: uuid
- description: >-
Whether profile actively participates in challenge.
While inactive, scores/leaderboard will not be updated but still be
visible.
name: is_active
in: query
required: false
schema:
type: boolean
requestBody:
$ref: >-
#/components/requestBodies/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
deprecated: false
put:
tags:
- challenge
operationId: Challenge_deactivateMember
description: This docstring is used by Django Rest Framework
requestBody:
$ref: >-
#/components/requestBodies/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
/challenge/{public_id}/deactivate_members:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
post:
tags:
- challenge
summary: Deactivate members
operationId: Challenge_deactivateMembers
security:
- BearerAdmin: []
description: Deactivate multiple members from the challenge
parameters:
- description: A profile public_id is expected
name: profile
in: query
required: true
schema:
type: string
format: uuid
- description: A team public_id is expected
name: team
in: query
required: false
schema:
type: string
format: uuid
- description: >-
Whether profile actively participates in challenge.
While inactive, scores/leaderboard will not be updated but still be
visible.
name: is_active
in: query
required: false
schema:
type: boolean
requestBody:
$ref: '#/components/requestBodies/ProfilePublicIdsListAndTeamAsPublicId'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilePublicIdsListAndTeamAsPublicId'
deprecated: false
put:
tags:
- challenge
operationId: Challenge_deactivateMembers
description: This docstring is used by Django Rest Framework
requestBody:
$ref: '#/components/requestBodies/ProfilePublicIdsListAndTeamAsPublicId'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilePublicIdsListAndTeamAsPublicId'
/challenge/{public_id}/leaderboard:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Leaderboard
operationId: challenge_leaderboard
security:
- BearerAdmin: []
description: |
Displays the leaderboard for a challenge.
This endpoint returns a list of objects.
parameters:
- description: Index of the time period use
name: date_range
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LeaderboardProfileAndTeam'
deprecated: false
/challenge/{public_id}/leaderboard_history:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Leaderboard history
operationId: Challenge_getScoresHistory
description: >
Retrieve the scores of the authenticated profile for all periods since
the profile joined the challenge.
This endpoint returns a list of objects.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LeaderboardHistory'
deprecated: false
/challenge/{public_id}/member:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
post:
tags:
- challenge
summary: Add member
operationId: Challenge_memberCreate
security:
- BearerAdmin: []
description: >
Add member to a team.
Note: for now if the challenge is a team challenge and no team is
specified, the first team for the specified profile is
used. Do note that this is a temporary fix and may be removed at any
time.
requestBody:
$ref: >-
#/components/requestBodies/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
deprecated: false
put:
tags:
- challenge
summary: Add member
operationId: Challenge_memberAdd
security:
- BearerAdmin: []
description: >
Add member to a team.
Note: for now if the challenge is a team challenge and no team is
specified, the first team for the specified profile is
used. Do note that this is a temporary fix and may be removed at any
time.
requestBody:
$ref: >-
#/components/requestBodies/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/ProfileAsProfilePublicIdAndTeamAsTeamPublicId
deprecated: false
delete:
tags:
- challenge
summary: Remove member
operationId: Challenge_removeMember
security:
- BearerAdmin: []
description: Remove a member from the challenge
parameters:
- description: A profile public_id is expected
name: profile
in: query
required: true
schema:
type: string
format: uuid
responses:
'204':
description: ''
deprecated: false
/challenge/{public_id}/members:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Get members
operationId: Challenge_getMembers
security:
- BearerAdmin: []
description: Get a paginated list of members enrolled to a Challenge
parameters:
- description: Number of results to return per page.
name: limit
in: query
required: false
schema:
type: integer
- description: The initial index from which to return the results.
name: offset
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeGetMembersResponse'
deprecated: false
post:
tags:
- challenge
summary: Add members
operationId: Challenge_addMembers
security:
- BearerAdmin: []
description: >-
Add members to a team.
Note: for now if the challenge is a team challenge and no team is
specified, the first team for the specified profile is
used. Do note that this is a temporary fix and may be removed at any
time.
Note: for the GET/POST endpoint an admin bearer token is required, while
the GET also accepts profile bearer tokens
requestBody:
$ref: '#/components/requestBodies/ProfilePublicIdsListAndTeamAsPublicId'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilePublicIdsListAndTeamAsPublicId'
deprecated: false
put:
tags:
- challenge
summary: Add members
operationId: Challenge_addMembers
security:
- BearerAdmin: []
description: >-
Add members to a team.
Note: for now if the challenge is a team challenge and no team is
specified, the first team for the specified profile is
used. Do note that this is a temporary fix and may be removed at any
time.
Note: for the GET/POST endpoint an admin bearer token is required, while
the GET also accepts profile bearer tokens
requestBody:
$ref: '#/components/requestBodies/ProfilePublicIdsListAndTeamAsPublicId'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilePublicIdsListAndTeamAsPublicId'
deprecated: false
/challenge/{public_id}/periods:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
get:
tags:
- challenge
summary: Periods
operationId: challenge_periods
security:
- BearerAdmin: []
description: |
Get all periods for the challenge.
This endpoint returns a list of objects.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengePeriod'
deprecated: false
/challenge/{public_id}/remove_members:
parameters:
- name: public_id
in: path
required: true
schema:
type: string
post:
tags:
- challenge
summary: Remove members
operationId: Challenge_removeMembers
security:
- BearerAdmin: []
description: Remove members from the challenge
requestBody:
$ref: '#/components/requestBodies/ProfilePublicIdsListAndTeamAsPublicId'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilePublicIdsListAndTeamAsPublicId'
deprecated: false
/connection/{connection_slug}/connect:
parameters:
- name: connection_slug
in: path
required: true
schema:
type: string
post:
tags:
- connection
summary: Connect wearable
operationId: Connection_getOAuthUrl
description: Get OAuth URL for this connection.
requestBody:
$ref: '#/components/requestBodies/ProfileAsProfilePublicId'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppConnectionUrl'
deprecated: false
delete:
tags:
- connection
summary: Disconnect Wearable
operationId: Connection_disconnectWearable
description: Disconnect a wearables connection
parameters:
- description: A profile public_id is expected
name: profile
in: query
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
deprecated: false
/notification/send_to_all:
parameters: []
post:
tags:
- notification
summary: Notification to all profiles in app
operationId: Notification_sendToAllCreate
security:
- BearerAdmin: []
description: Send a notification to all registered devices in the app.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
deprecated: false
/notification/send_to_profiles:
parameters: []
post:
tags:
- notification
summary: Notification to specific profiles
operationId: Notification_sendToProfilesCreate
security:
- BearerAdmin: []
description: >-
Send a notification to all registered devices for the specified
profiles.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationForProfiles'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationForProfiles'
deprecated: false
/profile:
parameters: []
get:
tags:
- profile
summary: List Profiles
operationId: profile_list
security:
- BearerAdmin: []
description: Lists all available profiles
parameters:
- description: A search term.
name: search
in: query
required: false
schema:
type: string
- description: Which field to use when ordering the results.
name: ordering
in: query
required: false
schema:
type: string
- description: Number of results to return per page.
name: limit
in: query
required: false
schema:
type: integer
- description: The initial index from which to return the results.
name: offset
in: query
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileListResponse'
deprecated: false
post:
tags:
- profile
summary: Create Profile
operationId: profile_create
security:
- BearerAdmin: []
description: >
Creates a new profile.
The bearer field contains a profile bearer token. When this is used in
the Authorization header actions are performed
as that profile, which will also enable access to private data.
Using a profile bearer token disables administrative features such as
creating profiles, making this token safe