-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathapi@courses.yaml
More file actions
31 lines (30 loc) · 1.25 KB
/
api@courses.yaml
File metadata and controls
31 lines (30 loc) · 1.25 KB
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
get:
operationId: searchCourses
tags: [course]
summary: Get a list of courses
description: |
This allows you to search for courses get details about the course. The search filter attributes are all optional.
You may only set either **query** or **folder** at **_one time_**. If the limit query parameter is not provided, the
number of courses returned is defaulted to 100. This endpoint is only available to superusers and staff
responses:
'200':
$ref: ../components/responses/course-list.yaml
default:
$ref: ../components/responses/problem.yaml
parameters:
- name: query
in: query
description: |
Will do a fuzzy match on the `course` name. **_You may only define either query or folder at a time._**
schema:
type: string
- name: folder
in: query
description: |
Passing folder ID will return related courses as suggestions. If the folder contains curriculum code(s), the
suggestions will return a list of other courses that fulfils the same curriculum code(s).
**_You may only define either query or folder at a time._**
schema:
type: integer
- $ref: ../components/parameters/cursor.yaml
- $ref: ../components/parameters/limit.yaml