-
Notifications
You must be signed in to change notification settings - Fork 10
/
api_definition.yaml
148 lines (137 loc) · 3.7 KB
/
api_definition.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
openapi: "3.0.1"
info:
version: 0.1.0
title: Radar REST API
description: API for accessing code similarity results from a Radar instance.
contact:
name: A+ LMS
url: https://apluslms.github.io/
license:
name: MIT
url: https://opensource.org/licenses/MIT
paths:
/courses:
get:
description: Returns all course instances that the user has access to.
operationId: All courses
responses:
'200':
description: Courses response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Course'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{key}:
get:
description: Returns a course instance by an external, unique identifier.
operationId: Course by key
parameters:
- name: key
in: path
description: Course instance key
required: true
schema:
type: string
responses:
'200':
description: Course by key response
content:
application/json:
schema:
$ref: '#/components/schemas/Course'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{key}/exercises:
get:
description: Returns all exercises of a course instance
operationId: All exercises of course instance
parameters:
- name: key
in: path
description: Course instance key
required: true
schema:
type: string
responses:
'200':
description: All exercises of course instance response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Exercise'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/courses/{course_key}/exercises/{exercise_key}:
get:
description: Returns an exercise of a course instance
operationId: Exercise of course instance
parameters:
- name: course_key
in: path
description: Course instance key
required: true
schema:
type: string
- name: exercise_key
in: path
description: Exercise key
required: true
schema:
type: string
responses:
'200':
description: Exercise response
content:
application/json:
schema:
$ref: '#/components/schemas/Exercise'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Course:
allOf:
- $ref: '#/components/schemas/Course'
- required:
- key
properties:
key:
description: Alphanumeric key of a course instance.
type: string
Exercise:
allOf:
- $ref: '#/components/schemas/Exercise'
- required:
- key
properties:
key:
description: Alphanumeric key of an exercise.
type: string
Error:
required:
- message
properties:
message:
type: string