solarwinds-itsm-api-definitions 0.1.4 → 0.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/lib/definitions/common/components.json +11 -4
  3. data/lib/definitions/common/examples/change.json +6 -2
  4. data/lib/definitions/common/examples/change_catalog.json +41 -21
  5. data/lib/definitions/common/examples/hardware.json +33 -8
  6. data/lib/definitions/common/examples/incident.json +5 -1
  7. data/lib/definitions/common/examples/problem.json +126 -104
  8. data/lib/definitions/common/examples/release.json +26 -4
  9. data/lib/definitions/common/examples/solution.json +6 -1
  10. data/lib/definitions/common/examples/user.json +100 -70
  11. data/lib/definitions/openapi.json +9 -5
  12. data/lib/resolved_schema/resolved_schema.json +1 -1
  13. data/lib/solarwinds/itsm/api/definitions.rb +49 -0
  14. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 700321baa2a625ed3363bf49e1c3b0768acb7005fdae052fd026c22c12d86fd5
4
- data.tar.gz: 32a50496f7ee3522926e8fdbe37fb9633dfa42cacb376d19dc6cf1e529437434
3
+ metadata.gz: eeb6476d02c2ca9f56b3cfd46fdefe946aa122d6259f66a7f7db7b83a8bb5d83
4
+ data.tar.gz: 9eeb50009c0c36155c3f2a8eed44f545e1093f3ec2f261a79fbcc785d43f77eb
5
5
  SHA512:
6
- metadata.gz: 0ae6cd0e1366aa2deccfa53e7ae087854593ba98aff32dbe6b640fb95c092376f7edb567a03811a4b70a6db5faa929e9d1e686504f73cbe1ed2dbe8dba8d703e
7
- data.tar.gz: 05ebb504e6cb025dc9f80a2f72a9e31528130c49b3a992a09e33596aebb8f65c8a15a266a9a1643828f6718c1010407b3f77538194b98dcd3b1cdf00f8299814
6
+ metadata.gz: cc29f99f9dd7fb383441c924c7843ec3c162e9fb6830b1a2c59821a2fbe533a1f3e3e70f065c38b0378079032c8995c4036b444e4ff58a7fa5e3176e7a644c05
7
+ data.tar.gz: 4a6cfd897c9ad29c8ee3128e3fb4b493d73280a5113c3ade72238b3b98a76b26a07f1c90e6d68cb9dfe9968aec261b5adc2f5d4d1d57aaa251bedcb90a3ab530
data/lib/definitions/common/components.json CHANGED
@@ -67,12 +67,18 @@
67
67
  "type": "array",
68
68
  "items": { "$ref": "components.json#/components/request/schemas/number_property" }
69
69
  },
70
+ "value_of_custom_field": {
71
+ "anyOf":[
72
+ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" },
73
+ { "content": { "application/octet-stream": {} }, "description": "attachment custom field" }
74
+ ]
75
+ },
70
76
  "custom_field": {
71
77
  "type": "object",
72
78
  "required": ["name"],
73
79
  "properties": {
74
80
  "name": { "type": "string", "example": "Name of custom text field" },
75
- "value": { "type": "string", "example": "content" },
81
+ "value": { "$ref": "components.json#/components/request/schemas/value_of_custom_field" },
76
82
  "user_value": { "$ref": "components.json#/components/request/schemas/association_by_email" }
77
83
  }
78
84
  },
@@ -90,9 +96,10 @@
90
96
  "custom_field_by_id": {
91
97
  "type": "object",
92
98
  "properties": {
93
- "id": { "type": "string", "example": "1" },
94
- "custom_field_id": { "type": "integer", "example": 1 },
95
- "value": { "type": "string", "example": "content" } }
99
+ "id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
100
+ "custom_field_id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
101
+ "value": { "$ref": "components.json#/components/request/schemas/value_of_custom_field" }
102
+ }
96
103
  },
97
104
  "custom_fields_values_attributes": {
98
105
  "anyOf": [
data/lib/definitions/common/examples/change.json CHANGED
@@ -20,6 +20,10 @@
20
20
  "add_to_tag_list": "tag1, tag2",
21
21
  "remove_from_tag_list": "tag3",
22
22
  "tag_list": "tag1, tag2",
23
+ "custom_fields_values_attributes": [
24
+ { "id": 10, "custom_field_id": 1, "value": "content" },
25
+ { "id": 100, "custom_field_id": 2, "value": "1" }
26
+ ],
23
27
  "custom_fields_values": {
24
28
  "custom_fields_value": [
25
29
  { "name": "Text custom field", "value": "content" },
@@ -55,7 +59,7 @@
55
59
  "default_assignee_id": "1"
56
60
  },
57
61
  "priority": "High",
58
- "assignee": {
62
+ "assignee": {
59
63
  "group_id": "1",
60
64
  "is_user": "true",
61
65
  "id": "1",
@@ -91,7 +95,7 @@
91
95
  },
92
96
  {
93
97
  "id": "100",
94
- "custom_field_id": "1",
98
+ "custom_field_id": "2",
95
99
  "name": "User custom field",
96
100
  "value": "1",
97
101
  "options": "",
data/lib/definitions/common/examples/change_catalog.json CHANGED
@@ -3,27 +3,32 @@
3
3
  "request": {
4
4
  "json": {
5
5
  "change_catalog": {
6
- "name": "Change Catalog Name",
7
- "change_type": 1,
8
- "site_id": 1,
9
- "department_id": 1,
10
- "description": "description",
11
- "state_id": 1,
12
- "default_assignee_id": 1,
13
- "priority": "High",
14
- "change_plan": "change plan",
15
- "rollback_plan": "rollback plan",
16
- "test_plan": "test plan" ,
17
- "add_to_tag_list": "tag1, tag2",
18
- "remove_from_tag_list": "tag3",
19
- "tag_list": "tag1, tag2",
20
- "custom_fields_values": {
6
+ "name": "Change Catalog Name",
7
+ "change_type": 1,
8
+ "site_id": 1,
9
+ "department_id": 1,
10
+ "description": "description",
11
+ "state_id": 1,
12
+ "default_assignee_id": 1,
13
+ "priority": "High",
14
+ "change_plan": "change plan",
15
+ "rollback_plan": "rollback plan",
16
+ "test_plan": "test plan" ,
17
+ "add_to_tag_list": "tag1, tag2",
18
+ "remove_from_tag_list": "tag3",
19
+ "tag_list": "tag1, tag2",
20
+ "custom_fields_values_attributes": [
21
+ { "id": 10, "custom_field_id": 1, "value": "content" },
22
+ { "id": 100, "custom_field_id": 2, "value": "1" }
23
+ ],
24
+ "custom_fields_values": {
21
25
  "custom_fields_value": [
22
- { "name": "Name of custom text field", "value": "content" }
26
+ { "name": "Text custom field", "value": "content" },
27
+ { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
23
28
  ]
24
- }
25
- },
26
- "show_in_portal": true
29
+ },
30
+ "show_in_portal": true
31
+ }
27
32
  }
28
33
  },
29
34
  "response": {
@@ -51,12 +56,27 @@
51
56
  "default_assignee_id": 1,
52
57
  "custom_fields_values": [
53
58
  {
54
- "id": "1",
59
+ "id": "10",
55
60
  "custom_field_id": "1",
56
- "name": "Name of custom text field",
61
+ "name": "Text custom field",
57
62
  "value": "content",
58
63
  "options": "",
59
64
  "type_name": "Text"
65
+ },
66
+ {
67
+ "id": "100",
68
+ "custom_field_id": "2",
69
+ "name": "User custom field",
70
+ "value": "1",
71
+ "options": "",
72
+ "type_name": "User",
73
+ "user": {
74
+ "group_id": 1,
75
+ "is_user": true,
76
+ "id": 1,
77
+ "name": "John Doe",
78
+ "email": "john.doe@email.com"
79
+ }
60
80
  }
61
81
  ],
62
82
  "change_plan": "change plan",
data/lib/definitions/common/examples/hardware.json CHANGED
@@ -25,9 +25,14 @@
25
25
  "longitude": "0.000",
26
26
  "latitude":"0.000",
27
27
  "product_number":"1",
28
- "custom_fields_values":{
29
- "custom_fields_value":[
30
- { "name": "Name of custom text field", "value":"content" }
28
+ "custom_fields_values_attributes": [
29
+ { "id": 10, "custom_field_id": 1, "value": "content" },
30
+ { "id": 100, "custom_field_id": 2, "value": "1" }
31
+ ],
32
+ "custom_fields_values": {
33
+ "custom_fields_value": [
34
+ { "name": "Text custom field", "value": "content" },
35
+ { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
31
36
  ]
32
37
  },
33
38
  "bio": {
@@ -78,11 +83,31 @@
78
83
  "longitude": "0.000",
79
84
  "latitude": "0.000",
80
85
  "product_number": "1",
81
- "custom_fields_values": {
82
- "custom_fields_value": [
83
- { "name": "Name of custom text field", "value": "content" }
84
- ]
85
- },
86
+ "custom_fields_values": [
87
+ {
88
+ "id": "10",
89
+ "custom_field_id": "1",
90
+ "name": "Text custom field",
91
+ "value": "content",
92
+ "options": "",
93
+ "type_name": "Text"
94
+ },
95
+ {
96
+ "id": "100",
97
+ "custom_field_id": "2",
98
+ "name": "User custom field",
99
+ "value": "1",
100
+ "options": "",
101
+ "type_name": "User",
102
+ "user": {
103
+ "group_id": 1,
104
+ "is_user": true,
105
+ "id": 1,
106
+ "name": "John Doe",
107
+ "email": "john.doe@email.com"
108
+ }
109
+ }
110
+ ],
86
111
  "bioses": [{
87
112
  "id": 1,
88
113
  "manufacturer": "Dell",
data/lib/definitions/common/examples/incident.json CHANGED
@@ -17,6 +17,10 @@
17
17
  "add_to_tag_list": "tag1, tag2",
18
18
  "remove_from_tag_list": "tag3",
19
19
  "tag_list": "tag1, tag2",
20
+ "custom_fields_values_attributes": [
21
+ { "id": 10, "custom_field_id": 1, "value": "content" },
22
+ { "id": 100, "custom_field_id": 2, "value": "1" }
23
+ ],
20
24
  "custom_fields_values": {
21
25
  "custom_fields_value": [
22
26
  { "name": "Text custom field", "value": "content" },
@@ -105,7 +109,7 @@
105
109
  },
106
110
  {
107
111
  "id": "100",
108
- "custom_field_id": "1",
112
+ "custom_field_id": "2",
109
113
  "name": "User custom field",
110
114
  "value": "1",
111
115
  "options": "",
data/lib/definitions/common/examples/problem.json CHANGED
@@ -1,110 +1,132 @@
1
1
  {
2
- "examples": {
3
- "request": {
4
- "json": {
5
- "problem": {
6
- "name": "Problem Name",
7
- "site_id": 1,
8
- "department_id": 1,
9
- "description": "description",
10
- "state": 1,
11
- "root_cause": "Root cause description",
12
- "symptoms": "Symptoms description",
13
- "workaround": "workaround description",
14
- "assignee": { "email": "john.doe@email.com" },
15
- "requester": { "email": "john.doe@email.com" },
16
- "priority": "High",
17
- "add_to_tag_list": "tag1",
18
- "remove_from_tag_list": "tag2",
19
- "tag_list": "tag1",
20
- "custom_fields_values_attributes": [
21
- { "id": "10", "custom_field_id": 1, "value": "content" }
22
- ],
23
- "incident_ids": [100],
24
- "itsm_change_ids": [100],
25
- "configuration_item_ids":[100]
26
- }
2
+ "examples": {
3
+ "request": {
4
+ "json": {
5
+ "problem": {
6
+ "name": "Problem Name",
7
+ "site_id": 1,
8
+ "department_id": 1,
9
+ "description": "description",
10
+ "state": 1,
11
+ "root_cause": "Root cause description",
12
+ "symptoms": "Symptoms description",
13
+ "workaround": "workaround description",
14
+ "assignee": { "email": "john.doe@email.com" },
15
+ "requester": { "email": "john.doe@email.com" },
16
+ "priority": "High",
17
+ "add_to_tag_list": "tag1",
18
+ "remove_from_tag_list": "tag2",
19
+ "tag_list": "tag1",
20
+ "custom_fields_values_attributes": [
21
+ { "id": 10, "custom_field_id": 1, "value": "content" },
22
+ { "id": 100, "custom_field_id": 2, "value": "1" }
23
+ ],
24
+ "custom_fields_values": {
25
+ "custom_fields_value": [
26
+ { "name": "Text custom field", "value": "content" },
27
+ { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
28
+ ]
29
+ },
30
+ "incident_ids": [100],
31
+ "itsm_change_ids": [100],
32
+ "configuration_item_ids":[100]
33
+ }
34
+ }
35
+ },
36
+ "response": {
37
+ "json": {
38
+ "problem": {
39
+ "id": "10000",
40
+ "number": "1000",
41
+ "name": "Problem Name",
42
+ "description": "description",
43
+ "state": "New",
44
+ "root_cause": "Root cause description",
45
+ "symptoms": "Symptoms description",
46
+ "workaround": "workaround description",
47
+ "site": {
48
+ "id": "1",
49
+ "name": "Austin TX, USA",
50
+ "location": "AUS",
51
+ "description": "",
52
+ "time_zone": ""
53
+ },
54
+ "department": {
55
+ "id": "1",
56
+ "name": "Support",
57
+ "description": "",
58
+ "default_assignee_id": "1"
59
+ },
60
+ "priority": "High",
61
+ "created_by": {
62
+ "id": "1",
63
+ "account_id": "1",
64
+ "user_id": "1",
65
+ "email": "john.doe@email.com",
66
+ "name": "John Doe",
67
+ "disabled": false,
68
+ "avatar": {
69
+ "type": "initials",
70
+ "color": "#fd4165",
71
+ "initials": "JD"
72
+ }
73
+ },
74
+ "assignee": {
75
+ "group_id": "1",
76
+ "is_user": "true",
77
+ "id": "1",
78
+ "name": "John Doe",
79
+ "email": "john.doe@email.com",
80
+ "avatar": {
81
+ "type": "initials",
82
+ "color": "#fd4165",
83
+ "initials": "JD"
84
+ }
85
+ },
86
+ "requester": {
87
+ "id": "1",
88
+ "account_id": "1",
89
+ "user_id": "1",
90
+ "email": "john.doe@email.com",
91
+ "name": "John Doe",
92
+ "disabled": false,
93
+ "avatar": {
94
+ "type": "initials",
95
+ "color": "#fd4165",
96
+ "initials": "JD"
27
97
  }
28
- },
29
- "response": {
30
- "json": {
31
- "problem": {
32
- "id": "10000",
33
- "number": "1000",
34
- "name": "Problem Name",
35
- "description": "description",
36
- "state": "New",
37
- "root_cause": "Root cause description",
38
- "symptoms": "Symptoms description",
39
- "workaround": "workaround description",
40
- "site": {
41
- "id": "1",
42
- "name": "Austin TX, USA",
43
- "location": "AUS",
44
- "description": "",
45
- "time_zone": ""
46
- },
47
- "department": {
48
- "id": "1",
49
- "name": "Support",
50
- "description": "",
51
- "default_assignee_id": "1"
52
- },
53
- "priority": "High",
54
- "created_by": {
55
- "id": "1",
56
- "account_id": "1",
57
- "user_id": "1",
58
- "email": "john.doe@email.com",
59
- "name": "John Doe",
60
- "disabled": false,
61
- "avatar": {
62
- "type": "initials",
63
- "color": "#fd4165",
64
- "initials": "JD"
65
- }
66
- },
67
- "assignee": {
68
- "group_id": "1",
69
- "is_user": "true",
70
- "id": "1",
71
- "name": "John Doe",
72
- "email": "john.doe@email.com",
73
- "avatar": {
74
- "type": "initials",
75
- "color": "#fd4165",
76
- "initials": "JD"
77
- }
78
- },
79
- "requester": {
80
- "id": "1",
81
- "account_id": "1",
82
- "user_id": "1",
83
- "email": "john.doe@email.com",
84
- "name": "John Doe",
85
- "disabled": false,
86
- "avatar": {
87
- "type": "initials",
88
- "color": "#fd4165",
89
- "initials": "JD"
90
- }
91
- },
92
- "custom_fields_values": [
93
- {
94
- "id": "10",
95
- "custom_field_id": "1",
96
- "name": "field name",
97
- "value": "content",
98
- "options": "",
99
- "type_name": "Text"
100
- }
101
- ],
102
- "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
103
- "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
104
- "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
105
- "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
106
- }
98
+ },
99
+ "custom_fields_values": [
100
+ {
101
+ "id": "10",
102
+ "custom_field_id": "1",
103
+ "name": "Text custom field",
104
+ "value": "content",
105
+ "options": "",
106
+ "type_name": "Text"
107
+ },
108
+ {
109
+ "id": "100",
110
+ "custom_field_id": "2",
111
+ "name": "User custom field",
112
+ "value": "1",
113
+ "options": "",
114
+ "type_name": "User",
115
+ "user": {
116
+ "group_id": 1,
117
+ "is_user": true,
118
+ "id": 1,
119
+ "name": "John Doe",
120
+ "email": "john.doe@email.com"
121
+ }
107
122
  }
123
+ ],
124
+ "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
125
+ "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
126
+ "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
127
+ "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
108
128
  }
129
+ }
109
130
  }
131
+ }
110
132
  }