-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpoliquiz-openapi.yaml
124 lines (124 loc) · 3.67 KB
/
poliquiz-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
openapi: 3.1.0
info:
title: PoliQuiz API
description: API to access information about PoliQuiz courses and quizzes.
version: 1.0.0
contact:
name: PoliQuiz Support
email: support@poliquiz.it
license:
name: Creative Commons Attribution 4.0 International License
url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://api.poliquiz.it
description: Main API server
paths:
/courses:
get:
tags:
- Courses
operationId: listCourses
summary: List all courses
responses:
"200":
description: An array of courses
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Calculus 1"
/course/{course_id}:
get:
tags:
- Courses
operationId: getCourseMetaInfo
summary: Get metadata for a specific course
parameters:
- name: course_id
in: path
required: true
description: The ID of the course
schema:
type: integer
example: 2
responses:
"200":
description: Metadata for the course
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
total_quizzes:
type: integer
example: 123
total_verified_quizzes:
type: integer
example: 45
/course/{course_id}/quizzes:
get:
tags:
- Quizzes
operationId: getCourseQuizzes
summary: Retrieve quizzes for a specific course
parameters:
- name: course_id
in: path
required: true
description: The ID of the course
schema:
type: integer
example: 2
responses:
"200":
description: A list of quizzes for the course
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: integer
example: 123
course_id:
type: integer
example: 2
question:
type: string
example: "Question for course 2"
answers:
type: array
items:
type: string
example:
- "Answer 1"
- "Answer 2"
- "Answer 3"
right_answer_index:
type: integer
example: 2
explanation:
type: string
example: "Answer 2 is correct because I like it"
verified:
type: boolean
example: true