solarwinds-itsm-api-definitions 0.0.7 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/definitions/common/components.json +171 -123
- data/lib/definitions/common/examples/incident.json +28 -35
- data/lib/definitions/common/examples/user.json +76 -0
- data/lib/definitions/common/schemas/incident.json +31 -68
- data/lib/definitions/common/schemas/user.json +53 -0
- data/lib/definitions/openapi.json +6 -6
- data/lib/definitions/paths/incidents/incident_by_id.json +27 -9
- data/lib/definitions/paths/incidents/incidents.json +33 -5
- data/lib/definitions/paths/users/user_by_id.json +84 -0
- data/lib/definitions/paths/users/users.json +69 -0
- data/lib/resolved_schema/resolved_schema.json +1 -1
- metadata +9 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f6c9b8cbf0f5cc8e5ba43221fc294a0badef740f61138a7ad6f47661adf307ba
|
|
4
|
+
data.tar.gz: 24361ec5717637cdbc899e866c091cde67eaa7f1b8cd0636dcdc4ab140287ea8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5980d87da3b952dd8eb447a90936d75cf6d92101d8b3ccc9f61b3facde7698d071622cc0c31bd29f062177679f31b66423c4752b367ff3a8ff2c1a2ed10dc568
|
|
7
|
+
data.tar.gz: 44b96d412caddbfb09f42cace13dd733ce353713382bad70727ee81b5397250a65e73685ef14087220abb05ad5bbe051635a5e91b5e6db6bc9f0b0938b425087
|
|
@@ -1,153 +1,201 @@
|
|
|
1
1
|
{
|
|
2
2
|
"components": {
|
|
3
|
-
"
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
"request": {
|
|
4
|
+
"parameters": {
|
|
5
|
+
"token_param": {
|
|
6
|
+
"name": "X-Samanage-Authorization",
|
|
7
|
+
"in": "header",
|
|
8
|
+
"schema": { "type": "string" },
|
|
9
|
+
"example": "Bearer TOKEN"
|
|
10
|
+
},
|
|
11
|
+
"id_param": {
|
|
12
|
+
"name": "id",
|
|
13
|
+
"in": "path",
|
|
14
|
+
"schema": { "type": "string" },
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "Numeric ID of the object to get or update"
|
|
17
|
+
}
|
|
9
18
|
},
|
|
10
|
-
"
|
|
11
|
-
"
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
19
|
+
"schemas": {
|
|
20
|
+
"association_by_name": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"oneOf": [{
|
|
23
|
+
"type": "object",
|
|
24
|
+
"required": ["name"],
|
|
25
|
+
"properties": {
|
|
26
|
+
"name": { "type": "string" }
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
{ "enum": ["nil", "", null] }]
|
|
30
|
+
},
|
|
31
|
+
"association_by_email": {
|
|
32
|
+
"type": "object",
|
|
33
|
+
"oneOf": [{
|
|
34
|
+
"type": "object",
|
|
35
|
+
"required": ["email"],
|
|
36
|
+
"properties": {
|
|
37
|
+
"email": { "type": "string" }
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
{ "enum": ["nil", "", null] }]
|
|
41
|
+
},
|
|
42
|
+
"numbers_array": {
|
|
43
|
+
"type": "array",
|
|
44
|
+
"items": {
|
|
45
|
+
"type": "object",
|
|
46
|
+
"properties": {
|
|
47
|
+
"number": {
|
|
48
|
+
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
"custom_field": {
|
|
54
|
+
"type": "object",
|
|
55
|
+
"required": ["name", "value"],
|
|
56
|
+
"properties": {
|
|
57
|
+
"name": { "type": "string" },
|
|
58
|
+
"value": { "type": "string" }
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"custom_field_value": {
|
|
62
|
+
"type": "array",
|
|
63
|
+
"items": { "$ref": "components.json#/components/request/schemas/custom_field" }
|
|
64
|
+
},
|
|
65
|
+
"custom_field_values": {
|
|
66
|
+
"type": "object",
|
|
67
|
+
"required": ["custom_field_value"],
|
|
68
|
+
"properties": {
|
|
69
|
+
"custom_field_value": { "$ref": "components.json#/components/request/schemas/custom_field_value" }
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"custom_fields_value": {
|
|
73
|
+
"type": "array",
|
|
74
|
+
"items": { "$ref": "components.json#/components/request/schemas/custom_field" }
|
|
75
|
+
},
|
|
76
|
+
"custom_fields_values": {
|
|
77
|
+
"type": "object",
|
|
78
|
+
"required": ["custom_fields_value"],
|
|
79
|
+
"properties": { "custom_fields_value": { "$ref": "components.json#/components/request/schemas/custom_fields_value" } }
|
|
80
|
+
}
|
|
16
81
|
}
|
|
17
82
|
},
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
"
|
|
83
|
+
"response": {
|
|
84
|
+
"schemas": {
|
|
85
|
+
"id": {
|
|
86
|
+
"readOnly": true,
|
|
87
|
+
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
88
|
+
},
|
|
89
|
+
"custom_field": {
|
|
25
90
|
"type": "object",
|
|
26
|
-
"required": ["name"],
|
|
27
91
|
"properties": {
|
|
28
|
-
"
|
|
92
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
93
|
+
"custom_field_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
94
|
+
"name": { "type": "string" },
|
|
95
|
+
"value": { "type": "string" },
|
|
96
|
+
"options": { "type": "string" },
|
|
97
|
+
"type_name": { "type": "string" }
|
|
29
98
|
}
|
|
30
99
|
},
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
"
|
|
100
|
+
"custom_field_values": {
|
|
101
|
+
"type": "array",
|
|
102
|
+
"items": { "$ref": "components.json#/components/response/schemas/custom_field" }
|
|
103
|
+
},
|
|
104
|
+
"category_subcategory": {
|
|
36
105
|
"type": "object",
|
|
37
|
-
"required": ["email"],
|
|
38
106
|
"properties": {
|
|
39
|
-
"
|
|
107
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
108
|
+
"name": { "type": "string" },
|
|
109
|
+
"default_tags": { "type": "string" },
|
|
110
|
+
"parent_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
111
|
+
"default_assignee_id": { "$ref": "components.json#/components/response/schemas/id" }
|
|
40
112
|
}
|
|
41
113
|
},
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
114
|
+
"avatar": {
|
|
115
|
+
"type": "object",
|
|
116
|
+
"properties": {
|
|
117
|
+
"type": { "type": "string" },
|
|
118
|
+
"color": { "type": "string" },
|
|
119
|
+
"initials": {
|
|
120
|
+
"type": "string",
|
|
121
|
+
"minLength": 2,
|
|
122
|
+
"maxLength": 2
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
"assignee_details": {
|
|
51
127
|
"type": "object",
|
|
52
|
-
"required": ["name", "value"],
|
|
53
128
|
"properties": {
|
|
129
|
+
"group_id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
130
|
+
"is_user": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] },
|
|
131
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
54
132
|
"name": { "type": "string" },
|
|
55
|
-
"
|
|
133
|
+
"email": { "type": "string" },
|
|
134
|
+
"avatar": { "$ref": "components.json#/components/response/schemas/avatar" }
|
|
56
135
|
}
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
"custom_field_value": {
|
|
60
|
-
"type": "array",
|
|
61
|
-
"items": {
|
|
62
|
-
"allOf": [{ "$ref": "components.json#/components/schemas/custom_field" }]
|
|
63
|
-
}
|
|
64
|
-
},
|
|
65
|
-
"custom_field_values": {
|
|
66
|
-
"type": "object",
|
|
67
|
-
"oneOf": [{
|
|
136
|
+
},
|
|
137
|
+
"requester_details": {
|
|
68
138
|
"type": "object",
|
|
69
|
-
"required": ["custom_field_value"],
|
|
70
139
|
"properties": {
|
|
71
|
-
"
|
|
140
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
141
|
+
"account_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
142
|
+
"user_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
143
|
+
"email": { "type": "string" },
|
|
144
|
+
"name": { "type": "string" },
|
|
145
|
+
"disabled": { "type": "boolean" },
|
|
146
|
+
"avatar": { "$ref": "components.json#/components/response/schemas/avatar" }
|
|
72
147
|
}
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
"default_assignee_id": { "$ref": "components.json#/components/schemas/id" }
|
|
83
|
-
}
|
|
84
|
-
},
|
|
85
|
-
"avatar": {
|
|
86
|
-
"type": "object",
|
|
87
|
-
"properties": {
|
|
88
|
-
"type": { "type": "string" },
|
|
89
|
-
"color": { "type": "string" },
|
|
90
|
-
"initials": {
|
|
91
|
-
"type": "string",
|
|
92
|
-
"minLength": 2,
|
|
93
|
-
"maxLength": 2
|
|
148
|
+
},
|
|
149
|
+
"site_response": {
|
|
150
|
+
"type": "object",
|
|
151
|
+
"properties": {
|
|
152
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
153
|
+
"name": { "type": "string" },
|
|
154
|
+
"description": { "type": "string" },
|
|
155
|
+
"location": { "type": "string" },
|
|
156
|
+
"timezone": { "type": "string" }
|
|
94
157
|
}
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
"requester_assignee_details": {
|
|
98
|
-
"type": "object",
|
|
99
|
-
"properties": {
|
|
100
|
-
"group_id": { "$ref": "components.json#/components/schemas/association_by_id" },
|
|
101
|
-
"is_user": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] },
|
|
102
|
-
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
103
|
-
"name": { "type": "string" },
|
|
104
|
-
"email": { "type": "string" },
|
|
105
|
-
"avatar": { "$ref": "components.json#/components/schemas/avatar" }
|
|
106
|
-
}
|
|
107
|
-
},
|
|
108
|
-
"site_response": {
|
|
109
|
-
"type": "object",
|
|
110
|
-
"properties": {
|
|
111
|
-
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
112
|
-
"name": { "type": "string" },
|
|
113
|
-
"description": { "type": "string" },
|
|
114
|
-
"location": { "type": "string" },
|
|
115
|
-
"timezone": { "type": "string" }
|
|
116
|
-
}
|
|
117
|
-
},
|
|
118
|
-
"department_response": {
|
|
119
|
-
"type": "object",
|
|
120
|
-
"properties": {
|
|
121
|
-
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
122
|
-
"name": { "type": "string" },
|
|
123
|
-
"description": { "type": "string" },
|
|
124
|
-
"default_assignee_id": { "$ref": "components.json#/components/schemas/id" }
|
|
125
|
-
}
|
|
126
|
-
},
|
|
127
|
-
"ids_array": {
|
|
128
|
-
"type": "array",
|
|
129
|
-
"items": {
|
|
130
|
-
"$ref": "components.json#/components/schemas/association_by_id"
|
|
131
|
-
}
|
|
132
|
-
},
|
|
133
|
-
"numbers_array": {
|
|
134
|
-
"type": "array",
|
|
135
|
-
"items": {
|
|
158
|
+
},
|
|
159
|
+
"department_response": {
|
|
136
160
|
"type": "object",
|
|
137
161
|
"properties": {
|
|
138
|
-
"
|
|
139
|
-
|
|
162
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
163
|
+
"name": { "type": "string" },
|
|
164
|
+
"description": { "type": "string" },
|
|
165
|
+
"default_assignee_id": { "$ref": "components.json#/components/response/schemas/id" }
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"response_attachments": {
|
|
169
|
+
"type": "array",
|
|
170
|
+
"items": {
|
|
171
|
+
"type": "object",
|
|
172
|
+
"properties": {
|
|
173
|
+
"id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
174
|
+
"href": { "type": "string" }
|
|
140
175
|
}
|
|
141
176
|
}
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
"response_attachments": {
|
|
145
|
-
"type": "array",
|
|
146
|
-
"items": {
|
|
177
|
+
},
|
|
178
|
+
"role": {
|
|
147
179
|
"type": "object",
|
|
148
180
|
"properties": {
|
|
149
|
-
"id": { "$ref": "components.json#/components/schemas/
|
|
150
|
-
"
|
|
181
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
182
|
+
"name": { "type": "string" },
|
|
183
|
+
"description": { "type": "string" },
|
|
184
|
+
"portal": { "type": "boolean" },
|
|
185
|
+
"show_my_tasks": { "type": "boolean" }
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
},
|
|
190
|
+
"common": {
|
|
191
|
+
"schemas": {
|
|
192
|
+
"association_by_id": {
|
|
193
|
+
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
194
|
+
},
|
|
195
|
+
"ids_array": {
|
|
196
|
+
"type": "array",
|
|
197
|
+
"items": {
|
|
198
|
+
"$ref": "components.json#/components/common/schemas/association_by_id"
|
|
151
199
|
}
|
|
152
200
|
}
|
|
153
201
|
}
|
|
@@ -13,31 +13,27 @@
|
|
|
13
13
|
"priority": "High",
|
|
14
14
|
"category": { "name": "Facilities" },
|
|
15
15
|
"subcategory": { "name": "Equipment" },
|
|
16
|
-
"due_at": "Jan 01,
|
|
16
|
+
"due_at": "Jan 01,2025",
|
|
17
17
|
"add_to_tag_list": "tag1, tag2",
|
|
18
18
|
"custom_fields_values": {
|
|
19
19
|
"custom_fields_value": [
|
|
20
20
|
{ "name": "field name", "value": "content" }
|
|
21
21
|
]
|
|
22
22
|
},
|
|
23
|
-
"incidents": [{ "number": "
|
|
24
|
-
"problems": [{ "number": "
|
|
25
|
-
"changes": [{ "number": "
|
|
26
|
-
"solutions": [{ "number" :"
|
|
27
|
-
"releases": [{ "number": "
|
|
28
|
-
"configuration_item_ids":["
|
|
23
|
+
"incidents": [{ "number": "100" }],
|
|
24
|
+
"problems": [{ "number": "100" }],
|
|
25
|
+
"changes": [{ "number": "100" }],
|
|
26
|
+
"solutions": [{ "number" :"100" }],
|
|
27
|
+
"releases": [{ "number": "100" }],
|
|
28
|
+
"configuration_item_ids":["100"]
|
|
29
29
|
}
|
|
30
|
-
},
|
|
31
|
-
"xml": {
|
|
32
|
-
"description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
|
|
33
|
-
"xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
|
|
34
30
|
}
|
|
35
31
|
},
|
|
36
32
|
"response": {
|
|
37
33
|
"json": {
|
|
38
34
|
"incident": {
|
|
39
|
-
"id": "
|
|
40
|
-
"number": "
|
|
35
|
+
"id": "10000",
|
|
36
|
+
"number": "1000",
|
|
41
37
|
"name": "Incident Name",
|
|
42
38
|
"description": "description",
|
|
43
39
|
"state": "New",
|
|
@@ -55,17 +51,17 @@
|
|
|
55
51
|
"default_assignee_id": "1"
|
|
56
52
|
},
|
|
57
53
|
"category": {
|
|
58
|
-
"id": "
|
|
54
|
+
"id": "10000",
|
|
59
55
|
"name": "Facilities",
|
|
60
56
|
"default_tags": "tagA, tagB",
|
|
61
57
|
"parent_id": "null",
|
|
62
58
|
"default_assignee_id": "1"
|
|
63
59
|
},
|
|
64
60
|
"subcategory": {
|
|
65
|
-
"id": "
|
|
61
|
+
"id": "1000",
|
|
66
62
|
"name": "Equipment",
|
|
67
63
|
"default_tags": "",
|
|
68
|
-
"parent_id": "
|
|
64
|
+
"parent_id": "10000",
|
|
69
65
|
"default_assignee_id": "1"
|
|
70
66
|
},
|
|
71
67
|
"priority": "High",
|
|
@@ -78,24 +74,25 @@
|
|
|
78
74
|
"avatar": {
|
|
79
75
|
"type": "initials",
|
|
80
76
|
"color": "#fd4165",
|
|
81
|
-
"initials": "
|
|
77
|
+
"initials": "JD"
|
|
82
78
|
}
|
|
83
79
|
},
|
|
84
|
-
"requester": {
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"name": "John Doe",
|
|
80
|
+
"requester": {
|
|
81
|
+
"id": "1",
|
|
82
|
+
"account_id": "1",
|
|
83
|
+
"user_id": "1",
|
|
89
84
|
"email": "john.doe@email.com",
|
|
85
|
+
"name": "John Doe",
|
|
86
|
+
"disabled": false,
|
|
90
87
|
"avatar": {
|
|
91
88
|
"type": "initials",
|
|
92
89
|
"color": "#fd4165",
|
|
93
|
-
"initials": "
|
|
90
|
+
"initials": "JD"
|
|
94
91
|
}
|
|
95
92
|
},
|
|
96
93
|
"custom_fields_values": [
|
|
97
94
|
{
|
|
98
|
-
"id": "
|
|
95
|
+
"id": "1000",
|
|
99
96
|
"custom_field_id": "1",
|
|
100
97
|
"name": "field name",
|
|
101
98
|
"value": "content",
|
|
@@ -103,19 +100,15 @@
|
|
|
103
100
|
"type_name": "Text"
|
|
104
101
|
}
|
|
105
102
|
],
|
|
106
|
-
"due_at": "
|
|
103
|
+
"due_at": "2025-01-01T00:00:00.000+01:00",
|
|
107
104
|
"origin": "api",
|
|
108
|
-
"incidents": [{ "id": "
|
|
109
|
-
"problems": [{ "id": "
|
|
110
|
-
"changes": [{ "id": "
|
|
111
|
-
"solutions": [{ "id": "
|
|
112
|
-
"releases": [{ "id": "
|
|
113
|
-
"configuration_items": [{ "id": "
|
|
105
|
+
"incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/123"}],
|
|
106
|
+
"problems": [{ "id": "100", "href": "https://mydomain.com/problems/123"}],
|
|
107
|
+
"changes": [{ "id": "100", "href": "https://mydomain.com/changes/123"}],
|
|
108
|
+
"solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/123"}],
|
|
109
|
+
"releases": [{ "id": "100", "href": "https://mydomain.com/releases/123"}],
|
|
110
|
+
"configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/123"}]
|
|
114
111
|
}
|
|
115
|
-
},
|
|
116
|
-
"xml": {
|
|
117
|
-
"description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
|
|
118
|
-
"xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
|
|
119
112
|
}
|
|
120
113
|
}
|
|
121
114
|
}
|