solarwinds-itsm-api-definitions 0.2.5 → 0.2.19

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/change.json CHANGED
@@ -10,12 +10,13 @@
10
10
  "description": "description",
11
11
  "state_id": 1,
12
12
  "assignee": { "email": "john.doe@email.com" },
13
+ "group_assignee": { "name": "Helpdesk Team" },
13
14
  "requester": { "email": "john.doe@email.com" },
14
15
  "priority": "High",
15
16
  "change_plan": "change plan",
16
17
  "rollback_plan": "rollback plan",
17
- "test_plan": "test plan" ,
18
- "planned_start_at": "2025-01-01 00:00" ,
18
+ "test_plan": "test plan",
19
+ "planned_start_at": "2025-01-01 00:00",
19
20
  "planned_end_at": "2025-01-01 05:00",
20
21
  "add_to_tag_list": "tag1, tag2",
21
22
  "remove_from_tag_list": "tag3",
@@ -30,10 +31,14 @@
30
31
  { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
31
32
  ]
32
33
  },
33
- "incidents": [{ "number": "100" }],
34
- "problems": [{ "number": "100" }],
35
- "releases": [{ "number": "100" }],
36
- "configuration_item_ids":["100"]
34
+ "configuration_item_ids":[100],
35
+ "incidents": [{ "number": 100}],
36
+ "problems": [{ "number": 100}],
37
+ "changes": [{ "number": 100}],
38
+ "solutions": [{ "number": 100}],
39
+ "releases": [{ "number": 100}],
40
+ "purchase_orders": [{ "number": 100}],
41
+ "configuration_items": [{ "name": "Item name" }]
37
42
  }
38
43
  }
39
44
  },
@@ -45,24 +50,92 @@
45
50
  "name": "Change Name",
46
51
  "description": "description",
47
52
  "state": "New",
48
- "site": {
53
+ "site": { "$ref": "./associations/site.json#/site" },
54
+ "department": { "$ref": "./associations/department.json#/department" },
55
+ "priority": "High",
56
+ "assignee": {
57
+ "group_id": "1",
58
+ "is_user": "true",
49
59
  "id": "1",
50
- "name": "Austin TX, USA",
51
- "location": "AUS",
52
- "description": "",
53
- "time_zone": ""
60
+ "name": "John Doe",
61
+ "email": "john.doe@email.com",
62
+ "avatar": {
63
+ "type": "initials",
64
+ "color": "#fd4165",
65
+ "initials": "JD"
66
+ }
54
67
  },
55
- "department": {
68
+ "group_assignee": { "$ref": "./associations/group_assignee.json#/group_assignee" },
69
+ "requester": {
56
70
  "id": "1",
57
- "name": "Support",
58
- "description": "",
59
- "default_assignee_id": "1"
71
+ "account_id": "1",
72
+ "user_id": "1",
73
+ "email": "john.doe@email.com",
74
+ "name": "John Doe",
75
+ "disabled": false,
76
+ "avatar": {
77
+ "type": "initials",
78
+ "color": "#fd4165",
79
+ "initials": "JD"
80
+ }
60
81
  },
82
+ "custom_fields_values": [
83
+ {
84
+ "id": "10",
85
+ "custom_field_id": "1",
86
+ "name": "Text custom field",
87
+ "value": "content",
88
+ "options": "",
89
+ "type_name": "Text"
90
+ },
91
+ {
92
+ "id": "100",
93
+ "custom_field_id": "2",
94
+ "name": "User custom field",
95
+ "value": "1",
96
+ "options": "",
97
+ "type_name": "User",
98
+ "user": {
99
+ "group_id": 1,
100
+ "is_user": true,
101
+ "id": 1,
102
+ "name": "John Doe",
103
+ "email": "john.doe@email.com"
104
+ }
105
+ }
106
+ ],
107
+ "change_plan": "change plan",
108
+ "rollback_plan": "rollback plan",
109
+ "test_plan": "test plan",
110
+ "planned_start_at": "2025-01-01T00:00:00.000+01:00",
111
+ "planned_end_at": "2025-01-01T05:00:00.000+01:00",
112
+ "origin": "api",
113
+ "created_at": "2025-01-01T00:00:00.000+01:00",
114
+ "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
115
+ "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
116
+ "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
117
+ "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/100"}],
118
+ "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
119
+ "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}],
120
+ "purchase_orders": [{ "id": "100", "href": "https://mydomain.com/purchase_orders/100"}]
121
+ }
122
+ }
123
+ },
124
+ "response_long": {
125
+ "json": {
126
+ "change": {
127
+ "id": "10000",
128
+ "number": "1000",
129
+ "name": "Change Name",
130
+ "description": "description",
131
+ "state": "New",
132
+ "site": { "$ref": "./associations/site.json#/site" },
133
+ "department": { "$ref": "./associations/department.json#/department" },
61
134
  "priority": "High",
62
135
  "assignee": {
63
136
  "group_id": "1",
64
137
  "is_user": "true",
65
- "id": "1",
138
+ "id": "1",
66
139
  "name": "John Doe",
67
140
  "email": "john.doe@email.com",
68
141
  "avatar": {
@@ -71,6 +144,7 @@
71
144
  "initials": "JD"
72
145
  }
73
146
  },
147
+ "group_assignee": { "$ref": "./associations/group_assignee.json#/group_assignee" },
74
148
  "requester": {
75
149
  "id": "1",
76
150
  "account_id": "1",
@@ -111,17 +185,156 @@
111
185
  ],
112
186
  "change_plan": "change plan",
113
187
  "rollback_plan": "rollback plan",
114
- "test_plan": "test plan" ,
115
- "planned_start_at": "2025-01-01T00:00:00.000+01:00" ,
188
+ "test_plan": "test plan",
189
+ "planned_start_at": "2025-01-01T00:00:00.000+01:00",
116
190
  "planned_end_at": "2025-01-01T05:00:00.000+01:00",
117
191
  "origin": "api",
118
192
  "created_at": "2025-01-01T00:00:00.000+01:00",
119
193
  "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
120
194
  "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
195
+ "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
196
+ "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/100"}],
121
197
  "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
122
- "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
198
+ "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}],
199
+ "purchase_orders": [{ "id": "100", "href": "https://mydomain.com/purchase_orders/100"}],
200
+ "attachments": [
201
+ {
202
+ "id": 212598157,
203
+ "content_type": "application/json",
204
+ "size": 583,
205
+ "filename": "myjson.json",
206
+ "url": "https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson",
207
+ "shared_attachment": false,
208
+ "attachable_id": 753657,
209
+ "attachable_type": "Problem",
210
+ "attachment_type": "attachment",
211
+ "thumb_url": "/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true",
212
+ "secure_url": "/attachments/c4d6df03448d80c4d9c1/myjson.json",
213
+ "link_uuid_url": "/attachments/c4d6df03448d80c4d9c1",
214
+ "uuid": "c4d6df03448d80c4d9c1"
215
+ },
216
+ {
217
+ "id": 212598158,
218
+ "content_type": "text/plain",
219
+ "size": 251,
220
+ "filename": "notpersonal.txt",
221
+ "url": "https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson",
222
+ "shared_attachment": false,
223
+ "attachable_id": 753657,
224
+ "attachable_type": "Problem",
225
+ "attachment_type": "attachment",
226
+ "thumb_url": "/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true",
227
+ "secure_url": "/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain",
228
+ "link_uuid_url": "/attachments/9d2e6444a7773cacab39",
229
+ "uuid": "9d2e6444a7773cacab39"
230
+ }
231
+ ],
232
+ "statistics": [
233
+ {
234
+ "statistic_type": "last_state_change",
235
+ "time": null,
236
+ "time_elapsed": null,
237
+ "business_time_elapsed": null,
238
+ "value": "{\"last_updated\":\"2024-12-21T23:39:47+02:00\",\"history\":[{\"id\":347869,\"title\":\"\",\"startTime\":\"2024-09-15T14:49:09.000-07:00\",\"endTime\":\"2024-12-21T17:11:08.629+00:00\",\"timeSpent\":8364120,\"timeSpentBH\":1976400,\"timeSinceCreation\":0,\"timeSinceCreationBH\":0,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"347869\":8364119.83482472},\"bh_summary\":{\"347869\":1976400}}"
239
+ },
240
+ {
241
+ "statistic_type": "to_assignment",
242
+ "time": "2323:09",
243
+ "time_elapsed": "2323:09",
244
+ "business_time_elapsed": "549:00",
245
+ "value": "2024-12-21 16:57:12 UTC"
246
+ },
247
+ {
248
+ "statistic_type": "last_reassigned",
249
+ "time": null,
250
+ "time_elapsed": null,
251
+ "business_time_elapsed": null,
252
+ "value": "{\"last_updated\":\"2024-12-21T19:36:33+02:00\",\"history\":[{\"id\":12034043,\"title\":\"Abhilash\",\"startTime\":\"2024-12-21T18:57:12.000+02:00\",\"endTime\":\"2024-12-21T17:03:27.449+00:00\",\"timeSpent\":375,\"timeSpentBH\":0,\"timeSinceCreation\":8363283,\"timeSinceCreationBH\":1976400,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"12034043\":375.687147794},\"bh_summary\":{\"12034043\":0}}"
253
+ },
254
+ {
255
+ "statistic_type": "to_approval",
256
+ "time": "2327:50",
257
+ "time_elapsed": "2327:50",
258
+ "business_time_elapsed": "549:00",
259
+ "value": "2024-12-21 21:38:59 UTC"
260
+ },
261
+ {
262
+ "statistic_type": "to_decline",
263
+ "time": "2323:31",
264
+ "time_elapsed": "2323:31",
265
+ "business_time_elapsed": "549:00",
266
+ "value": "2024-12-21 17:19:37 UTC"
267
+ },
268
+ {
269
+ "statistic_type": "to_closed_completed",
270
+ "time": "2327:51",
271
+ "time_elapsed": "2327:51",
272
+ "business_time_elapsed": "549:00",
273
+ "value": "2024-12-21 21:39:47 UTC"
274
+ },
275
+ {
276
+ "statistic_type": "to_closed_incomplete",
277
+ "time": "2323:32",
278
+ "time_elapsed": "2323:32",
279
+ "business_time_elapsed": "549:00",
280
+ "value": "2024-12-21 17:20:59 UTC"
281
+ },
282
+ {
283
+ "statistic_type": "to_first_response",
284
+ "time": "2326:47",
285
+ "time_elapsed": "2326:47",
286
+ "business_time_elapsed": "549:00",
287
+ "value": "2024-12-21 20:35:16 UTC"
288
+ }],
289
+ "shared_attachments": [{
290
+ "id": 212598158,
291
+ "content_type": "application/json",
292
+ "size": 583,
293
+ "filename": "myjson.json",
294
+ "url": "https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson",
295
+ "shared_attachment": true,
296
+ "attachable_id": 753657,
297
+ "attachable_type": "Problem",
298
+ "attachment_type": "attachment",
299
+ "thumb_url": "/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true",
300
+ "secure_url": "/attachments/c4d6df03448d80c4d9c1/myjson.json",
301
+ "link_uuid_url": "/attachments/c4d6df03448d80c4d9c1",
302
+ "uuid": "c4d6df03448d80c4d9c1"
303
+ }],
304
+ "comments": [
305
+ {
306
+ "id": 10,
307
+ "body": "everybody",
308
+ "user": {
309
+ "id": 4713,
310
+ "name": "Simmy",
311
+ "email": "simmy.dian@mydomain.com",
312
+ "avatar": {
313
+ "type": "image",
314
+ "image_class": "gravatar_image",
315
+ "sso_image_class": "",
316
+ "avatar_url": "https://secure.gravatar.com/avatar/8f6284"
317
+ }
318
+ },
319
+ "created_at": "2024-08-18T22:40:42.000-07:00",
320
+ "updated_at": "2024-08-18T22:40:42.000-07:00",
321
+ "attachments": [],
322
+ "inline_attachments": [],
323
+ "shared_attachments": [],
324
+ "is_private": false,
325
+ "seen_by": [8610546],
326
+ "isTask": false,
327
+ "task_info": {},
328
+ "requester": null,
329
+ "commenter_id": 139207697,
330
+ "commenter_type": "Incident",
331
+ "origin": 0
332
+ }
333
+ ],
334
+ "number_of_comments": 1,
335
+ "user_saw_all_comments": true
123
336
  }
124
337
  }
125
338
  }
126
339
  }
127
- }
340
+ }
data/lib/definitions/common/examples/change_catalog.json CHANGED
@@ -10,10 +10,11 @@
10
10
  "description": "description",
11
11
  "state_id": 1,
12
12
  "default_assignee_id": 1,
13
+ "default_group_assignee_id": 1,
13
14
  "priority": "High",
14
15
  "change_plan": "change plan",
15
16
  "rollback_plan": "rollback plan",
16
- "test_plan": "test plan" ,
17
+ "test_plan": "test plan",
17
18
  "add_to_tag_list": "tag1, tag2",
18
19
  "remove_from_tag_list": "tag3",
19
20
  "tag_list": "tag1, tag2",
@@ -39,19 +40,8 @@
39
40
  "name": "Change Catalog Name",
40
41
  "description": "description",
41
42
  "state": "Approved",
42
- "site": {
43
- "id": "1",
44
- "name": "Austin TX, USA",
45
- "location": "AUS",
46
- "description": "",
47
- "time_zone": ""
48
- },
49
- "department": {
50
- "id": "1",
51
- "name": "Support",
52
- "description": "",
53
- "default_assignee_id": "1"
54
- },
43
+ "site": { "$ref": "./associations/site.json#/site" },
44
+ "department": { "$ref": "./associations/department.json#/department" },
55
45
  "priority": "High",
56
46
  "default_assignee_id": 1,
57
47
  "custom_fields_values": [
@@ -89,4 +79,4 @@
89
79
  }
90
80
  }
91
81
  }
92
- }
82
+ }
data/lib/definitions/common/examples/change_request.json CHANGED
@@ -9,6 +9,7 @@
9
9
  "priority": "Low",
10
10
  "change_type": "None",
11
11
  "assignee": { "email": "john.doe@email.com" },
12
+ "group_assignee": { "name": "Network Team" },
12
13
  "site": { "name":"Site name" },
13
14
  "department": { "name":"Department name" },
14
15
  "request_variables_attributes": [
@@ -21,7 +22,7 @@
21
22
  "user_value": { "email": "john.doe@email.com" }
22
23
  },
23
24
  {
24
- "name": "MultyPickList variable",
25
+ "name": "MultiPickList variable",
25
26
  "value": "option1#dlmtr#option2"
26
27
  }
27
28
  ]}
data/lib/definitions/common/examples/configuration_item.json CHANGED
@@ -23,7 +23,15 @@
23
23
  "problem_ids": [100],
24
24
  "itsm_change_ids": [100],
25
25
  "release_ids": [100],
26
- "purchase_order_ids":[100]
26
+ "purchase_order_ids":[100],
27
+ "configuration_item_ids":[100],
28
+ "incidents": [{ "number": 100}],
29
+ "problems": [{ "number": 100}],
30
+ "changes": [{ "number": 100}],
31
+ "solutions": [{ "number": 100}],
32
+ "releases": [{ "number": 100}],
33
+ "purchase_orders": [{ "number": 100}],
34
+ "configuration_items": [{ "name": "Item name" }]
27
35
  }
28
36
  }
29
37
  },
@@ -46,23 +54,12 @@
46
54
  },
47
55
  "type_id": 1,
48
56
  "state": "Active",
49
- "site": {
50
- "id": "1",
51
- "name": "Austin TX, USA",
52
- "location": "AUS",
53
- "description": "",
54
- "time_zone": ""
55
- },
56
- "department": {
57
- "id": "1",
58
- "name": "Support",
59
- "description": "",
60
- "default_assignee_id": "1"
61
- },
57
+ "site": { "$ref": "./associations/site.json#/site" },
58
+ "department": { "$ref": "./associations/department.json#/department" },
62
59
  "manager_id": {
63
60
  "group_id": "1",
64
61
  "is_user": "true",
65
- "id": "1",
62
+ "id": "1",
66
63
  "name": "John Doe",
67
64
  "email": "john.doe@email.com",
68
65
  "avatar": {
@@ -74,7 +71,7 @@
74
71
  "user_id": {
75
72
  "group_id": "1",
76
73
  "is_user": "true",
77
- "id": "1",
74
+ "id": "1",
78
75
  "name": "Jane Doe",
79
76
  "email": "jane.doe@email.com",
80
77
  "avatar": {
@@ -100,9 +97,11 @@
100
97
  "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
101
98
  "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
102
99
  "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
103
- "purchase_orders": [{ "id": "100", "href": "https://mydomain.com/releases/100"}]
100
+ "purchase_orders": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
101
+ "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/100"}],
102
+ "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
104
103
  }
105
104
  }
106
105
  }
107
106
  }
108
- }
107
+ }