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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ec4f6cf44dec385db779ee456a915d9c96c50054207132a59ddf8894c0e56367
4
- data.tar.gz: 6dc14e68309f889ac33dace440abd5971e5c2aa23aa1f94edf4e3a6c046352e8
3
+ metadata.gz: 7abdfd9d8363344fbbb2716fc23096cfadd87f61655e8ec02644220236597c6a
4
+ data.tar.gz: cdec66532407fb51d9fa0c5c65da85b239e0fc67dcb7722e3df2730bedc73e4b
5
5
  SHA512:
6
- metadata.gz: 436e8a739c6ee486244960d74a69961b484b1511f4f8dde82fd18b4d62f7ffeab9cc69f313c1ef72b1cf48d3882895d234d3af020f9db9adf2f8a14dc5f816a7
7
- data.tar.gz: c6cfa5efaa8b10302b167aa55275b1916f25ec7e02175fd53a73e2300dfc18467c7dda072036d7e9260fbce56448e9aa24eea938a02fb627dc6517974ba63a52
6
+ metadata.gz: fd8d19e263ca979f89eec48bfffbf346580279baa284da0fbd626256b9500b5146e1bc834bc7ea7afd318b4fd1d2075cf7d583a9386462d043fd26f5a4ffede9
7
+ data.tar.gz: 30f21dc1024d3d8076eccbd2cdbb98e9798c9b4cd735e55298f1493525568f42c714c813d3c6675deed2a29dec9a4eb77b9013de8946fdc6ce88d73d5b954c6c
@@ -1,5 +1,5 @@
1
1
  <!DOCTYPE html>
2
- <html>
2
+ <html lang="en">
3
3
  <head>
4
4
  <title>SolarWinds ITSM API</title>
5
5
 
@@ -44,36 +44,70 @@
44
44
  <div id="redoc-container">
45
45
  <redoc id="redoc-id" spec-url="http://localhost:4566/redoc/schema"></redoc>
46
46
  </div>
47
- <script id="redoc-script" src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
47
+ <script id="redoc-script" src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.min.js"> </script>
48
48
 
49
49
  <script>
50
- select = document.querySelector(".versions")
51
- options = document.querySelectorAll(".versions option")
50
+ const historyChanges = {
51
+ "March 6, 2025": ["Create level with multiple approvals in purchase order"],
52
+ "January 12, 2025": ["Service Statistics added to the response to changes under the query parameter 'layout=long'"],
53
+ "December 10, 2024": ["Add group assignment in many entities"],
54
+ "September 1, 2024": ["Added details and response examples for the 'layout' query parameter"],
55
+ "Jul 1, 2024": ["Incident name property to be truncated if necessary"],
56
+ "May 26, 2024": ["Incident creation now supports all incident states"],
57
+ "May 23, 2024": ["Added phone_number field to Mobile Device response"],
58
+ "Feb 18, 2024": ["Added API filtering description to General Concepts section"],
59
+ "August 10, 2023": ["Added `custom_fields_values` for the response of getGroups and getGroupById"],
60
+ "June 4, 2023": ["Added all related to all ITSM object"],
61
+ "May 7, 2023": ["Update limitation description"],
62
+ "March 19, 2023": ["Filter by updated_at in incident"]
63
+ }
52
64
  redocElement = document.getElementById("redoc-id")
53
65
  redocScript = document.getElementById("redoc-script")
54
- select.addEventListener("change", function() {
55
- version = this.options[this.selectedIndex].value
56
- redocElement.setAttribute("spec-url", version)
57
- redocScript.remove
58
- body = document.getElementsByTagName("body")[0]
59
- script = document.createElement("script")
60
- script.src = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"
61
- body.appendChild(script)
62
- body.insertBefore(select, body.children[0])
63
- relocateVersionSelectorInterval();
64
- })
66
+
67
+ function createSection(id) {
68
+ // create `p` tag for updates history section
69
+ const newSection = document.createElement("p");
70
+ newSection.id = id;
71
+ newSection.style.padding = "0px 40px";
72
+ return newSection;
73
+ }
65
74
 
66
75
  function onLoadOperations() {
67
76
  relocateVersionSelectorInterval()
68
77
  removeGemVersionFromTitleInterval()
78
+ const isExists = window.setInterval(addUpdatesHistory, 500);
79
+
80
+ function addUpdatesHistory() {
81
+ let historySection = document.getElementById("section/General-Concepts/Updates-History");
82
+ if (historySection !== null) {
83
+ const historySection = document.getElementById("section/General-Concepts/Updates-History");
84
+ const updatesHistorySection = createSection("selected-version")
85
+
86
+ Object.keys(historyChanges).forEach(changesDate =>{
87
+ let selectedH4 = document.createElement("h4");
88
+ selectedH4.textContent = changesDate
89
+ updatesHistorySection.appendChild(selectedH4);
90
+
91
+ let selectedUL = document.createElement("ul");
92
+ historyChanges[changesDate].forEach(description => {
93
+ let selectedLI = document.createElement("li");
94
+ selectedLI.textContent = description
95
+ selectedUL.appendChild(selectedLI);
96
+ })
97
+ updatesHistorySection.appendChild(selectedUL);
98
+ })
99
+ historySection.appendChild(updatesHistorySection);
100
+ window.clearInterval(isExists)
101
+ }
102
+ }
69
103
  }
70
104
 
71
105
  function relocateVersionSelectorInterval() {
72
- var timerVariable = window.setInterval(helper, 500);
106
+ const timerVariable = window.setInterval(helper, 500);
73
107
 
74
108
  function helper() {
75
- body = document.getElementsByTagName("body")[0]
76
- children = body.children
109
+ const body = document.getElementsByTagName("body")[0]
110
+ const children = body.children
77
111
  if (children[0].id == "redoc-container") {
78
112
  window.clearInterval(timerVariable)
79
113
  return
@@ -93,11 +127,11 @@
93
127
  }
94
128
 
95
129
  function removeGemVersionFromTitleInterval() {
96
- var timerVariable = window.setInterval(helper, 500);
130
+ const timerVariable = window.setInterval(helper, 500);
97
131
 
98
132
  function helper() {
99
- allTitles = document.getElementsByTagName("h1")
100
- mainTitle = allTitles[0]
133
+ const allTitles = document.getElementsByTagName("h1")
134
+ const mainTitle = allTitles[0]
101
135
  if (mainTitle?.firstElementChild?.getAttribute("style") === "display:none") {
102
136
  window.clearInterval(timerVariable)
103
137
  return
@@ -109,10 +143,10 @@
109
143
  let allTitles = document.getElementsByTagName("h1")
110
144
  if (allTitles.length === 0) return
111
145
 
112
- titleVersion = allTitles[0].firstElementChild
146
+ const titleVersion = allTitles[0].firstElementChild
113
147
  titleVersion.setAttribute("style", "display:none")
114
148
  }
115
149
  }
116
150
  </script>
117
151
  </body>
118
- </html>
152
+ </html>
data/Redocly/index.html CHANGED
@@ -1,5 +1,5 @@
1
1
  <!DOCTYPE html>
2
- <html>
2
+ <html lang="en">
3
3
  <head>
4
4
  <title>SolarWinds ITSM API</title>
5
5
 
@@ -44,36 +44,68 @@
44
44
  <div id="redoc-container">
45
45
  <redoc id="redoc-id" spec-url="/redoc/schema/resolved_schema.json"></redoc>
46
46
  </div>
47
- <script id="redoc-script" src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
47
+ <script id="redoc-script" src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.min.js"> </script>
48
48
 
49
49
  <script>
50
- select = document.querySelector(".versions")
51
- options = document.querySelectorAll(".versions option")
50
+ const historyChanges = {
51
+ "January 12, 2025": ["Service Statistics added to the response to changes under the query parameter 'layout=long'"],
52
+ "December 10, 2024": ["Add group assignment in many entities"],
53
+ "September 1, 2024": ["Added details and response examples for the 'layout' query parameter"],
54
+ "Jul 1, 2024": ["Incident name property to be truncated if necessary"],
55
+ "June 9, 2024": ["Incident creation now supports all incident states"],
56
+ "May 23, 2024": ["Added phone_number field to Mobile Device response"],
57
+ "Feb 18, 2024": ["Added API filtering description to General Concepts section"],
58
+ "August 10, 2023": ["Added `custom_fields_values` for the response of getGroups and getGroupById"],
59
+ "June 4, 2023": ["Added all related to all ITSM object"],
60
+ "May 7, 2023": ["Update limitation description"],
61
+ "March 19, 2023": ["Filter by updated_at in incident"]
62
+ }
52
63
  redocElement = document.getElementById("redoc-id")
53
64
  redocScript = document.getElementById("redoc-script")
54
- select.addEventListener("change", function() {
55
- version = this.options[this.selectedIndex].value
56
- redocElement.setAttribute("spec-url", version)
57
- redocScript.remove
58
- body = document.getElementsByTagName("body")[0]
59
- script = document.createElement("script")
60
- script.src = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"
61
- body.appendChild(script)
62
- body.insertBefore(select, body.children[0])
63
- relocateVersionSelectorInterval();
64
- })
65
+
66
+ function createSection(id) {
67
+ // create `p` tag for updates history section
68
+ const newSection = document.createElement("p");
69
+ newSection.id = id;
70
+ newSection.style.padding = "0px 40px";
71
+ return newSection;
72
+ }
65
73
 
66
74
  function onLoadOperations() {
67
75
  relocateVersionSelectorInterval()
68
76
  removeGemVersionFromTitleInterval()
77
+ const isExists = window.setInterval(addUpdatesHistory, 500);
78
+
79
+ function addUpdatesHistory() {
80
+ let historySection = document.getElementById("section/General-Concepts/Updates-History");
81
+ if (historySection !== null) {
82
+ const historySection = document.getElementById("section/General-Concepts/Updates-History");
83
+ const updatesHistorySection = createSection("selected-version")
84
+
85
+ Object.keys(historyChanges).forEach(changesDate =>{
86
+ let selectedH4 = document.createElement("h4");
87
+ selectedH4.textContent = changesDate
88
+ updatesHistorySection.appendChild(selectedH4);
89
+ let selectedUL = document.createElement("ul");
90
+ historyChanges[changesDate].forEach(description => {
91
+ let selectedLI = document.createElement("li");
92
+ selectedLI.textContent = description
93
+ selectedUL.appendChild(selectedLI);
94
+ })
95
+ updatesHistorySection.appendChild(selectedUL);
96
+ })
97
+ historySection.appendChild(updatesHistorySection);
98
+ window.clearInterval(isExists)
99
+ }
100
+ }
69
101
  }
70
102
 
71
103
  function relocateVersionSelectorInterval() {
72
- var timerVariable = window.setInterval(helper, 500);
104
+ const timerVariable = window.setInterval(helper, 500);
73
105
 
74
106
  function helper() {
75
- body = document.getElementsByTagName("body")[0]
76
- children = body.children
107
+ const body = document.getElementsByTagName("body")[0]
108
+ const children = body.children
77
109
  if (children[0].id == "redoc-container") {
78
110
  window.clearInterval(timerVariable)
79
111
  return
@@ -93,11 +125,11 @@
93
125
  }
94
126
 
95
127
  function removeGemVersionFromTitleInterval() {
96
- var timerVariable = window.setInterval(helper, 500);
128
+ const timerVariable = window.setInterval(helper, 500);
97
129
 
98
130
  function helper() {
99
- allTitles = document.getElementsByTagName("h1")
100
- mainTitle = allTitles[0]
131
+ const allTitles = document.getElementsByTagName("h1")
132
+ const mainTitle = allTitles[0]
101
133
  if (mainTitle?.firstElementChild?.getAttribute("style") === "display:none") {
102
134
  window.clearInterval(timerVariable)
103
135
  return
@@ -109,10 +141,10 @@
109
141
  let allTitles = document.getElementsByTagName("h1")
110
142
  if (allTitles.length === 0) return
111
143
 
112
- titleVersion = allTitles[0].firstElementChild
144
+ const titleVersion = allTitles[0].firstElementChild
113
145
  titleVersion.setAttribute("style", "display:none")
114
146
  }
115
147
  }
116
148
  </script>
117
149
  </body>
118
- </html>
150
+ </html>