-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
146 lines (145 loc) · 4.56 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
openapi: "3.0.2"
info:
title: LMS connect
version: "1.0.0"
servers:
- url: https://cursuskit.test/lms-connect/api/v1
paths:
/health:
get:
summary: Get the health of the connect plugin
description: This endpoint should return status 'ok' when installed.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
/{team}/groups:
get:
summary: Get all groups for a given team
description: You can get all the groups for a given team.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
properties:
id:
type: string
name:
type: string
users_count:
type: integer
description: Counts the users in the group
team_id:
type: string
created_at:
type: string
updated_at:
type: string
/{team}/groups/scores:
get:
summary: Get all the groups with their score for a given team
description: It returns all the scores for the groups in a team.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
properties:
id:
type: string
name:
type: string
users_count:
type: integer
description: Counts the users in the group
users_started:
type: integer
description: Counts the users who started a course in the group
users_achieved:
type: integer
description: Counts the users who completed courses in the group
/{team}/users:
get:
summary: Get all the users for a given team
description: It returns all the users in a team.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
properties:
id:
type: string
name:
type: string
email:
type: string
phone:
type: string
/{team}/groups/{group}/scores:
get:
summary: Get all scores of users for a given group in a team
description: It returns a list with scores.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
name:
type: string
users:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
phone:
type: string
lms_roles:
type: string
last_seen_at:
type: string
created_at:
type: string
score:
type: integer
courses:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
achieved:
type: boolean
score:
type: integer