-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
399 lines (399 loc) · 11 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
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
swagger: '2.0'
info:
title: Notes API
description: Provides operations for notes that advisors have made on students.
version: v1
license:
name: GNU Affero General Public License Version 3
url: http://www.gnu.org/licenses/agpl-3.0.en.html
contact:
name: IS Data Architecture Team
url: https://is.oregonstate.edu/data-architecture
email: isdataarchitecture@oregonstate.edu
schemes:
- https
host: api.oregonstate.edu
basePath: /v1
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/notes-api
produces:
- application/json
consumes:
- application/json
security:
- OAuth2:
- full
paths:
/notes:
get:
summary: Get notes for a student
tags:
- notes
operationId: getNotes
parameters:
- name: filter[studentId]
in: query
type: string
pattern: ^\d{9}$
required: true
description: 9-digit OSU ID of student whose notes will be retrieved
- name: filter[creatorId]
in: query
type: string
pattern: ^\d{9}$
required: false
description: The 9-digit OSU ID of the advisor who created the note
- name: filter[note][fuzzy]
in: query
type: string
required: false
description: Filter notes by fuzzy searching through their note
attribute
- name: sort
in: query
type: string
enum:
- 'lastModified'
- '-lastModified'
- 'source'
- '-source'
- 'permissions'
- '-permissions'
- 'contextType'
- '-contextType'
default: '-lastModified'
required: false
description: "The key by which to sort the notes in the response.
Values that start with '-' indicate descending order. Otherwise,
order will be ascending."
- name: filter[source][oneOf]
in: query
type: array
items:
type: string
collectionFormat: csv
required: false
description: 'A comma-separated list of sources to filter by. Each
source may include a subSource. The format is: `source` or
`source.subSource`'
- name: filter[contextType][oneOf]
in: query
type: array
items:
type: string
collectionFormat: csv
required: false
description: A comma-separated list of context types to filter by
responses:
'200':
description: Successful response
schema:
$ref: '#/definitions/NotesResult'
'400':
$ref: '#/responses/400'
'500':
$ref: '#/responses/500'
post:
summary: Create a new note
tags:
- notes
operationId: postNote
parameters:
- in: body
name: requestBody
schema:
$ref: '#/definitions/NotePostBody'
responses:
'201':
description: Successfully created a note
schema:
$ref: '#/definitions/NoteResult'
headers:
Location:
type: string
format: url
description: Location of the newly created resource
'400':
description: Invalid note object
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal server error
schema:
$ref: '#/definitions/ErrorResult'
/notes/{noteId}:
parameters:
- $ref: '#/parameters/noteId'
get:
summary: Get a note by its noteId
tags:
- notes
operationId: getNoteById
responses:
'200':
description: Successfully retrieved note
schema:
$ref: '#/definitions/NoteResult'
'404':
description: Note with this noteId not found
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal server error
schema:
$ref: '#/definitions/ErrorResult'
patch:
summary: Edit an existing note
tags:
- notes
operationId: patchNoteById
parameters:
- in: body
name: requestBody
schema:
type: object
properties:
note:
$ref: '#/definitions/note'
permissions:
$ref: '#/definitions/permissions'
additionalProperties: false
responses:
'200':
description: Successfully updated the note
schema:
$ref: '#/definitions/NoteResult'
'400':
description: Invalid patch body
schema:
$ref: '#/definitions/ErrorResult'
'404':
description: Note not found
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal server error
schema:
$ref: '#/definitions/ErrorResult'
delete:
summary: Delete an existing note
tags:
- notes
operationId: deleteNoteById
responses:
'204':
description: Successfully deleted the note
'404':
description: Note not found
schema:
$ref: '#/definitions/ErrorResult'
'500':
$ref: '#/responses/500'
parameters:
noteId:
name: noteId
in: path
type: string
required: true
description: A unique ID of a note concatenating the student ID that the note is for with a random string
authorization:
name: Authorization
in: header
type: string
required: true
description: '"Bearer [token]" where [token] is your OAuth2 access token'
responses:
'400':
description: Bad request
schema:
$ref: '#/definitions/ErrorResult'
'500':
description: Internal server error
schema:
$ref: '#/definitions/ErrorResult'
securityDefinitions:
OAuth2:
type: oauth2
flow: application
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
definitions:
NoteResource:
properties:
id:
$ref: '#/definitions/noteId'
type:
$ref: '#/definitions/noteType'
attributes:
type: object
properties:
note:
$ref: '#/definitions/note'
studentId:
$ref: '#/definitions/studentId'
creatorId:
$ref: '#/definitions/creatorId'
source:
$ref: '#/definitions/source'
subSource:
$ref: '#/definitions/subSource'
permissions:
$ref: '#/definitions/permissions'
context:
$ref: '#/definitions/context'
dateCreated:
$ref: '#/definitions/dateCreated'
lastModified:
$ref: '#/definitions/lastModified'
links:
$ref: '#/definitions/SelfLink'
NoteResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
$ref: '#/definitions/NoteResource'
NotesResult:
properties:
links:
$ref: '#/definitions/SelfLink'
data:
type: array
items:
$ref: '#/definitions/NoteResource'
NotePostBody:
type: object
properties:
data:
type: object
properties:
type:
$ref: '#/definitions/noteType'
attributes:
type: object
properties:
note:
$ref: '#/definitions/note'
studentId:
$ref: '#/definitions/studentId'
creatorId:
$ref: '#/definitions/creatorId'
permissions:
allOf:
- default: 'advisor'
- $ref: '#/definitions/permissions'
context:
$ref: '#/definitions/context'
required:
- note
- studentId
- creatorId
additionalProperties: false
required:
- type
- attributes
additionalProperties: false
required:
- data
additionalProperties: false
SelfLink:
properties:
self:
type: string
format: url
description: Self-link of current resource
ErrorObject:
properties:
status:
type: string
description: HTTP status code
example: '123'
title:
type: string
description: A short, user readable summary of the error
example: Not Found
code:
type: string
description: An application-specific error code
example: '1234'
detail:
type: string
description: A long description of the error that may contain instance-specific details
links:
properties:
about:
type: string
format: uri
description: A link to further information about the error
example: https://developer.oregonstate.edu/documentation/error-reference#1234
ErrorResult:
properties:
errors:
type: array
items:
$ref: '#/definitions/ErrorObject'
noteId:
type: string
description: A unique ID of a note concatenating the student ID that the note is for with a random string
example: 123456789-123-abc
note:
type: string
maxLength: 150
description: The contents of the note
studentId:
type: string
pattern: ^\d{9}$
description: The 9-digit OSU ID of the student who the note is on
example: '123456789'
creatorId:
type: string
pattern: ^\d{9}$
description: The 9-digit OSU ID of the advisor who created the note
example: '987654321'
source:
type: string
description: The data source of the note
example: advisorPortal
subSource:
type: string
description: The sub-source of the note. Used when a source has sub-groups that have different permission levels.
permissions:
type: string
enum:
- 'advisor'
- 'advisors'
- 'student'
description: "A string that defines the permissions of who can view the note. 'advisor' indicates that only
the advisor who created the note may view it. 'advisors' indicates that all advisors can view the note.
'student' indicates that all advisors as well as the student who the note is on may view the note."
noteType:
type: string
enum:
- note
context:
type: object
properties:
contextType:
type: string
description: The context type of the note
example: 'course'
contextId:
type: string
description: The context id of the note
example: 'CS-101'
required:
- contextType
- contextId
dateCreated:
type: string
format: date-time
description: The original date that the note was created
example: '2017-07-21T17:32:28Z'
lastModified:
type: string
format: date-time
description: The date that the note was last modified. If this value is the same as dateCreated, no edits
have been made to the note.
example: '2017-07-21T17:32:28Z'