-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
142 lines (142 loc) · 4.39 KB
/
swagger.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
swagger: '2.0'
info:
title: 'Staff Fee Privilege API'
description: Get information about people who used the staff fee privilege.
version: '1.0.0'
license:
name: 'GNU Affero General Public License Version 3'
url: 'http://www.gnu.org/licenses/agpl-3.0.en.html'
externalDocs:
description: 'GitHub Repository'
url: 'https://github.com/osu-mist/staff-fee-privilege-api'
host: 'api.oregonstate.edu'
schemes:
- https
basePath: /v1
produces:
- application/json
security:
- OAuth2:
- full
paths:
'/staff-fee-privilege':
get:
description: 'Get all students who use staff fee privilege by term'
operationId: getStaffFeePrivileges
parameters:
- in: query
name: term
description: 'Term code (e.g., 201803)'
type: string
- in: query
name: osuId
description: 'OSU ID'
type: string
responses:
'200':
description: 'Successful response'
schema:
$ref: '#/definitions/StaffFeePrivilegeResultObjects'
'400':
description: 'Bad request'
schema:
$ref: '#/definitions/Error'
'500':
description: 'Internal Server Error'
schema:
$ref: '#/definitions/Error'
'/staff-fee-privilege/{id}':
get:
description: 'Get student who uses staff fee privilege by unique ID'
operationId: getStaffFeePrivilegeByID
parameters:
- name: id
in: path
description: 'Concatenate OSU ID and a 6 digit term code with a dash delimiter (e.g., 931234567-201802)'
required: true
type: string
responses:
'200':
description: 'Successful response'
schema:
$ref: '#/definitions/StaffFeePrivilegeResultObject'
'404':
description: 'A staff fee privilege record with the specified ID was not found.'
schema:
$ref: '#/definitions/Error'
'500':
description: 'Internal Server Error'
schema:
$ref: '#/definitions/Error'
securityDefinitions:
OAuth2:
type: oauth2
flow: application
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
definitions:
StaffFeePrivilegeResultObjects:
properties:
data:
type: array
items:
$ref: '#/definitions/StaffFeePrivilegeRourceObject'
StaffFeePrivilegeResultObject:
properties:
data:
$ref: '#/definitions/StaffFeePrivilegeRourceObject'
StaffFeePrivilegeRourceObject:
properties:
id:
type: string
description: 'A unique ID concatenated with OSU ID, a dash delimiter and a 6 digit term code'
example: '931234567-201803'
type:
type: string
example: 'staffFeePrivileges'
links:
$ref: '#/definitions/SelfLink'
attributes:
properties:
term:
type: string
description: '6 digit term code'
studentOsuId:
type: string
description: 'OSU ID of student'
studentLastName:
type: string
description: 'Last name of student'
studentFirstName:
type: string
description: 'First name student'
studentMiddleName:
type: string
description: 'Middle name student'
employeeOsuId:
type: string
description: 'OSU ID of employee giving waiver to student'
employeeLastName:
type: string
description: 'Last name of employee giving waiver to student'
employeeFirstName:
type: string
description: 'First name of employee giving waiver to student'
SelfLink:
properties:
self:
type: string
format: url
description: 'Self link of resource'
Error:
properties:
status:
type: string
description: 'The HTTP status code applicable to this problem, expressed as a string value'
title:
type: string
description: 'A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization'
detail:
type: string
description: 'A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized'