-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
395 lines (395 loc) · 12.7 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
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
swagger: '2.0'
info:
title: TeamDynamix Wrapper API
description: Wrapper API for TeamDynamix to perform some data manipulation.
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/td-wrapper-api
host: localhost
schemes:
- https
basePath: /v1
produces:
- application/json
consumes:
- application/json
paths:
/teamdynamix/services:
get:
summary: Get all services
tags:
- services
operationId: getServices
description: Get all services with their long descriptions.
parameters:
- $ref: '#/parameters/pretty'
- $ref: '#/parameters/authorization'
responses:
200:
description: Object containing information
schema:
$ref: '#/definitions/ServicesResultObject'
500:
description: Internal Server Error
schema:
$ref: '#/definitions/Errors'
/teamdynamix/services/{id}:
get:
summary: Get a single service by its ID
tags:
- services
operationId: getServiceById
description: Get a single service by its ID.
parameters:
- $ref: '#/parameters/pretty'
- $ref: '#/parameters/id'
responses:
200:
description: Object containing information
schema:
$ref: '#/definitions/ServiceResultObject'
404:
description: Service with the specific ID not found.
schema:
$ref: '#/definitions/Errors'
500:
description: Internal Server Error
schema:
$ref: '#/definitions/Errors'
parameters:
id:
name: id
in: path
required: true
description: Unique ID of TD service
type: string
authorization:
name: Authorization
in: header
type: string
required: true
description: '"Bearer [token]" where [token] is your OAuth2 access token'
pretty:
name: pretty
in: query
type: boolean
required: false
description: If true, JSON response will be pretty-printed
definitions:
ServicesResultObject:
properties:
data:
type: array
items:
$ref: "#/definitions/ServiceResourceObject"
ServiceResultObject:
properties:
data:
$ref: "#/definitions/ServiceResourceObject"
ServiceResourceObject:
properties:
id:
type: string
description: service ID.
type:
type: string
description: service
links:
$ref: "#/definitions/SelfLink"
attributes:
properties:
attachments:
type: array
description: service attachments.
items:
$ref: "#/definitions/Attachment"
categories:
type: array
description: categoriesParsedFromFullCategoryText
items:
type: string
categoryID:
type: string
description: ID of the containing category.
categoryName:
type: string
description: name of the containing category.
compositeName:
type: string
description: composite name of the service, which includes the name of the immediate parent category.
configurationItemID:
type: string
description: ID of the associated configuration item record.
fullCategoryText:
type: string
description: full text of the category hierarchy.
isActive:
type: boolean
description: a boolean value indicating whether the service is active.
isPublic:
type: boolean
description: a boolean value indicating whether the service is public; that is, if it is visible to unauthenticated users.
longDescription:
type: string
description: service's long description, which is used when viewing the specific service. This can contain HTML.
maintenanceScheduleID:
type: string
description: ID of the associated maintenance window.
maintenanceScheduleName:
type: string
description: name of the associated maintenance window.
managerFullName:
type: string
description: full name of the managing person.
managerUid:
type: string
description: UID of the managing person.
managingGroupID:
type: string
description: ID of the managing group.
managingGroupName:
type: string
description: name of the managing group.
name:
type: string
description: service name.
newTicketUrl:
type: string
format: url
description: new ticket URL
order:
type: integer
description: order of the service among its siblings.
requestApplicationID:
type: string
description: ID of the destination application for any generated requests.
requestApplicationIsActive:
type: boolean
description: active status of the destination application for any generated requests.
requestApplicationName:
type: string
description: name of the destination application for any generated requests.
requestText:
type: string
description: custom text used for the "Request This" button.
requestTypeCategoryID:
type: string
description: ID of the associated request type's containing category.
requestTypeCategoryName:
type: string
description: name of the associated request type's containing category.
requestTypeComponent:
type: integer
enum: [0, 1, 4, 9]
description: >
Sort oder:
* 0 - [None] Indicates that a service is not tied to any particular kind of request.
* 1 - [Project] Indicates that a service is tied to some type of project request.
* 4 - [Link] Indicates that a service is tied to an external request available at a custom URL.
* 9 - [Ticket] Indicates that a service is tied to some sort of ticket request.
requestTypeID:
type: string
description: ID of the associated request type.
requestTypeIsActive:
type: boolean
description: a boolean value indicating whether the associated request type is active.
requestTypeName:
type: string
description: name of the associated request type.
requestUrl:
type: string
format: url
description: custom request URL configured for this service.
shortDescription:
type: string
description: service's short description, which is used when displaying the service in a list
accessRequirements:
type: string
description: access requirements
additionalLinkTitle:
type: string
description: additional link title
additionalLinkURL:
type: string
format: url
description: additional link URL
audienceAssociated:
type: string
description: audience associated
audienceDepartments:
type: string
description: audience departments
audienceDescription:
type: string
description: audience description
audienceEmployees:
type: string
description: audience employees
audienceStudents:
type: string
description: audience students
businessContact:
type: string
description: business contact
businessImpact:
type: string
description: business impact
businessOwner:
type: string
description: business owner
businessPriority:
type: string
description: business priority
businessUnit:
type: string
description: business unit
chargesOptionsFees:
type: string
description: charges options fees
cost:
type: string
description: cost
enablingServices:
type: string
description: enabling services
enhancingServices:
type: string
description: enhancing services
escalationContact:
type: string
description: escalation contact
losLearn:
type: string
description: LOS learn
losOperate:
type: string
description: LOS Operate
losResearch:
type: string
description: LOS research
losWork:
type: string
description: LOS work
spanLongDescription:
type: string
description: long description from the span tag of the longDescription field
spanShortDescription:
type: string
description: short description from the span tag of the longDescription field
relatedServices:
type: string
description: related services
requestAccess:
type: string
description: request access
sla:
type: string
description: SLA
securityRating:
type: string
description: security rating
serviceHours:
type: string
description: service hours
serviceManager:
type: string
description: service manager
serviceOwner:
type: string
description: service owner
serviceType:
type: string
description: service type
supportAvailability:
type: string
description: support availability
synonymsList:
type: array
description: synonyms list
items:
type: string
training:
type: string
description: training
value:
type: string
description: value
Attachment:
properties:
id:
type: string
description: attachment ID.
attachmentType:
type: integer
enum: [0, 1, 3, 7, 9, 11, 13, 14, 26, 27, 29, 63]
description: >
Sort oder:
* 0 - [None] Indicates that the type of attachment is unknown.
* 1 - [Project] A project attachment.
* 3 - [Issue] An issue attachment.
* 7 - [Announcement] An announcement attachment.
* 9 - [Ticket] A ticket attachment.
* 11 - [Opportunity] An opportunity attachment.
* 13 - [Forums] A forum post attachment.
* 14 - [Account] A CRM account attachment.
* 26 - [KnowledgeBase] A Knowledge Base article attachment.
* 27 - [Asset] An asset attachment.
* 29 - [Contract] An asset contract attachment.
* 63 - [ConfigurationItem] A configuration item attachment.
itemID:
type: string
description: item ID.
createdUid:
type: string
description: UID of the creator.
createdFullName:
type: string
description: full name of the creator.
createdDate:
type: string
description: creation date.
name:
type: string
description: file name.
size:
type: integer
description: size of the attachment, in bytes.
uri:
type: string
description: URI for this attachment.
contentUri:
type: string
description: URI to retrieve the attachment content.
SelfLink:
properties:
self:
type: string
format: url
description: Self link for resource object.
Errors:
type: array
items:
$ref: "#/definitions/Error"
Error:
properties:
status:
type: string
description: HTTP status code.
links:
properties:
about:
type: string
description: A link to further information about the error.
code:
type: string
description: Error code.
title:
type: string
description: A short, user readable summary of the error
detail:
type: string
description: A long description of the error that may contain instance-specific details.