solarwinds-itsm-api-definitions 0.1.1 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (114) hide show
  1. checksums.yaml +4 -4
  2. data/lib/definitions/common/components.json +298 -49
  3. data/lib/definitions/common/examples/catalog_item.json +70 -0
  4. data/lib/definitions/common/examples/change.json +127 -0
  5. data/lib/definitions/common/examples/change_catalog.json +92 -0
  6. data/lib/definitions/common/examples/configuration_item.json +108 -0
  7. data/lib/definitions/common/examples/hardware.json +125 -0
  8. data/lib/definitions/common/examples/incident.json +134 -109
  9. data/lib/definitions/common/examples/problem.json +132 -0
  10. data/lib/definitions/common/examples/release.json +150 -0
  11. data/lib/definitions/common/examples/service_request.json +28 -0
  12. data/lib/definitions/common/examples/solution.json +49 -0
  13. data/lib/definitions/common/examples/user.json +106 -0
  14. data/lib/definitions/common/schemas/analytics/audit.json +28 -0
  15. data/lib/definitions/common/schemas/analytics/risk.json +28 -0
  16. data/lib/definitions/common/schemas/inventory/hardware.json +104 -0
  17. data/lib/definitions/common/schemas/inventory/mobile.json +73 -0
  18. data/lib/definitions/common/schemas/inventory/other_asset.json +74 -0
  19. data/lib/definitions/common/schemas/inventory/printer.json +41 -0
  20. data/lib/definitions/common/schemas/inventory/software.json +28 -0
  21. data/lib/definitions/common/schemas/inventory/warranty.json +40 -0
  22. data/lib/definitions/common/schemas/procurement/contract.json +67 -0
  23. data/lib/definitions/common/schemas/procurement/item.json +51 -0
  24. data/lib/definitions/common/schemas/procurement/purchase.json +57 -0
  25. data/lib/definitions/common/schemas/procurement/purchase_order.json +85 -0
  26. data/lib/definitions/common/schemas/procurement/vendor.json +67 -0
  27. data/lib/definitions/common/schemas/service_desk/catalog_item.json +71 -0
  28. data/lib/definitions/common/schemas/service_desk/change.json +88 -0
  29. data/lib/definitions/common/schemas/service_desk/change_catalog.json +77 -0
  30. data/lib/definitions/common/schemas/service_desk/comment.json +52 -0
  31. data/lib/definitions/common/schemas/service_desk/configuration_item.json +117 -0
  32. data/lib/definitions/common/schemas/service_desk/incident.json +99 -0
  33. data/lib/definitions/common/schemas/service_desk/problem.json +81 -0
  34. data/lib/definitions/common/schemas/service_desk/release.json +86 -0
  35. data/lib/definitions/common/schemas/service_desk/service_request.json +31 -0
  36. data/lib/definitions/common/schemas/service_desk/solution.json +61 -0
  37. data/lib/definitions/common/schemas/service_desk/time_track.json +37 -0
  38. data/lib/definitions/common/schemas/setup/category.json +54 -0
  39. data/lib/definitions/common/schemas/setup/department.json +48 -0
  40. data/lib/definitions/common/schemas/setup/group.json +65 -0
  41. data/lib/definitions/common/schemas/setup/role.json +51 -0
  42. data/lib/definitions/common/schemas/setup/site.json +64 -0
  43. data/lib/definitions/common/schemas/setup/user.json +67 -0
  44. data/lib/definitions/common/schemas/tasks/task.json +52 -0
  45. data/lib/definitions/openapi.json +105 -10
  46. data/lib/definitions/paths/attachments/attachments.json +12 -0
  47. data/lib/definitions/paths/audits/audits.json +35 -0
  48. data/lib/definitions/paths/audits/audits_by_id.json +37 -0
  49. data/lib/definitions/paths/catalog_items/catalog_item_by_id.json +83 -0
  50. data/lib/definitions/paths/catalog_items/catalog_items.json +69 -0
  51. data/lib/definitions/paths/categories/categories.json +62 -0
  52. data/lib/definitions/paths/categories/category_by_id.json +70 -0
  53. data/lib/definitions/paths/change_catalogs/change_catalog_by_id.json +83 -0
  54. data/lib/definitions/paths/change_catalogs/change_catalogs.json +69 -0
  55. data/lib/definitions/paths/changes/change_by_id.json +83 -0
  56. data/lib/definitions/paths/changes/changes.json +69 -0
  57. data/lib/definitions/paths/comments/comment_by_id.json +65 -0
  58. data/lib/definitions/paths/comments/comments.json +31 -0
  59. data/lib/definitions/paths/configuration_items/append_dependent_assets.json +24 -0
  60. data/lib/definitions/paths/configuration_items/configuration_item_by_id.json +83 -0
  61. data/lib/definitions/paths/configuration_items/configuration_items.json +69 -0
  62. data/lib/definitions/paths/configuration_items/delete_asset_link.json +24 -0
  63. data/lib/definitions/paths/contracts/contract_by_id.json +74 -0
  64. data/lib/definitions/paths/contracts/contracts.json +62 -0
  65. data/lib/definitions/paths/contracts/item_by_id.json +75 -0
  66. data/lib/definitions/paths/contracts/items.json +30 -0
  67. data/lib/definitions/paths/departments/department_by_id.json +70 -0
  68. data/lib/definitions/paths/departments/departments.json +62 -0
  69. data/lib/definitions/paths/groups/group_by_id.json +70 -0
  70. data/lib/definitions/paths/groups/groups.json +62 -0
  71. data/lib/definitions/paths/hardwares/hardware_by_id.json +83 -0
  72. data/lib/definitions/paths/hardwares/hardwares.json +69 -0
  73. data/lib/definitions/paths/hardwares/warranties.json +64 -0
  74. data/lib/definitions/paths/hardwares/warranty_by_id.json +75 -0
  75. data/lib/definitions/paths/incidents/incident_by_id.json +7 -7
  76. data/lib/definitions/paths/incidents/incidents.json +11 -11
  77. data/lib/definitions/paths/memberships/membership_by_id.json +20 -0
  78. data/lib/definitions/paths/memberships/memberships.json +29 -0
  79. data/lib/definitions/paths/mobiles/mobile_by_id.json +74 -0
  80. data/lib/definitions/paths/mobiles/mobiles.json +62 -0
  81. data/lib/definitions/paths/other_assets/other_asset_by_id.json +74 -0
  82. data/lib/definitions/paths/other_assets/other_assets.json +62 -0
  83. data/lib/definitions/paths/printers/printer_by_id.json +53 -0
  84. data/lib/definitions/paths/printers/printers.json +36 -0
  85. data/lib/definitions/paths/problems/problem_by_id.json +83 -0
  86. data/lib/definitions/paths/problems/problems.json +69 -0
  87. data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +74 -0
  88. data/lib/definitions/paths/purchase_orders/purchase_orders.json +62 -0
  89. data/lib/definitions/paths/purchases/purchase_by_id.json +65 -0
  90. data/lib/definitions/paths/purchases/purchases.json +31 -0
  91. data/lib/definitions/paths/releases/release_by_id.json +83 -0
  92. data/lib/definitions/paths/releases/releases.json +69 -0
  93. data/lib/definitions/paths/risks/risks.json +34 -0
  94. data/lib/definitions/paths/roles/role_by_id.json +70 -0
  95. data/lib/definitions/paths/roles/roles.json +62 -0
  96. data/lib/definitions/paths/service_requests/request_by_id.json +37 -0
  97. data/lib/definitions/paths/sites/site_by_id.json +74 -0
  98. data/lib/definitions/paths/sites/sites.json +62 -0
  99. data/lib/definitions/paths/softwares/software_by_id.json +24 -0
  100. data/lib/definitions/paths/softwares/softwares.json +36 -0
  101. data/lib/definitions/paths/solutions/solution_by_id.json +83 -0
  102. data/lib/definitions/paths/solutions/solutions.json +69 -0
  103. data/lib/definitions/paths/tasks/task_by_id.json +65 -0
  104. data/lib/definitions/paths/tasks/tasks.json +31 -0
  105. data/lib/definitions/paths/time_tracks/time_track_by_id.json +65 -0
  106. data/lib/definitions/paths/time_tracks/time_tracks.json +66 -0
  107. data/lib/definitions/paths/users/user_by_id.json +83 -0
  108. data/lib/definitions/paths/users/users.json +69 -0
  109. data/lib/definitions/paths/vendors/vendor_by_id.json +74 -0
  110. data/lib/definitions/paths/vendors/vendors.json +62 -0
  111. data/lib/solarwinds/itsm/api/definitions.rb +52 -3
  112. metadata +106 -4
  113. data/lib/definitions/common/schemas/incident.json +0 -78
  114. data/lib/resolved_schema/resolved_schema.json +0 -1
data/lib/definitions/common/examples/service_request.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "examples": {
3
+ "incident": {
4
+ "site_id": "1",
5
+ "department_id": "1",
6
+ "requester_name": "john.doe@email.com",
7
+ "priority": "High",
8
+ "due_at": "Jan 01,2025",
9
+ "add_to_tag_list": "tag1, tag2",
10
+ "remove_from_tag_list": "tag3",
11
+ "tag_list": "tag1, tag2",
12
+ "request_variables_attributes": [
13
+ {
14
+ "name": "Variable name",
15
+ "value": "Content"
16
+ },
17
+ {
18
+ "name": "User Variable",
19
+ "user_value": { "email": "john.doe@email.com" }
20
+ },
21
+ {
22
+ "name": "MultyPickList variable",
23
+ "value": "option1#dlmtr#option2"
24
+ }
25
+ ]
26
+ }
27
+ }
28
+ }
data/lib/definitions/common/examples/solution.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "examples": {
3
+ "request": {
4
+ "json": {
5
+ "solution": {
6
+ "name": "Solution Name",
7
+ "site_id": 1,
8
+ "department_id": 1,
9
+ "description": "description",
10
+ "state": "Approved",
11
+ "category": { "name": "Facilities" },
12
+ "subcategory": { "name": "Equipment" },
13
+ "add_to_tag_list": "tag1, tag2",
14
+ "remove_from_tag_list": "tag3",
15
+ "tag_list": "tag1, tag2",
16
+ "custom_fields_values_attributes": [
17
+ { "id": 10, "custom_field_id": 1, "value": "content" },
18
+ { "id": 100, "custom_field_id": 2, "value": "1" }
19
+ ],
20
+ "custom_fields_values": {
21
+ "custom_fields_value": [
22
+ { "name": "Text custom field", "value": "content" },
23
+ { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
24
+ ]
25
+ },
26
+ "incident_ids": [100]
27
+ }
28
+ }
29
+ },
30
+ "response": {
31
+ "json": {
32
+ "solution": {
33
+ "id": "10000",
34
+ "number": "1000",
35
+ "name": "Solution Name",
36
+ "description": "description",
37
+ "created_at": "2025-01-01T00:00:00.000+01:00",
38
+ "creator": {
39
+ "id": "1",
40
+ "name": "John Doe",
41
+ "email": "john.doe@email.com"
42
+ },
43
+ "origin": "api",
44
+ "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}]
45
+ }
46
+ }
47
+ }
48
+ }
49
+ }
data/lib/definitions/common/examples/user.json ADDED
@@ -0,0 +1,106 @@
1
+ {
2
+ "examples": {
3
+ "request": {
4
+ "json": {
5
+ "user": {
6
+ "name": "John Doe",
7
+ "email": "john.doe@email.com",
8
+ "title": "Support Agent",
9
+ "site": { "name": "AUS" },
10
+ "department": { "name": "Support" },
11
+ "role": { "name": "Requester" },
12
+ "phone": "+10000000",
13
+ "mobile_phone": "+10000000",
14
+ "reports_to": { "email": "jane.doe@email.com" },
15
+ "custom_fields_values_attributes": [
16
+ { "id": 10, "custom_field_id": 1, "value": "content" },
17
+ { "id": 100, "custom_field_id": 2, "value": "1" }
18
+ ],
19
+ "custom_fields_values": {
20
+ "custom_fields_value": [
21
+ { "name": "Text custom field", "value": "content" },
22
+ { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
23
+ ]
24
+ }
25
+ }
26
+ }
27
+ },
28
+ "response": {
29
+ "json": {
30
+ "user": {
31
+ "id": "10000",
32
+ "name": "John Doe",
33
+ "title": "Support Agent",
34
+ "disabled": false,
35
+ "email": "john.doe@email.com",
36
+ "created_at": "2030-01-01T00:00:00.000+00:00",
37
+ "phone": "+10000000",
38
+ "mobile_phone": "+10000000",
39
+ "site": {
40
+ "id": "1",
41
+ "name": "Austin TX, USA",
42
+ "location": "AUS",
43
+ "description": "",
44
+ "time_zone": ""
45
+ },
46
+ "department": {
47
+ "id": "1",
48
+ "name": "Support",
49
+ "description": "",
50
+ "default_assignee_id": "1"
51
+ },
52
+ "role": {
53
+ "id": 1,
54
+ "name": "Requester",
55
+ "description": "Requester role.",
56
+ "portal": true,
57
+ "show_my_tasks": true
58
+ },
59
+ "group_ids": [1],
60
+ "avatar": {
61
+ "type": "initials",
62
+ "color": "#fd4165",
63
+ "initials": "JD"
64
+ },
65
+ "reports_to": {
66
+ "group_id": "1",
67
+ "is_user": "true",
68
+ "id": "100",
69
+ "name": "Jane Doe",
70
+ "email": "jane.doe@email.com",
71
+ "avatar": {
72
+ "type": "initials",
73
+ "color": "#fd4166",
74
+ "initials": "JD"
75
+ }
76
+ },
77
+ "custom_fields_values": [
78
+ {
79
+ "id": "10",
80
+ "custom_field_id": "1",
81
+ "name": "Text custom field",
82
+ "value": "content",
83
+ "options": "",
84
+ "type_name": "Text"
85
+ },
86
+ {
87
+ "id": "100",
88
+ "custom_field_id": "2",
89
+ "name": "User custom field",
90
+ "value": "1",
91
+ "options": "",
92
+ "type_name": "User",
93
+ "user": {
94
+ "group_id": 1,
95
+ "is_user": true,
96
+ "id": 1,
97
+ "name": "John Doe",
98
+ "email": "john.doe@email.com"
99
+ }
100
+ }
101
+ ]
102
+ }
103
+ }
104
+ }
105
+ }
106
+ }
data/lib/definitions/common/schemas/analytics/audit.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "response": {
5
+ "type": "object",
6
+ "xml": { "name": "/", "wrapped": true },
7
+ "properties": {
8
+ "audit": {
9
+ "type": "object",
10
+ "properties": {
11
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
12
+ "message": { "type": "string", "example": "State changed from New to On Hold" },
13
+ "action": { "type": "string", "example": "Update" },
14
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
15
+ "source_type": { "type": "string", "example": "Incident" },
16
+ "source_id": { "$ref": "../../components.json#/components/response/schemas/id" },
17
+ "user_id": { "$ref": "../../components.json#/components/response/schemas/id" },
18
+ "user": { "$ref": "../../components.json#/components/response/schemas/user_details" },
19
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
20
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
21
+ "note": { "type": "string", "example": "Audit note" }
22
+ }
23
+ }
24
+ }
25
+ }
26
+ }
27
+ }
28
+ }
data/lib/definitions/common/schemas/analytics/risk.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "response": {
5
+ "type": "object",
6
+ "xml": { "name": "/", "wrapped": true },
7
+ "properties": {
8
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
9
+ "name": { "type": "string", "example": "Risk name" },
10
+ "severity": { "type": "string", "example": "Medium" },
11
+ "category": { "type": "string", "example": "Inventory" },
12
+ "discarded": { "type": "boolean", "example": false },
13
+ "resolved": { "type": "boolean", "example": false },
14
+ "affected_assets": {
15
+ "type": "object",
16
+ "properties": {
17
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
18
+ "name": { "type": "string", "example": "Computer name" },
19
+ "type": { "type": "string", "example": "Hardware" }
20
+ }
21
+ },
22
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
23
+ "updated at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }
24
+ }
25
+ }
26
+ }
27
+ }
28
+ }
data/lib/definitions/common/schemas/inventory/hardware.json ADDED
@@ -0,0 +1,104 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "hardware": {
10
+ "type": "object",
11
+ "required": ["name"],
12
+ "properties": { "$ref": "hardware.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "hardware": {
21
+ "type": "object",
22
+ "properties": { "$ref": "hardware.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Hardware Name" },
29
+ "description": { "type": "string", "example": "description" },
30
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
31
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
32
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
33
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
35
+ "ip_address": { "type": "string", "example": "0.0.0.0" },
36
+ "external_ip": { "type": "string", "example": "0.0.0.0" },
37
+ "status": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
38
+ "technical_contact": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
39
+ "owner": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
40
+ "notes": { "type": "string", "example": "Hardware notes" },
41
+ "barcode_encoding_format": { "type": "string", "example": "Code1A" },
42
+ "cpu": { "type": "string", "example": "hardware_cpu" },
43
+ "memory": { "anyOf": [{ "type": "string", "example": "1024" },{ "type": "integer", "example": 1024 }] },
44
+ "swap": { "type": "string", "example": "MB" },
45
+ "domain": { "type": "string", "example": "domain description" },
46
+ "operating_system": { "type": "string", "example": "Windows 10" },
47
+ "active_directory": { "type": "string", "example": "Workgroup of the OS" },
48
+ "address": { "type": "string", "example": "Site 1, Building 1, Department 1" },
49
+ "longitude": { "type": "string", "example": "0.000" },
50
+ "latitude": { "type": "string", "example": "0.000" },
51
+ "product_number": { "anyOf": [{ "type": "string", "example": "1" },{ "type": "integer", "example": 1 }] },
52
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
53
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
54
+ "bio": { "$ref": "../../components.json#/components/request/schemas/bio" },
55
+ "tag": { "type": "string", "example": "hardware tag" },
56
+ "asset_tag": { "anyOf": [{ "type": "string", "example": "1" },{ "type": "integer", "example": 1 }] }
57
+ },
58
+ "response": {
59
+ "type": "object",
60
+ "xml": { "name": "/", "wrapped": true },
61
+ "properties": {
62
+ "hardware": {
63
+ "type": "object",
64
+ "properties": {
65
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
66
+ "name": { "type": "string", "example": "Hardware Name" },
67
+ "ip": { "type": "string", "example": "0.0.0.0" },
68
+ "description": { "type": "string", "example": "description" },
69
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
70
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
71
+ "status": { "type": "string", "example": "Operational" },
72
+ "category": {
73
+ "type": "object",
74
+ "properties": {
75
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
76
+ "name": { "type": "string", "example": "Laptop" }
77
+ }
78
+ },
79
+ "owner": { "$ref": "../../components.json#/components/response/schemas/group_details" },
80
+ "technical_contact": { "$ref": "../../components.json#/components/response/schemas/group_details" },
81
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
82
+ "notes": { "type": "string", "example": "Hardware notes" },
83
+ "barcode_encoding_format": { "type": "string", "example": "Code1A" },
84
+ "cpu": { "type": "string", "example": "hardware_cpu" },
85
+ "processor_speed": { "type": "string", "example": "processor_speed" },
86
+ "memory": { "type": "string", "example": "1024" },
87
+ "swap": { "type": "string", "example": "MB" },
88
+ "domain": { "type": "string", "example": "domain description" },
89
+ "operating_system": { "type": "string", "example": "Windows 10" },
90
+ "active_directory": { "type": "string", "example": "Workgroup of the OS" },
91
+ "address": { "type": "string", "example": "Site 1, Building 1, Department 1" },
92
+ "longitude": { "type": "string", "example": "0.000" },
93
+ "latitude": { "type": "string", "example": "0.000" },
94
+ "product_number": { "type": "integer", "example": 1 },
95
+ "bio": { "$ref": "../../components.json#/components/response/schemas/bioses" },
96
+ "tag": { "type": "string", "example": "hardware tag" },
97
+ "asset_tag": { "type": "string", "example": "1" }
98
+ }
99
+ }
100
+ }
101
+ }
102
+ }
103
+ }
104
+ }
data/lib/definitions/common/schemas/inventory/mobile.json ADDED
@@ -0,0 +1,73 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "mobile": {
10
+ "type": "object",
11
+ "required": ["model", "manufacturer", "serial_number"],
12
+ "properties": { "$ref": "mobile.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "mobile": {
21
+ "type": "object",
22
+ "properties": { "$ref": "mobile.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "description": { "type": "string", "example": "description" },
29
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
30
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
31
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
32
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
33
+ "status": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
34
+ "device_type": { "type": "string", "example": "Mobile Device" },
35
+ "manufacturer": { "type": "string", "example": "Apple" },
36
+ "model": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
37
+ "company_issued": { "type": "boolean", "example": true },
38
+ "serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
39
+ "imei": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
40
+ "user": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
41
+ "technical_contact": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
42
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
43
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
44
+ },
45
+ "response": {
46
+ "type": "object",
47
+ "xml": { "name": "/", "wrapped": true },
48
+ "properties": {
49
+ "mobile": {
50
+ "type": "object",
51
+ "properties": {
52
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
53
+ "name": { "type": "string", "example": "Apple 1" },
54
+ "description": { "type": "string", "example": "description" },
55
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
56
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
57
+ "status": { "type": "string", "example": "Operational" },
58
+ "device_type": { "type": "string", "example": "Mobile Device" },
59
+ "manufacturer": { "type": "string", "example": "Apple" },
60
+ "model": { "type": "string", "example": "1" },
61
+ "company_issued": { "type": "boolean", "example": true },
62
+ "serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
63
+ "imei": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
64
+ "user": { "$ref": "../../components.json#/components/response/schemas/user_details" },
65
+ "technical_contact": { "$ref": "../../components.json#/components/response/schemas/group_details" },
66
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" }
67
+ }
68
+ }
69
+ }
70
+ }
71
+ }
72
+ }
73
+ }
data/lib/definitions/common/schemas/inventory/other_asset.json ADDED
@@ -0,0 +1,74 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "other_asset": {
10
+ "type": "object",
11
+ "required": ["name", "manufacturer", "asset_type"],
12
+ "properties": { "$ref": "other_asset.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "other_asset": {
21
+ "type": "object",
22
+ "properties": { "$ref": "other_asset.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Asset Name" },
29
+ "description": { "type": "string", "example": "description" },
30
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
31
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
32
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
33
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "asset_id": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
35
+ "asset_type": { "$ref": "../../components.json#/components/request/schemas/association_by_name", "example": { "name": "Printer" } },
36
+ "status": { "$ref": "../../components.json#/components/request/schemas/association_by_name", "example": { "name": "Operational" } },
37
+ "manufacturer": { "type": "string", "example": "Apple" },
38
+ "ip_address": { "type": "string", "example": "0.0.0.0" },
39
+ "model": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
40
+ "serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
41
+ "user": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
42
+ "owner": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
43
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
44
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
45
+ },
46
+ "response": {
47
+ "type": "object",
48
+ "xml": { "name": "/", "wrapped": true },
49
+ "properties": {
50
+ "other_asset": {
51
+ "type": "object",
52
+ "properties": {
53
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
54
+ "name": { "type": "string", "example": "Apple 1" },
55
+ "description": { "type": "string", "example": "description" },
56
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
57
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
58
+ "status": { "type": "string", "example": "Operational" },
59
+ "asset_type": { "$ref": "../../components.json#/components/response/schemas/asset_type" },
60
+ "asset_id": { "type": "string", "example": "1" },
61
+ "manufacturer": { "type": "string", "example": "Apple" },
62
+ "model": { "type": "string", "example": "1" },
63
+ "ip": { "type": "string", "example": "0.0.0.0" },
64
+ "serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
65
+ "user": { "$ref": "../../components.json#/components/response/schemas/group_details" },
66
+ "owner": { "$ref": "../../components.json#/components/response/schemas/group_details" },
67
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" }
68
+ }
69
+ }
70
+ }
71
+ }
72
+ }
73
+ }
74
+ }