solarwinds-itsm-api-definitions 0.2.5 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +4 -4
  2. data/Redocly/development.html +57 -23
  3. data/Redocly/index.html +55 -23
  4. data/Redocly/redoc/schema/resolved_schema.json +1 -1
  5. data/lib/definitions/common/components.json +293 -13
  6. data/lib/definitions/common/examples/associations/category.json +12 -0
  7. data/lib/definitions/common/examples/associations/department.json +9 -0
  8. data/lib/definitions/common/examples/associations/group_assignee.json +27 -0
  9. data/lib/definitions/common/examples/associations/site.json +11 -0
  10. data/lib/definitions/common/examples/associations/sub_category.json +11 -0
  11. data/lib/definitions/common/examples/catalog_item.json +6 -28
  12. data/lib/definitions/common/examples/change.json +233 -20
  13. data/lib/definitions/common/examples/change_catalog.json +5 -15
  14. data/lib/definitions/common/examples/change_request.json +2 -1
  15. data/lib/definitions/common/examples/configuration_item.json +17 -18
  16. data/lib/definitions/common/examples/contract.json +281 -0
  17. data/lib/definitions/common/examples/hardware.json +235 -71
  18. data/lib/definitions/common/examples/incident.json +397 -95
  19. data/lib/definitions/common/examples/other_asset.json +211 -0
  20. data/lib/definitions/common/examples/problem.json +212 -13
  21. data/lib/definitions/common/examples/release.json +26 -22
  22. data/lib/definitions/common/examples/service_request.json +10 -14
  23. data/lib/definitions/common/examples/solution.json +54 -0
  24. data/lib/definitions/common/examples/user.json +4 -15
  25. data/lib/definitions/common/schemas/inventory/mobile.json +2 -0
  26. data/lib/definitions/common/schemas/inventory/other_asset.json +2 -2
  27. data/lib/definitions/common/schemas/procurement/purchase_order.json +97 -1
  28. data/lib/definitions/common/schemas/service_desk/catalog_item.json +1 -0
  29. data/lib/definitions/common/schemas/service_desk/change.json +2 -0
  30. data/lib/definitions/common/schemas/service_desk/change_catalog.json +2 -0
  31. data/lib/definitions/common/schemas/service_desk/change_request.json +1 -0
  32. data/lib/definitions/common/schemas/service_desk/incident.json +72 -23
  33. data/lib/definitions/common/schemas/service_desk/problem.json +2 -0
  34. data/lib/definitions/common/schemas/service_desk/release.json +2 -0
  35. data/lib/definitions/common/schemas/service_desk/service_request.json +2 -6
  36. data/lib/definitions/common/schemas/setup/category.json +4 -2
  37. data/lib/definitions/common/schemas/setup/department.json +3 -1
  38. data/lib/definitions/common/schemas/setup/group.json +3 -2
  39. data/lib/definitions/common/schemas/setup/site.json +4 -1
  40. data/lib/definitions/openapi.json +4 -3
  41. data/lib/definitions/paths/changes/change_by_id.json +6 -2
  42. data/lib/definitions/paths/changes/changes.json +6 -2
  43. data/lib/definitions/paths/contracts/contract_by_id.json +9 -2
  44. data/lib/definitions/paths/contracts/contracts.json +6 -1
  45. data/lib/definitions/paths/hardwares/hardware_by_id.json +6 -2
  46. data/lib/definitions/paths/hardwares/hardwares.json +6 -2
  47. data/lib/definitions/paths/incidents/incident_by_id.json +6 -2
  48. data/lib/definitions/paths/incidents/incidents.json +6 -2
  49. data/lib/definitions/paths/other_assets/other_asset_by_id.json +9 -2
  50. data/lib/definitions/paths/other_assets/other_assets.json +6 -1
  51. data/lib/definitions/paths/problems/problem_by_id.json +6 -2
  52. data/lib/definitions/paths/problems/problems.json +6 -2
  53. data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +3 -2
  54. data/lib/definitions/paths/purchase_orders/purchase_orders.json +3 -2
  55. data/lib/definitions/paths/solutions/solution_by_id.json +6 -2
  56. data/lib/definitions/paths/solutions/solutions.json +6 -2
  57. metadata +15 -6
data/lib/definitions/common/examples/incident.json CHANGED
@@ -9,6 +9,7 @@
9
9
  "description": "description",
10
10
  "state_id": 1,
11
11
  "assignee": { "email": "john.doe@email.com" },
12
+ "group_assignee": { "name": "Network Team" },
12
13
  "requester": { "email": "john.doe@email.com" },
13
14
  "priority": "High",
14
15
  "category": { "name": "Facilities" },
@@ -27,114 +28,415 @@
27
28
  { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
28
29
  ]
29
30
  },
30
- "incidents": [{ "number": "100" }],
31
- "problems": [{ "number": "100" }],
32
- "changes": [{ "number": "100" }],
33
- "solutions": [{ "number" :"100" }],
34
- "releases": [{ "number": "100" }],
35
- "configuration_item_ids":["100"],
31
+ "incidents": [{ "number": 100}],
32
+ "problems": [{ "number": 100}],
33
+ "changes": [{ "number": 100}],
34
+ "solutions": [{ "number": 100}],
35
+ "releases": [{ "number": 100}],
36
+ "purchase_orders": [{ "number": 100}],
37
+ "configuration_items": [{ "name": "Item name" }],
38
+ "configuration_item_ids":[100],
36
39
  "cc": ["jane.doe@email.com"]
37
40
  }
38
41
  }
39
42
  },
40
43
  "response": {
41
44
  "json": {
42
- "incident": {
43
- "id": "10000",
44
- "number": "1000",
45
- "name": "Incident Name",
46
- "description": "description",
47
- "state": "New",
48
- "site": {
49
- "id": "1",
50
- "name": "Austin TX, USA",
51
- "location": "AUS",
52
- "description": "",
53
- "time_zone": ""
54
- },
55
- "department": {
56
- "id": "1",
57
- "name": "Support",
58
- "description": "",
59
- "default_assignee_id": "1"
45
+ "id": 10000,
46
+ "number": 1000,
47
+ "name": "Incident Name",
48
+ "description": "<p>description</p>",
49
+ "description_no_html": "description",
50
+ "state": "New",
51
+ "priority": "High",
52
+ "category": { "$ref": "associations/category.json#/category" },
53
+ "sub_category": { "$ref": "associations/sub_category.json#/sub_category" },
54
+ "assignee": {
55
+ "group_id": 1,
56
+ "is_user": "true",
57
+ "id": 1,
58
+ "name": "John Doe",
59
+ "email": "john.doe@email.com",
60
+ "avatar": {
61
+ "type": "initials",
62
+ "color": "#fd4165",
63
+ "initials": "JD"
64
+ }
65
+ },
66
+ "group_assignee": { "$ref": "./associations/group_assignee.json#/group_assignee" },
67
+ "requester": {
68
+ "id": 1,
69
+ "account_id": 1,
70
+ "user_id": 1,
71
+ "email": "john.doe@email.com",
72
+ "name": "John Doe",
73
+ "disabled": false,
74
+ "has_gravatar": false,
75
+ "customer_satisfaction_survey_time": "2023-01-01T00:00:00.000-04:00",
76
+ "avatar": {
77
+ "type": "initials",
78
+ "color": "#fd4165",
79
+ "initials": "JD"
80
+ }
81
+ },
82
+ "created_at": "2024-01-01T00:00:00.000+01:00",
83
+ "updated_at": "2024-01-01T00:00:00.000+01:00",
84
+ "due_at": "2025-01-01T00:00:00.000+01:00",
85
+ "sla_violations": [
86
+ {
87
+ "id": 1000,
88
+ "name": "SLA0001",
89
+ "sla_id": 289,
90
+ "sla_type": "not_commented",
91
+ "resolved": false,
92
+ "time_delay": 1,
93
+ "time_units": "minutes",
94
+ "assignee": {
95
+ "id": 1,
96
+ "name": "John Doe"
97
+ },
98
+ "group_assignee": {
99
+ "id": 1,
100
+ "name": "Network Team"
101
+ }
102
+ }
103
+ ],
104
+ "number_of_comments": 0,
105
+ "user_saw_all_comments": true,
106
+ "is_service_request": false,
107
+ "created_by": {
108
+ "id": 1,
109
+ "account_id": 1,
110
+ "user_id": 1,
111
+ "email": "john.doe@email.com",
112
+ "name": "John Doe",
113
+ "disabled": false,
114
+ "has_gravatar": false,
115
+ "customer_satisfaction_survey_time": "2023-01-01T00:00:00.000-04:00",
116
+ "avatar": {
117
+ "type": "initials",
118
+ "color": "#fd4165",
119
+ "initials": "JD"
120
+ }
121
+ },
122
+ "resolved_by": {
123
+ "id": 1,
124
+ "name": "John Doe",
125
+ "disabled": false,
126
+ "title": "title",
127
+ "email": "john.doe@email.com",
128
+ "created_at": "2023-01-01T00:00:00.000-00:00",
129
+ "updated_at": "2023-01-01T00:00:00.000-00:00",
130
+ "last_login": "2023-01-01T00:00:00.000-00:00",
131
+ "phone": "0123-456-789",
132
+ "mobile_phone": "0987-654-321",
133
+ "role": {
134
+ "id": 1,
135
+ "name": "Administrator",
136
+ "description": "description",
137
+ "portal": false,
138
+ "show_my_tasks": false
60
139
  },
61
- "category": {
62
- "id": "10000",
63
- "name": "Facilities",
64
- "default_tags": "tagA, tagB",
65
- "parent_id": "null",
66
- "default_assignee_id": "1"
140
+ "group_ids": [ 1 ],
141
+ "available_for_assignment": false,
142
+ "can_be_available_for_assignment": false,
143
+ "provider": "provider",
144
+ "custom_fields_values": [],
145
+ "site": { "$ref": "./associations/site.json#/site" },
146
+ "department": { "$ref": "./associations/department.json#/department" },
147
+ "avatar": {
148
+ "type": "initials",
149
+ "color": "#fd4165",
150
+ "initials": "JD"
67
151
  },
68
- "subcategory": {
69
- "id": "1000",
70
- "name": "Equipment",
71
- "default_tags": "",
72
- "parent_id": "10000",
73
- "default_assignee_id": "1"
152
+ "reports_to": {}
153
+ },
154
+ "resolution_description": "description",
155
+ "resolution_code": "Done",
156
+ "customer_satisfaction_survey_sent_at": "2020-01-01T00:00:00.000-00:00",
157
+ "customer_satisfaction_survey_completed_at": "2020-01-01T00:00:00.000-00:00",
158
+ "custom": "2020-01-01 00:00:00.000",
159
+ "href": "http://mydomain.com/incidents/100",
160
+ "href_account_domain": "http://mydomain.com/incidents/100",
161
+ "site": { "$ref": "./associations/site.json#/site" },
162
+ "department": { "$ref": "./associations/department.json#/department" },
163
+ "cc": ["jane.doe@email.com"],
164
+ "custom_fields_values": [
165
+ {
166
+ "id": 10,
167
+ "custom_field_id": 1,
168
+ "name": "Text custom field",
169
+ "value": "content",
170
+ "options": "",
171
+ "type_name": "Text"
74
172
  },
75
- "priority": "High",
76
- "assignee": {
77
- "group_id": "1",
78
- "is_user": "true",
79
- "id": "1",
80
- "name": "John Doe",
81
- "email": "john.doe@email.com",
82
- "avatar": {
83
- "type": "initials",
84
- "color": "#fd4165",
85
- "initials": "JD"
173
+ {
174
+ "id": 100,
175
+ "custom_field_id": 2,
176
+ "name": "User custom field",
177
+ "value": "1",
178
+ "options": "",
179
+ "type_name": "User",
180
+ "user": {
181
+ "group_id": 1,
182
+ "is_user": true,
183
+ "id": 1,
184
+ "name": "John Doe",
185
+ "email": "john.doe@email.com"
86
186
  }
87
- },
88
- "requester": {
89
- "id": "1",
90
- "account_id": "1",
91
- "user_id": "1",
92
- "email": "john.doe@email.com",
93
- "name": "John Doe",
94
- "disabled": false,
95
- "avatar": {
96
- "type": "initials",
97
- "color": "#fd4165",
98
- "initials": "JD"
187
+ }
188
+ ],
189
+ "origin": "api",
190
+ "price": "1234.00 USD",
191
+ "releases": [{ "id": 100, "href": "https://mydomain.com/releases/100"}],
192
+ "problems": [{ "id": 100, "href": "https://mydomain.com/problems/100"}],
193
+ "incidents": [{ "id": 100, "href": "https://mydomain.com/incidents/100"}],
194
+ "changes": [{ "id": 100, "href": "https://mydomain.com/changes/100"}],
195
+ "tasks": [{ "id": 100, "href": "https://mydomain.com/incidents/100/tasks/100"}],
196
+ "time_tracks": [{ "id": 100, "href": "https://mydomain.com/incidents/100/time_tracks/100"}],
197
+ "solutions": [{ "id": 100, "href": "https://mydomain.com/solutions/100"}],
198
+ "assets": [{ "id": 100, "href": "https://mydomain.com/hardwares/100"}],
199
+ "mobiles": [{ "id": 100, "href": "https://mydomain.com/mobiles/100"}],
200
+ "other_assets": [{ "id": 100, "href": "https://mydomain.com/other_assets/100"}],
201
+ "configuration_items": [{ "id": 100, "href": "https://mydomain.com/configuration_items/100"}],
202
+ "discovery_hardware": [{ "id": 100, "href": "https://mydomain.com/descovery_hardwares/100"}],
203
+ "purchase_orders": [{ "id": 100, "href": "https://mydomain.com/purchase_orders/100"}]
204
+ }
205
+ },
206
+ "response_long": {
207
+ "json": {
208
+ "id": 10000,
209
+ "number": 1000,
210
+ "name": "Incident Name",
211
+ "description": "<p>description</p>",
212
+ "description_no_html": "description",
213
+ "state": "New",
214
+ "priority": "High",
215
+ "category": { "$ref": "associations/category.json#/category" },
216
+ "sub_category": { "$ref": "associations/sub_category.json#/sub_category" },
217
+ "assignee": {
218
+ "group_id": 1,
219
+ "is_user": "true",
220
+ "id": 1,
221
+ "name": "John Doe",
222
+ "email": "john.doe@email.com",
223
+ "avatar": {
224
+ "type": "initials",
225
+ "color": "#fd4165",
226
+ "initials": "JD"
227
+ }
228
+ },
229
+ "group_assignee": { "$ref": "./associations/group_assignee.json#/group_assignee" },
230
+ "requester": {
231
+ "id": 1,
232
+ "account_id": 1,
233
+ "user_id": 1,
234
+ "email": "john.doe@email.com",
235
+ "name": "John Doe",
236
+ "disabled": false,
237
+ "has_gravatar": false,
238
+ "customer_satisfaction_survey_time": "2023-01-01T00:00:00.000-04:00",
239
+ "avatar": {
240
+ "type": "initials",
241
+ "color": "#fd4165",
242
+ "initials": "JD"
243
+ }
244
+ },
245
+ "created_at": "2024-01-01T00:00:00.000+01:00",
246
+ "updated_at": "2024-01-01T00:00:00.000+01:00",
247
+ "due_at": "2025-01-01T00:00:00.000+01:00",
248
+ "sla_violations": [
249
+ {
250
+ "id": 1000,
251
+ "name": "SLA0001",
252
+ "sla_id": 289,
253
+ "sla_type": "not_commented",
254
+ "resolved": false,
255
+ "time_delay": 1,
256
+ "time_units": "minutes",
257
+ "assignee": {
258
+ "id": 1,
259
+ "name": "John Doe"
260
+ },
261
+ "group_assignee": {
262
+ "id": 1,
263
+ "name": "Network team"
99
264
  }
265
+ }
266
+ ],
267
+ "number_of_comments": 0,
268
+ "user_saw_all_comments": true,
269
+ "is_service_request": false,
270
+ "created_by": {
271
+ "id": 1,
272
+ "account_id": 1,
273
+ "user_id": 1,
274
+ "email": "john.doe@email.com",
275
+ "name": "John Doe",
276
+ "disabled": false,
277
+ "has_gravatar": false,
278
+ "customer_satisfaction_survey_time": "2023-01-01T00:00:00.000-04:00",
279
+ "avatar": {
280
+ "type": "initials",
281
+ "color": "#fd4165",
282
+ "initials": "JD"
283
+ }
284
+ },
285
+ "resolved_by": {
286
+ "id": 1,
287
+ "name": "John Doe",
288
+ "disabled": false,
289
+ "title": "title",
290
+ "email": "john.doe@email.com",
291
+ "created_at": "2023-01-01T00:00:00.000-00:00",
292
+ "updated_at": "2023-01-01T00:00:00.000-00:00",
293
+ "last_login": "2023-01-01T00:00:00.000-00:00",
294
+ "phone": "0123-456-789",
295
+ "mobile_phone": "0987-654-321",
296
+ "role": {
297
+ "id": 1,
298
+ "name": "Administrator",
299
+ "description": "description",
300
+ "portal": false,
301
+ "show_my_tasks": false
100
302
  },
101
- "custom_fields_values": [
102
- {
103
- "id": "10",
104
- "custom_field_id": "1",
105
- "name": "Text custom field",
106
- "value": "content",
107
- "options": "",
108
- "type_name": "Text"
109
- },
110
- {
111
- "id": "100",
112
- "custom_field_id": "2",
113
- "name": "User custom field",
114
- "value": "1",
115
- "options": "",
116
- "type_name": "User",
117
- "user": {
118
- "group_id": 1,
119
- "is_user": true,
120
- "id": 1,
121
- "name": "John Doe",
122
- "email": "john.doe@email.com"
123
- }
303
+ "group_ids": [ 1 ],
304
+ "available_for_assignment": false,
305
+ "can_be_available_for_assignment": false,
306
+ "provider": "provider",
307
+ "custom_fields_values": [],
308
+ "site": { "$ref": "./associations/site.json#/site" },
309
+ "department": { "$ref": "./associations/department.json#/department" },
310
+ "avatar": {
311
+ "type": "initials",
312
+ "color": "#fd4165",
313
+ "initials": "JD"
314
+ },
315
+ "reports_to": {}
316
+ },
317
+ "resolution_description": "description",
318
+ "resolution_code": "Done",
319
+ "customer_satisfaction_survey_sent_at": "2020-01-01T00:00:00.000-00:00",
320
+ "customer_satisfaction_survey_completed_at": "2020-01-01T00:00:00.000-00:00",
321
+ "custom": "2020-01-01 00:00:00.000",
322
+ "href": "http://mydomain.com/incidents/100",
323
+ "href_account_domain": "http://mydomain.com/incidents/100",
324
+ "site": { "$ref": "./associations/site.json#/site" },
325
+ "department": { "$ref": "./associations/department.json#/department" },
326
+ "cc": ["jane.doe@email.com"],
327
+ "custom_fields_values": [
328
+ {
329
+ "id": 10,
330
+ "custom_field_id": 1,
331
+ "name": "Text custom field",
332
+ "value": "content",
333
+ "options": "",
334
+ "type_name": "Text"
335
+ },
336
+ {
337
+ "id": 100,
338
+ "custom_field_id": 2,
339
+ "name": "User custom field",
340
+ "value": "1",
341
+ "options": "",
342
+ "type_name": "User",
343
+ "user": {
344
+ "group_id": 1,
345
+ "is_user": true,
346
+ "id": 1,
347
+ "name": "John Doe",
348
+ "email": "john.doe@email.com"
124
349
  }
125
- ],
126
- "due_at": "2025-01-01T00:00:00.000+01:00",
127
- "origin": "api",
128
- "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
129
- "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
130
- "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
131
- "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/100"}],
132
- "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
133
- "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}],
134
- "is_service_request": false,
135
- "cc": ["jane.doe@email.com"]
136
- }
350
+ }
351
+ ],
352
+ "origin": "api",
353
+ "price": "1234.00 USD",
354
+ "releases": [{ "id": 100, "href": "https://mydomain.com/releases/100"}],
355
+ "problems": [{ "id": 100, "href": "https://mydomain.com/problems/100"}],
356
+ "incidents": [{ "id": 100, "href": "https://mydomain.com/incidents/100"}],
357
+ "changes": [{ "id": 100, "href": "https://mydomain.com/changes/100"}],
358
+ "tasks": [{ "id": 100, "href": "https://mydomain.com/incidents/100/tasks/100"}],
359
+ "time_tracks": [{ "id": 100, "href": "https://mydomain.com/incidents/100/time_tracks/100"}],
360
+ "solutions": [{ "id": 100, "href": "https://mydomain.com/solutions/100"}],
361
+ "assets": [{ "id": 100, "href": "https://mydomain.com/hardwares/100"}],
362
+ "mobiles": [{ "id": 100, "href": "https://mydomain.com/mobiles/100"}],
363
+ "other_assets": [{ "id": 100, "href": "https://mydomain.com/other_assets/100"}],
364
+ "configuration_items": [{ "id": 100, "href": "https://mydomain.com/configuration_items/100"}],
365
+ "discovery_hardware": [{ "id": 100, "href": "https://mydomain.com/descovery_hardwares/100"}],
366
+ "purchase_orders": [{ "id": 100, "href": "https://mydomain.com/purchase_orders/100"}],
367
+ "comments": [
368
+ {
369
+ "id": 10,
370
+ "body": "everybody",
371
+ "user": {
372
+ "id": 4713,
373
+ "name": "Simmy",
374
+ "email": "simmy.dian@mydomain.com",
375
+ "avatar": {
376
+ "type": "image",
377
+ "image_class": "gravatar_image",
378
+ "sso_image_class": "",
379
+ "avatar_url": "https://secure.gravatar.com/avatar/8f6284"
380
+ }
381
+ },
382
+ "created_at": "2024-08-18T22:40:42.000-07:00",
383
+ "updated_at": "2024-08-18T22:40:42.000-07:00",
384
+ "attachments": [],
385
+ "inline_attachments": [],
386
+ "shared_attachments": [],
387
+ "is_private": false,
388
+ "seen_by": [8610546],
389
+ "isTask": false,
390
+ "task_info": {},
391
+ "requester": null,
392
+ "commenter_id": 139207697,
393
+ "commenter_type": "Incident",
394
+ "origin": 0
395
+ }
396
+ ],
397
+ "attachments": [],
398
+ "statistics": [
399
+ {
400
+ "statistic_type": "State Changed",
401
+ "time": "00:01",
402
+ "time_elapsed": "00:01",
403
+ "business_time_elapsed": "00:00",
404
+ "value": "2024-08-20 07:59:20 UTC"
405
+ },
406
+ {
407
+ "statistic_type": "sla_state_changed",
408
+ "time": "00:00",
409
+ "time_elapsed": "00:00",
410
+ "business_time_elapsed": "00:00",
411
+ "value": "2024-08-20 07:58:48 UTC"
412
+ },
413
+ {
414
+ "statistic_type": "to_resolve",
415
+ "time": "00:01",
416
+ "time_elapsed": "00:01",
417
+ "business_time_elapsed": "00:00",
418
+ "value": "2024-08-20 07:59:20 UTC"
419
+ },
420
+ {
421
+ "statistic_type": "to_close",
422
+ "time": "00:02",
423
+ "time_elapsed": "00:02",
424
+ "business_time_elapsed": "00:00",
425
+ "value": "2024-08-18 13:41:58 UTC"
426
+ }
427
+ ],
428
+ "tags": [
429
+ {
430
+ "name": "emr"
431
+ }
432
+ ],
433
+ "associated_sla_names": ["not_resolved"],
434
+ "is_customer_satisfied": "Yes",
435
+ "customer_satisfaction_response": "optimistic, aren't we?",
436
+ "total_time_spent": 0,
437
+ "resolution": null,
438
+ "resolution_type": "Done"
137
439
  }
138
440
  }
139
441
  }
140
- }
442
+ }