solarwinds-itsm-api-definitions 0.1.3 → 0.1.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/Redocly/development.html +126 -0
  3. data/Redocly/index.html +126 -0
  4. data/Redocly/redoc/favicon.ico +0 -0
  5. data/Redocly/redoc/schema/resolved_schema.json +1 -0
  6. data/lib/definitions/common/components.json +270 -58
  7. data/lib/definitions/common/examples/catalog_item.json +70 -0
  8. data/lib/definitions/common/examples/change.json +127 -0
  9. data/lib/definitions/common/examples/change_catalog.json +92 -0
  10. data/lib/definitions/common/examples/configuration_item.json +108 -0
  11. data/lib/definitions/common/examples/hardware.json +125 -0
  12. data/lib/definitions/common/examples/incident.json +134 -109
  13. data/lib/definitions/common/examples/problem.json +126 -102
  14. data/lib/definitions/common/examples/release.json +150 -0
  15. data/lib/definitions/common/examples/service_request.json +28 -0
  16. data/lib/definitions/common/examples/solution.json +49 -0
  17. data/lib/definitions/common/examples/user.json +100 -70
  18. data/lib/definitions/common/schemas/analytics/audit.json +28 -0
  19. data/lib/definitions/common/schemas/analytics/risk.json +28 -0
  20. data/lib/definitions/common/schemas/inventory/hardware.json +104 -0
  21. data/lib/definitions/common/schemas/inventory/mobile.json +73 -0
  22. data/lib/definitions/common/schemas/inventory/other_asset.json +74 -0
  23. data/lib/definitions/common/schemas/inventory/printer.json +41 -0
  24. data/lib/definitions/common/schemas/inventory/software.json +28 -0
  25. data/lib/definitions/common/schemas/inventory/warranty.json +40 -0
  26. data/lib/definitions/common/schemas/procurement/contract.json +67 -0
  27. data/lib/definitions/common/schemas/procurement/item.json +51 -0
  28. data/lib/definitions/common/schemas/procurement/purchase.json +57 -0
  29. data/lib/definitions/common/schemas/procurement/purchase_order.json +85 -0
  30. data/lib/definitions/common/schemas/procurement/vendor.json +67 -0
  31. data/lib/definitions/common/schemas/service_desk/catalog_item.json +71 -0
  32. data/lib/definitions/common/schemas/service_desk/change.json +88 -0
  33. data/lib/definitions/common/schemas/service_desk/change_catalog.json +77 -0
  34. data/lib/definitions/common/schemas/service_desk/comment.json +52 -0
  35. data/lib/definitions/common/schemas/service_desk/configuration_item.json +117 -0
  36. data/lib/definitions/common/schemas/service_desk/incident.json +99 -0
  37. data/lib/definitions/common/schemas/service_desk/problem.json +81 -0
  38. data/lib/definitions/common/schemas/service_desk/release.json +86 -0
  39. data/lib/definitions/common/schemas/service_desk/service_request.json +31 -0
  40. data/lib/definitions/common/schemas/service_desk/solution.json +61 -0
  41. data/lib/definitions/common/schemas/service_desk/time_track.json +37 -0
  42. data/lib/definitions/common/schemas/setup/category.json +54 -0
  43. data/lib/definitions/common/schemas/setup/department.json +48 -0
  44. data/lib/definitions/common/schemas/setup/group.json +65 -0
  45. data/lib/definitions/common/schemas/setup/role.json +51 -0
  46. data/lib/definitions/common/schemas/setup/site.json +64 -0
  47. data/lib/definitions/common/schemas/setup/user.json +67 -0
  48. data/lib/definitions/common/schemas/tasks/task.json +52 -0
  49. data/lib/definitions/openapi.json +100 -8
  50. data/lib/definitions/paths/attachments/attachments.json +12 -0
  51. data/lib/definitions/paths/audits/audits.json +35 -0
  52. data/lib/definitions/paths/audits/audits_by_id.json +37 -0
  53. data/lib/definitions/paths/catalog_items/catalog_item_by_id.json +83 -0
  54. data/lib/definitions/paths/catalog_items/catalog_items.json +69 -0
  55. data/lib/definitions/paths/categories/categories.json +62 -0
  56. data/lib/definitions/paths/categories/category_by_id.json +70 -0
  57. data/lib/definitions/paths/change_catalogs/change_catalog_by_id.json +83 -0
  58. data/lib/definitions/paths/change_catalogs/change_catalogs.json +69 -0
  59. data/lib/definitions/paths/changes/change_by_id.json +83 -0
  60. data/lib/definitions/paths/changes/changes.json +69 -0
  61. data/lib/definitions/paths/comments/comment_by_id.json +65 -0
  62. data/lib/definitions/paths/comments/comments.json +31 -0
  63. data/lib/definitions/paths/configuration_items/append_dependent_assets.json +24 -0
  64. data/lib/definitions/paths/configuration_items/configuration_item_by_id.json +83 -0
  65. data/lib/definitions/paths/configuration_items/configuration_items.json +69 -0
  66. data/lib/definitions/paths/configuration_items/delete_asset_link.json +24 -0
  67. data/lib/definitions/paths/contracts/contract_by_id.json +74 -0
  68. data/lib/definitions/paths/contracts/contracts.json +62 -0
  69. data/lib/definitions/paths/contracts/item_by_id.json +75 -0
  70. data/lib/definitions/paths/contracts/items.json +30 -0
  71. data/lib/definitions/paths/departments/department_by_id.json +70 -0
  72. data/lib/definitions/paths/departments/departments.json +62 -0
  73. data/lib/definitions/paths/groups/group_by_id.json +70 -0
  74. data/lib/definitions/paths/groups/groups.json +62 -0
  75. data/lib/definitions/paths/hardwares/hardware_by_id.json +83 -0
  76. data/lib/definitions/paths/hardwares/hardwares.json +69 -0
  77. data/lib/definitions/paths/hardwares/warranties.json +64 -0
  78. data/lib/definitions/paths/hardwares/warranty_by_id.json +75 -0
  79. data/lib/definitions/paths/incidents/incident_by_id.json +7 -7
  80. data/lib/definitions/paths/incidents/incidents.json +10 -10
  81. data/lib/definitions/paths/memberships/membership_by_id.json +20 -0
  82. data/lib/definitions/paths/memberships/memberships.json +29 -0
  83. data/lib/definitions/paths/mobiles/mobile_by_id.json +74 -0
  84. data/lib/definitions/paths/mobiles/mobiles.json +62 -0
  85. data/lib/definitions/paths/other_assets/other_asset_by_id.json +74 -0
  86. data/lib/definitions/paths/other_assets/other_assets.json +62 -0
  87. data/lib/definitions/paths/printers/printer_by_id.json +53 -0
  88. data/lib/definitions/paths/printers/printers.json +36 -0
  89. data/lib/definitions/paths/problems/problem_by_id.json +7 -8
  90. data/lib/definitions/paths/problems/problems.json +10 -10
  91. data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +74 -0
  92. data/lib/definitions/paths/purchase_orders/purchase_orders.json +62 -0
  93. data/lib/definitions/paths/purchases/purchase_by_id.json +65 -0
  94. data/lib/definitions/paths/purchases/purchases.json +31 -0
  95. data/lib/definitions/paths/releases/release_by_id.json +83 -0
  96. data/lib/definitions/paths/releases/releases.json +69 -0
  97. data/lib/definitions/paths/risks/risks.json +34 -0
  98. data/lib/definitions/paths/roles/role_by_id.json +70 -0
  99. data/lib/definitions/paths/roles/roles.json +62 -0
  100. data/lib/definitions/paths/service_requests/request_by_id.json +37 -0
  101. data/lib/definitions/paths/sites/site_by_id.json +74 -0
  102. data/lib/definitions/paths/sites/sites.json +62 -0
  103. data/lib/definitions/paths/softwares/software_by_id.json +24 -0
  104. data/lib/definitions/paths/softwares/softwares.json +36 -0
  105. data/lib/definitions/paths/solutions/solution_by_id.json +83 -0
  106. data/lib/definitions/paths/solutions/solutions.json +69 -0
  107. data/lib/definitions/paths/tasks/task_by_id.json +65 -0
  108. data/lib/definitions/paths/tasks/tasks.json +31 -0
  109. data/lib/definitions/paths/time_tracks/time_track_by_id.json +65 -0
  110. data/lib/definitions/paths/time_tracks/time_tracks.json +66 -0
  111. data/lib/definitions/paths/users/user_by_id.json +8 -9
  112. data/lib/definitions/paths/users/users.json +11 -11
  113. data/lib/definitions/paths/vendors/vendor_by_id.json +74 -0
  114. data/lib/definitions/paths/vendors/vendors.json +62 -0
  115. data/lib/solarwinds/itsm/api/definitions.rb +52 -3
  116. metadata +104 -6
  117. data/lib/definitions/common/schemas/incident.json +0 -70
  118. data/lib/definitions/common/schemas/problem.json +0 -67
  119. data/lib/definitions/common/schemas/user.json +0 -54
  120. data/lib/resolved_schema/resolved_schema.json +0 -1
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
+ }
data/lib/definitions/common/schemas/inventory/printer.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "type": "object",
6
+ "xml": { "name": "/" },
7
+ "properties": {
8
+ "printer": {
9
+ "type": "object",
10
+ "properties": {
11
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
12
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
13
+ "technical_contact": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
14
+ "address": { "type": "string", "example": "address description", "description": "Building/Floor/Room" }
15
+ }
16
+ }
17
+ }
18
+ },
19
+ "response": {
20
+ "type": "object",
21
+ "xml": { "name": "/", "wrapped": true },
22
+ "properties": {
23
+ "printer": {
24
+ "type": "object",
25
+ "properties": {
26
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
27
+ "name": { "type": "string", "example": "HP Color Printer" },
28
+ "driver": { "type": "string", "example": "Driver description" },
29
+ "port": { "type": "string", "example": "Port description" },
30
+ "shared": { "type": "boolean", "example": true },
31
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
32
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
33
+ "technical_contact": { "$ref": "../../components.json#/components/response/schemas/group_details" }
34
+ }
35
+ }
36
+ }
37
+ }
38
+ }
39
+ }
40
+ }
41
+
data/lib/definitions/common/schemas/inventory/software.json ADDED
@@ -0,0 +1,28 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "response": {
5
+ "type": "object",
6
+ "xml": { "name": "/", "wrapped": true },
7
+ "properties": {
8
+ "software": {
9
+ "type": "object",
10
+ "properties": {
11
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
12
+ "name": { "type": "string", "example": "Google Chrome" },
13
+ "tag": { "type": "string", "example": "software tag" },
14
+ "manufacturer": { "type": "string", "example": "Google LLC" },
15
+ "version": { "type": "string", "example": "0.0.0" },
16
+ "category": { "type": "string", "example": "Google softwares" },
17
+ "vendor": { "$ref": "../../components.json#/components/response/schemas/vendor" },
18
+ "installs": { "type": "integer", "example": 1 },
19
+ "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" },
20
+ "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }
21
+ }
22
+ }
23
+ }
24
+ }
25
+ }
26
+ }
27
+ }
28
+
data/lib/definitions/common/schemas/inventory/warranty.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "type": "object",
6
+ "xml": { "name": "/" },
7
+ "properties": {
8
+ "warranty": {
9
+ "type": "object",
10
+ "properties": {
11
+ "service": { "type": "string", "example": "Warranty service description" },
12
+ "provider": { "type": "string", "example": "SolarWinds" },
13
+ "start_date": { "type": "string", "example": "Jan 01, 2020" },
14
+ "end_date": { "type": "string", "example": "Jan 01, 2030" },
15
+ "status": { "type": "string", "example": "Active" }
16
+ }
17
+ }
18
+ }
19
+ },
20
+ "response": {
21
+ "type": "object",
22
+ "xml": { "name": "/", "wrapped": true },
23
+ "properties": {
24
+ "warranty": {
25
+ "type": "object",
26
+ "properties": {
27
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
28
+ "service": { "type": "string", "example": "Warranty service description" },
29
+ "provider": { "type": "string", "example": "SolarWinds" },
30
+ "start_date": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" },
31
+ "end_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" },
32
+ "status": { "type": "string", "example": "Active" },
33
+ "manual": { "type": "boolean", "example": false }
34
+ }
35
+ }
36
+ }
37
+ }
38
+ }
39
+ }
40
+ }
data/lib/definitions/common/schemas/procurement/contract.json ADDED
@@ -0,0 +1,67 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "contract": {
10
+ "type": "object",
11
+ "required": ["name", "manufacturer_name"],
12
+ "properties": { "$ref": "contract.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "contract": {
21
+ "type": "object",
22
+ "properties": { "$ref": "contract.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "type": { "type": "string", "example": "Software License" },
29
+ "manufacturer_name": { "type": "string", "example": "Apple" },
30
+ "name": { "type": "string", "example": "Contract Name" },
31
+ "note": { "type": "string", "example": "Contract Note" },
32
+ "status": { "type": "string", "example": "Active" },
33
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
34
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
35
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
36
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
37
+ "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" },
38
+ "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" },
39
+ "tag_list": { "type": "string", "example": "tag1, tag2" }
40
+ },
41
+ "response": {
42
+ "type": "object",
43
+ "xml": { "name": "/", "wrapped": true },
44
+ "properties": {
45
+ "contract": {
46
+ "type": "object",
47
+ "properties": {
48
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
49
+ "name": { "type": "string", "example": "Contract Name" },
50
+ "type": { "type": "string", "example": "Software License" },
51
+ "manufacturer_name": { "type": "string", "example": "Apple" },
52
+ "note": { "type": "string", "example": "Contract Note" },
53
+ "status": { "type": "string", "example": "Active" },
54
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
55
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
56
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
57
+ "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" },
58
+ "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" },
59
+ "tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
60
+ "items": { "$ref": "../../components.json#/components/response/schemas/procurement_items" }
61
+ }
62
+ }
63
+ }
64
+ }
65
+ }
66
+ }
67
+ }
data/lib/definitions/common/schemas/procurement/item.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "item": {
10
+ "type": "object",
11
+ "required": ["name"],
12
+ "properties": { "$ref": "item.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "item": {
21
+ "type": "object",
22
+ "properties": { "$ref": "item.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Item Name" },
29
+ "version": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
30
+ "qty": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
31
+ "tag": { "type": "string", "example": "Item tag" }
32
+ },
33
+ "response": {
34
+ "type": "object",
35
+ "xml": { "name": "/", "wrapped": true },
36
+ "properties": {
37
+ "item": {
38
+ "type": "object",
39
+ "properties": {
40
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
41
+ "name": { "type": "string", "example": "Item Name" },
42
+ "version": { "type": "string", "example": "1" },
43
+ "qty": { "type": "string", "example": "1" },
44
+ "tag": { "type": "string", "example": "Item tag" }
45
+ }
46
+ }
47
+ }
48
+ }
49
+ }
50
+ }
51
+ }