-
Notifications
You must be signed in to change notification settings - Fork 0
/
rainbow-api-v1-docs.yaml
346 lines (345 loc) · 10.4 KB
/
rainbow-api-v1-docs.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
_type: export
__export_format: 4
__export_date: 2024-05-18T03:38:34.294Z
__export_source: insomnia.desktop.app:v9.1.1
resources:
- _id: req_3779424c0486424b9739c33887354e12
parentId: wrk_scratchpad
modified: 1711773104560
created: 1711773004440
url: localhost:8080/v1/campuses
name: Get Campuses
description: ""
method: GET
body: {}
preRequestScript: ""
parameters: []
headers: []
authentication: {}
metaSortKey: -1711773004440
isPrivate: false
pathParameters: []
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: wrk_scratchpad
parentId: null
modified: 1711773899729
created: 1704494307683
name: Scratch Pad
description: |-
# Rainbow API v1
API documentation for Rainbow API
scope: collection
_type: workspace
- _id: req_5cdb78f8f90b4e21a9b8b33ecc2f73d8
parentId: wrk_scratchpad
modified: 1716000710908
created: 1711773065059
url: localhost:8080/v1/campuses/:instID/terms
name: Get Terms
description: ""
method: GET
body: {}
preRequestScript: ""
parameters: []
headers: []
authentication: {}
metaSortKey: -1711773004390
isPrivate: false
pathParameters:
- name: instID
value: ""
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: req_17fb5a63f13c4910b58cffd2aaae0d93
parentId: wrk_scratchpad
modified: 1716000714310
created: 1711773298646
url: localhost:8080/v1/campuses/:instID/terms/:termID/subjects
name: Get Subjects
description: ""
method: GET
body: {}
preRequestScript: ""
parameters: []
headers: []
authentication: {}
metaSortKey: -1711773004340
isPrivate: false
pathParameters:
- name: instID
value: ""
- name: termID
value: ""
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: req_abc0044ca17446ae97c80b18d5e48507
parentId: wrk_scratchpad
modified: 1716000740040
created: 1711773445039
url: localhost:8080/v1/campuses/:instID/terms/:termID/subjects/:subjectID
name: Get Courses ( /subjects )
description: ""
method: GET
body: {}
preRequestScript: ""
parameters:
- id: pair_7134379a3309461cb75e1f159db5eecb
name: crn
value: ""
description: List of Course Reference Numbers to filter by
disabled: true
type: text
multiline: false
- id: pair_5d27e06407d64ba1b4586b6455c912b9
name: code
value: ""
description: List of course codes to filter by. '*' wild card can be used ie 1**
-> 101, 102, 110 etc
disabled: true
- id: pair_a804df06778140cdacf800f38f65f8a0
name: start_after
value: ""
description: Earliest time a class can start in 24hr format
disabled: true
- id: pair_885abd3cb1f34a4c962c02ae5b648d10
name: end_before
value: ""
description: Latest time a class can run in 24hr format
disabled: true
- id: pair_c74ac7ba8dab496399c5f41862121e34
name: online
value: ""
description: Only classes online sections
disabled: true
- id: pair_7e07d25891bb49328827b0f8fcf00559
name: sync
value: ""
description: Only synchronous sections
disabled: true
- id: pair_9e2b1f02e7d04b6dab120dd990334fe1
name: day
value: ""
description: UH day of week codes to filter by. Append with '!' to inverse
search ie !M -> get all sections not on Monday
disabled: true
- id: pair_6a2279c067ad47f8aeb76aa3b7ac351e
name: instructor
value: ""
description: Instructors to filter by. Append with '!' to inverse search ie !foo
-> get all sections that don't have instructor 'foo'
disabled: true
- id: pair_424303cc55cd4dcd81e784e0752f3a9f
name: keyword
value: ""
description: Keywords to filter course names by. Append with '!' to inverse
search ie !foo -> get all courses that don't have 'foo' in the name
disabled: true
headers: []
authentication: {}
metaSortKey: -1711773004290
isPrivate: false
pathParameters:
- name: instID
value: ""
- name: termID
value: ""
- name: subjectID
value: ""
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: req_3690673048d14c2b967c0371d1c4cbf0
parentId: wrk_scratchpad
modified: 1716000734858
created: 1711773711688
url: localhost:8080/v1/campuses/:instID/terms/:termID/courses
name: Get Courses ( /courses )
description: ""
method: GET
body: {}
preRequestScript: ""
parameters:
- id: pair_7134379a3309461cb75e1f159db5eecb
name: crn
value: ""
description: List of Course Reference Numbers to filter by
disabled: true
type: text
multiline: false
- id: pair_5d27e06407d64ba1b4586b6455c912b9
name: sub
value: ""
description: List of Subjects to filter by
disabled: true
- id: pair_a804df06778140cdacf800f38f65f8a0
name: code
value: ""
description: List of course codes to filter by. '*' wild card can be used ie 1**
-> 101, 102, 110 etc
disabled: true
- id: pair_885abd3cb1f34a4c962c02ae5b648d10
name: start_after
value: ""
description: Earliest time a class can start in 24hr format
disabled: true
- id: pair_c74ac7ba8dab496399c5f41862121e34
name: end_before
value: ""
description: Latest time a class can run in 24hr format
disabled: true
- id: pair_7e07d25891bb49328827b0f8fcf00559
name: online
value: ""
description: Only classes online sections
disabled: true
- id: pair_9e2b1f02e7d04b6dab120dd990334fe1
name: sync
value: ""
description: Only synchronous sections
disabled: true
- id: pair_6a2279c067ad47f8aeb76aa3b7ac351e
name: day
value: ""
description: UH day of week codes to filter by. Append with '!' to inverse
search ie !M -> get all sections not on Monday
disabled: true
- id: pair_424303cc55cd4dcd81e784e0752f3a9f
name: instructor
value: ""
description: Instructors to filter by. Append with '!' to inverse search ie !foo
-> get all sections that don't have instructor 'foo'
disabled: true
- id: pair_1825e378c8584d218892cc87aba2fb95
name: keyword
value: ""
description: Keywords to filter course names by. Append with '!' to inverse
search ie !foo -> get all courses that don't have 'foo' in the name
disabled: true
- id: pair_c5a8fcf2a523492c95d7d6e4d1506022
name: cid
value: ""
description: List of full courses ie ICS 101. '*' wild card can be used ie ICS
1** -> 101, 102, 110 etc
disabled: true
headers: []
authentication: {}
metaSortKey: -1711773004240
isPrivate: false
pathParameters:
- name: instID
value: ""
- name: termID
value: ""
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: req_4124c54ce3d44eb38434ee46f6acd1ec
parentId: wrk_scratchpad
modified: 1716003413488
created: 1715746341414
url: localhost:8080/v1/scheduler/:instID/terms/:termID
name: Get Schedules
description: ""
method: GET
body: {}
preRequestScript: ""
parameters:
- id: pair_7134379a3309461cb75e1f159db5eecb
name: crn
value: ""
description: List of Course Reference Numbers to filter by
disabled: true
type: text
multiline: false
- id: pair_885abd3cb1f34a4c962c02ae5b648d10
name: start_after
value: "1200"
description: Earliest time a class can start in 24hr format
disabled: true
- id: pair_c74ac7ba8dab496399c5f41862121e34
name: end_before
value: ""
description: Latest time a class can run in 24hr format
disabled: true
- id: pair_7e07d25891bb49328827b0f8fcf00559
name: online
value: ""
description: Only classes online sections
disabled: true
- id: pair_9e2b1f02e7d04b6dab120dd990334fe1
name: sync
value: ""
description: Only synchronous sections
disabled: true
- id: pair_6a2279c067ad47f8aeb76aa3b7ac351e
name: day
value: ""
description: UH day of week codes to filter by. Append with '!' to inverse
search ie !M -> get all sections not on Monday
disabled: true
- id: pair_a6dfd524c4834660b83f00a6549b02a4
name: cid
value: ""
description: ""
disabled: true
headers: []
authentication: {}
metaSortKey: -1711773004190
isPrivate: false
pathParameters:
- name: instID
value: ""
- name: termID
value: ""
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global
_type: request
- _id: env_99d30891da4bdcebc63947a8fc17f076de878684
parentId: wrk_scratchpad
modified: 1711500570979
created: 1704494396656
name: Base Environment
data:
rainbow_api: http://localhost:8080/v1
dataPropertyOrder:
"&":
- rainbow_api
color: null
isPrivate: false
metaSortKey: 1704494396657
_type: environment
- _id: jar_99d30891da4bdcebc63947a8fc17f076de878684
parentId: wrk_scratchpad
modified: 1704494396672
created: 1704494396672
name: Default Jar
cookies: []
_type: cookie_jar