-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
161 lines (143 loc) · 3.92 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
swagger: '2.0'
info:
description: "This API retrieves CORE permissions information on different users."
version: "1.0"
title: "CORE Permissions API"
tags:
- name: "permissions"
description: "HR, Student, and Finance permissions (1-5)"
schemes:
- "https"
host: "api.oregonstate.edu"
basePath: "/v1"
externalDocs:
description: "GitHub Repository"
url: "https://github.com/osu-mist/core-permissions-api"
consumes:
- "application/json"
produces:
- "application/json"
paths:
/core-permissions/{id}:
get:
tags:
- "permissions"
summary: "Retrieve permissions for user by their OSU ID"
operationId: "getPermissionsById"
parameters:
- name: "id"
in: "path"
description: "OSU ID of person whose permissions will be retrieved"
required: true
type: "string"
responses:
200:
description: "Permissions successfully retrieved"
schema:
$ref: "#/definitions/PermissionsResult"
404:
description: "No permissions found for this OSU ID"
schema:
$ref: "#/definitions/Error"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/Error"
/core-permissions:
get:
tags:
- "permissions"
summary: "Retrieve permissions for user by parameters"
operationId: "getPermissions"
parameters:
- name: "id"
in: "query"
description: "OSU ID of person whose permissions will be retrieved"
required: false
type: "string"
- name: "username"
in: "query"
description: "ONID of person whose permissions will be retrieved"
required: false
type: "string"
responses:
200:
description: "Permissions successfully retrieved"
schema:
$ref: "#/definitions/PermissionsResult"
400:
description: "Bad request"
schema:
$ref: "#/definitions/Error"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/Error"
definitions:
Permissions:
type: "object"
properties:
username:
type: "string"
description: "ONID of person who permissions belong to"
example: "browni"
hrPermissionLevel:
type: "integer"
minimum: 0
maximum: 5
description: "HR permission level"
example: 1
studentPermissionLevel:
type: "integer"
minimum: 0
maximum: 5
description: "Student permission level"
example: 2
financialPermissionLevel:
type: "integer"
minimum: 0
maximum: 4
description: "Finance permission level"
example: 3
SelfLink:
type: "object"
properties:
self:
type: "string"
format: "url"
description: "Self link of resource"
example: "https://api.oregonstate.edu/v1/core-permissions/123456789"
PermissionsResource:
type: "object"
properties:
id:
type: "string"
description: "OSU ID of person who permissions belong to"
example: "123456789"
type:
type: "string"
example: "permissions"
attributes:
$ref: "#/definitions/Permissions"
links:
$ref: "#/definitions/SelfLink"
PermissionsResult:
type: "object"
properties:
data:
$ref: "#/definitions/PermissionsResource"
Error:
type: "object"
properties:
status:
type: "integer"
description: "HTTP status code"
example: 123
code:
type: "integer"
description: "Specific error code"
example: 1400
detail:
type: "string"
description: "Link to further information on error code"
example: "https://developer.oregonstate.edu/documentation/error-reference#1400"