solarwinds-itsm-api-definitions 0.2.7 → 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 +23 -17
  3. data/Redocly/index.html +55 -23
  4. data/Redocly/redoc/schema/resolved_schema.json +1 -1
  5. data/lib/definitions/common/components.json +290 -10
  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 +222 -16
  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 +5 -16
  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 +389 -90
  19. data/lib/definitions/common/examples/other_asset.json +211 -0
  20. data/lib/definitions/common/examples/problem.json +200 -12
  21. data/lib/definitions/common/examples/release.json +12 -20
  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 +1 -1
  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 +10 -3
data/lib/definitions/paths/contracts/contracts.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "description": "List of contracts",
5
5
  "tags": ["Contract"],
6
6
  "parameters": [
7
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
7
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_contracts" }
8
9
  ],
9
10
  "responses": {
10
11
  "200": {
@@ -15,6 +16,10 @@
15
16
  "description": "List of contracts",
16
17
  "type": "array",
17
18
  "items": { "$ref": "../../common/schemas/procurement/contract.json#/components/schemas/response" }
19
+ },
20
+ "examples": {
21
+ "layout=short": { "value": [{ "$ref": "../../common/examples/contract.json#/examples/response/json" }] },
22
+ "layout=long": { "value": [{ "$ref": "../../common/examples/contract.json#/examples/response_long/json" }] }
18
23
  }
19
24
  },
20
25
  "application/xml": {
data/lib/definitions/paths/hardwares/hardware_by_id.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "tags": ["Hardware"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_hardwares" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
@@ -13,7 +14,10 @@
13
14
  "content": {
14
15
  "application/json": {
15
16
  "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" },
16
- "example": { "$ref": "../../common/examples/hardware.json#/examples/response" }
17
+ "examples": {
18
+ "layout=short": { "value": { "$ref": "../../common/examples/hardware.json#/examples/response/json" } },
19
+ "layout=long": { "value": { "$ref": "../../common/examples/hardware.json#/examples/response_long/json" } }
20
+ }
17
21
  },
18
22
  "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" } }
19
23
  }
data/lib/definitions/paths/hardwares/hardwares.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "description": "List of hardwares",
5
5
  "tags": ["Hardware"],
6
6
  "parameters": [
7
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
7
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_hardwares" }
8
9
  ],
9
10
  "responses": {
10
11
  "200": {
@@ -16,7 +17,10 @@
16
17
  "type": "array",
17
18
  "items": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" }
18
19
  },
19
- "example": [{ "$ref": "../../common/examples/hardware.json#/examples/response" }]
20
+ "examples": {
21
+ "layout=short": { "value": [{ "$ref": "../../common/examples/hardware.json#/examples/response/json" }] },
22
+ "layout=long": { "value": [{ "$ref": "../../common/examples/hardware.json#/examples/response_long/json" }] }
23
+ }
20
24
  },
21
25
  "application/xml": {
22
26
  "schema": {
data/lib/definitions/paths/incidents/incident_by_id.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "tags": ["Incident"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
@@ -13,7 +14,10 @@
13
14
  "content": {
14
15
  "application/json": {
15
16
  "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" },
16
- "example": { "$ref": "../../common/examples/incident.json#/examples/response/json" }
17
+ "examples": {
18
+ "layout=short": { "value": { "$ref": "../../common/examples/incident.json#/examples/response/json" } },
19
+ "layout=long": { "value": { "$ref": "../../common/examples/incident.json#/examples/response_long/json" } }
20
+ }
17
21
  },
18
22
  "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" } }
19
23
  }
data/lib/definitions/paths/incidents/incidents.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "tags": ["Incident"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/filter" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/filter" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
@@ -17,7 +18,10 @@
17
18
  "type": "array",
18
19
  "items": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" }
19
20
  },
20
- "example": [{ "$ref": "../../common/examples/incident.json#/examples/response/json" }]
21
+ "examples": {
22
+ "layout=short": { "value": [{ "$ref": "../../common/examples/incident.json#/examples/response/json" }] },
23
+ "layout=long": { "value": [{ "$ref": "../../common/examples/incident.json#/examples/response_long/json" }] }
24
+ }
21
25
  },
22
26
  "application/xml": {
23
27
  "schema": {
data/lib/definitions/paths/other_assets/other_asset_by_id.json CHANGED
@@ -5,13 +5,20 @@
5
5
  "tags": ["Other Asset"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_other_assets" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
12
13
  "description": "Object was returned correctly",
13
14
  "content": {
14
- "application/json": { "schema": { "$ref": "../../common/schemas/inventory/other_asset.json#/components/schemas/response" } },
15
+ "application/json": {
16
+ "schema": { "$ref": "../../common/schemas/inventory/other_asset.json#/components/schemas/response" },
17
+ "examples": {
18
+ "layout=short": { "value": { "$ref": "../../common/examples/other_asset.json#/examples/response/json" } },
19
+ "layout=long": { "value": { "$ref": "../../common/examples/other_asset.json#/examples/response_long/json" } }
20
+ }
21
+ },
15
22
  "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/other_asset.json#/components/schemas/response" } }
16
23
  }
17
24
  },
data/lib/definitions/paths/other_assets/other_assets.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "description": "List of other assets",
5
5
  "tags": ["Other Asset"],
6
6
  "parameters": [
7
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
7
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_other_assets" }
8
9
  ],
9
10
  "responses": {
10
11
  "200": {
@@ -15,6 +16,10 @@
15
16
  "description": "List of other assets",
16
17
  "type": "array",
17
18
  "items": { "$ref": "../../common/schemas/inventory/other_asset.json#/components/schemas/response" }
19
+ },
20
+ "examples": {
21
+ "layout=short": { "value": [{ "$ref": "../../common/examples/other_asset.json#/examples/response/json" }] },
22
+ "layout=long": { "value": [{ "$ref": "../../common/examples/other_asset.json#/examples/response_long/json" }] }
18
23
  }
19
24
  },
20
25
  "application/xml": {
data/lib/definitions/paths/problems/problem_by_id.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "tags": ["Problem"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_problems" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
@@ -13,7 +14,10 @@
13
14
  "content": {
14
15
  "application/json": {
15
16
  "schema": { "$ref": "../../common/schemas/service_desk/problem.json#/components/schemas/response" },
16
- "example": { "$ref": "../../common/examples/problem.json#/examples/response/json" }
17
+ "examples": {
18
+ "layout=short": { "value": { "$ref": "../../common/examples/problem.json#/examples/response/json" } },
19
+ "layout=long": { "value": { "$ref": "../../common/examples/problem.json#/examples/response_long/json" } }
20
+ }
17
21
  },
18
22
  "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/problem.json#/components/schemas/response" } }
19
23
  }
data/lib/definitions/paths/problems/problems.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "description": "List of problems",
5
5
  "tags": ["Problem"],
6
6
  "parameters": [
7
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
7
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_problems" }
8
9
  ],
9
10
  "responses": {
10
11
  "200": {
@@ -16,7 +17,10 @@
16
17
  "type": "array",
17
18
  "items": { "allOf": [{ "$ref": "../../common/schemas/service_desk/problem.json#/components/schemas/response" }] }
18
19
  },
19
- "example": [{ "$ref": "../../common/examples/problem.json#/examples/response/json" }]
20
+ "examples": {
21
+ "layout=short": { "value": [{ "$ref": "../../common/examples/problem.json#/examples/response/json" }] },
22
+ "layout=long": { "value": [{ "$ref": "../../common/examples/problem.json#/examples/response_long/json" }] }
23
+ }
20
24
  },
21
25
  "application/xml": {
22
26
  "schema": {
data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json CHANGED
@@ -26,14 +26,15 @@
26
26
  "tags": ["Purchase Order"],
27
27
  "parameters": [
28
28
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
29
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
29
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
30
+ { "$ref": "../../common/components.json#/components/request/parameters/edit_mode" }
30
31
  ],
31
32
  "requestBody": {
32
33
  "required": true,
33
34
  "description": "Purchase Order fields to update",
34
35
  "content": {
35
36
  "application/json": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/put" } },
36
- "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/put" } }
37
+ "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/put_for_xml" } }
37
38
  }
38
39
  },
39
40
  "responses": {
data/lib/definitions/paths/purchase_orders/purchase_orders.json CHANGED
@@ -37,14 +37,15 @@
37
37
  "description": "Create new purchase order",
38
38
  "tags": ["Purchase Order"],
39
39
  "parameters": [
40
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
40
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
41
+ { "$ref": "../../common/components.json#/components/request/parameters/edit_mode" }
41
42
  ],
42
43
  "requestBody": {
43
44
  "required": true,
44
45
  "description": "Purchase order fields to fill",
45
46
  "content": {
46
47
  "application/json": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/post" } },
47
- "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/post" } }
48
+ "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/purchase_order.json#/components/schemas/request/post_for_xml" } }
48
49
  }
49
50
  },
50
51
  "responses": {
data/lib/definitions/paths/solutions/solution_by_id.json CHANGED
@@ -5,7 +5,8 @@
5
5
  "tags": ["Solution"],
6
6
  "parameters": [
7
7
  { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
- { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
8
+ { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
9
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_solutions" }
9
10
  ],
10
11
  "responses": {
11
12
  "200": {
@@ -13,7 +14,10 @@
13
14
  "content": {
14
15
  "application/json": {
15
16
  "schema": { "$ref": "../../common/schemas/service_desk/solution.json#/components/schemas/response" },
16
- "example": { "$ref": "../../common/examples/solution.json#/examples/response/json" }
17
+ "examples": {
18
+ "layout=short": { "value": { "$ref": "../../common/examples/solution.json#/examples/response/json" } },
19
+ "layout=long": { "value": { "$ref": "../../common/examples/solution.json#/examples/response_long/json" } }
20
+ }
17
21
  },
18
22
  "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/solution.json#/components/schemas/response" } }
19
23
  }
data/lib/definitions/paths/solutions/solutions.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "description": "List of solutions",
5
5
  "tags": ["Solution"],
6
6
  "parameters": [
7
- { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
7
+ { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
8
+ { "$ref": "../../common/components.json#/components/request/parameters/layout_solutions" }
8
9
  ],
9
10
  "responses": {
10
11
  "200": {
@@ -16,7 +17,10 @@
16
17
  "type": "array",
17
18
  "items": { "$ref": "../../common/schemas/service_desk/solution.json#/components/schemas/response" }
18
19
  },
19
- "example": [{ "$ref": "../../common/examples/solution.json#/examples/response/json" }]
20
+ "examples": {
21
+ "layout=short": { "value": [{ "$ref": "../../common/examples/solution.json#/examples/response/json" }] },
22
+ "layout=long": { "value": [{ "$ref": "../../common/examples/solution.json#/examples/response_long/json" }] }
23
+ }
20
24
  },
21
25
  "application/xml": {
22
26
  "schema": {
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: solarwinds-itsm-api-definitions
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.7
4
+ version: 0.2.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Alexander Nagiev
@@ -15,7 +15,7 @@ authors:
15
15
  autorequire:
16
16
  bindir: bin
17
17
  cert_chain: []
18
- date: 2023-08-01 00:00:00.000000000 Z
18
+ date: 2025-11-17 00:00:00.000000000 Z
19
19
  dependencies: []
20
20
  description: SolarWinds ITSM OpenAPI definitions gem
21
21
  email:
@@ -35,13 +35,20 @@ files:
35
35
  - Redocly/redoc/favicon.ico
36
36
  - Redocly/redoc/schema/resolved_schema.json
37
37
  - lib/definitions/common/components.json
38
+ - lib/definitions/common/examples/associations/category.json
39
+ - lib/definitions/common/examples/associations/department.json
40
+ - lib/definitions/common/examples/associations/group_assignee.json
41
+ - lib/definitions/common/examples/associations/site.json
42
+ - lib/definitions/common/examples/associations/sub_category.json
38
43
  - lib/definitions/common/examples/catalog_item.json
39
44
  - lib/definitions/common/examples/change.json
40
45
  - lib/definitions/common/examples/change_catalog.json
41
46
  - lib/definitions/common/examples/change_request.json
42
47
  - lib/definitions/common/examples/configuration_item.json
48
+ - lib/definitions/common/examples/contract.json
43
49
  - lib/definitions/common/examples/hardware.json
44
50
  - lib/definitions/common/examples/incident.json
51
+ - lib/definitions/common/examples/other_asset.json
45
52
  - lib/definitions/common/examples/problem.json
46
53
  - lib/definitions/common/examples/release.json
47
54
  - lib/definitions/common/examples/service_request.json
@@ -166,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
166
173
  - !ruby/object:Gem::Version
167
174
  version: '0'
168
175
  requirements: []
169
- rubygems_version: 3.1.6
176
+ rubygems_version: 3.4.10
170
177
  signing_key:
171
178
  specification_version: 4
172
179
  summary: OpenAPI definitions