solarwinds-itsm-api-definitions 0.0.9 → 0.1.4

data/lib/definitions/common/examples/incident.json

@@ -1,122 +1,136 @@
 {
-    "examples": {
-        "request": {
-            "json": {
-                "incident": {
-                    "name": "Incident Name",
-                    "site_id": 1,
-                    "department_id": 1,
-                    "description": "description",
-                    "state_id": 1,
-                    "assignee": { "email": "john.doe@email.com" },
-                    "requester": { "email": "john.doe@email.com" },
-                    "priority": "High",
-                    "category": { "name": "Facilities" },
-                    "subcategory": { "name": "Equipment" },
-                    "due_at": "Jan 01,2025",
-                    "add_to_tag_list": "tag1, tag2",
-                    "custom_fields_values": {
-                        "custom_fields_value": [
-                            { "name": "field name", "value": "content" }
-                        ]
-                    },
-                    "incidents": [{ "number": "100" }],
-                    "problems": [{ "number": "100" }],
-                    "changes": [{ "number": "100" }],  
-                    "solutions": [{ "number" :"100" }],
-                    "releases": [{ "number": "100" }],
-                    "configuration_item_ids":["100"]
-                }
-            },
-            "xml": {
-                "description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
-                "xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
+  "examples": {
+    "request": {
+      "json": {
+        "incident": {
+          "name": "Incident Name",
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state_id": 1,
+          "assignee": { "email": "john.doe@email.com" },
+          "requester": { "email": "john.doe@email.com" },
+          "priority": "High",
+          "category": { "name": "Facilities" },
+          "subcategory": { "name": "Equipment" },
+          "due_at": "Jan 01,2025",
+          "add_to_tag_list": "tag1, tag2",
+          "remove_from_tag_list": "tag3",
+          "tag_list": "tag1, tag2",
+          "custom_fields_values": {
+            "custom_fields_value": [
+              { "name": "Text custom field", "value": "content" },
+              { "name": "User custom field", "user_value": { "email": "john.doe@email.com" } }
+            ]
+          },
+          "incidents": [{ "number": "100" }],
+          "problems": [{ "number": "100" }],
+          "changes": [{ "number": "100" }],
+          "solutions": [{ "number" :"100" }],
+          "releases": [{ "number": "100" }],
+          "configuration_item_ids":["100"],
+          "cc": ["jane.doe@email.com"]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "incident": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Incident Name",
+          "description": "description",
+          "state": "New",
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "",
+            "time_zone": ""
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "",
+            "default_assignee_id": "1"
+          },
+          "category": {
+            "id": "10000",
+            "name": "Facilities",
+            "default_tags": "tagA, tagB",
+            "parent_id": "null",
+            "default_assignee_id": "1"
+          },
+          "subcategory": {
+            "id": "1000",
+            "name": "Equipment",
+            "default_tags": "",
+            "parent_id": "10000",
+            "default_assignee_id": "1"
+          },
+          "priority": "High",
+          "assignee": {
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "1",
+            "name": "John Doe",
+            "email": "john.doe@email.com",
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "requester": {
+            "id": "1",
+            "account_id": "1",
+            "user_id": "1",
+            "email": "john.doe@email.com",
+            "name": "John Doe",
+            "disabled": false,
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
             }
-        },
-        "response": {
-            "json": {
-                "incident": {
-                    "id": "10000",
-                    "number": "1000",
-                    "name": "Incident Name",
-                    "description": "description",
-                    "state": "New",
-                    "site": {
-                        "id": "1",
-                        "name": "Austin TX, USA",
-                        "location": "AUS",
-                        "description": "",
-                        "time_zone": ""
-                    },
-                    "department": {
-                        "id": "1",
-                        "name": "Support",
-                        "description": "",
-                        "default_assignee_id": "1"
-                    },
-                    "category": { 
-                        "id": "10000",
-                        "name": "Facilities",
-                        "default_tags": "tagA, tagB",
-                        "parent_id": "null",
-                        "default_assignee_id": "1"
-                    },
-                    "subcategory": { 
-                        "id": "1000",
-                        "name": "Equipment",
-                        "default_tags": "",
-                        "parent_id": "10000",
-                        "default_assignee_id": "1"
-                    },
-                    "priority": "High",
-                    "assignee": { 
-                        "group_id": "1",
-                        "is_user": "true",
-                        "id":  "1",
-                        "name": "Jogn Doe",
-                        "email": "john.doe@email.com",
-                        "avatar": {
-                            "type": "initials",
-                            "color": "#fd4165",
-                            "initials": "AA"
-                        }
-                    },
-                    "requester": { 
-                        "group_id": "1",
-                        "is_user": "true",
-                        "id":  "1",
-                        "name": "John Doe",
-                        "email": "john.doe@email.com",
-                        "avatar": {
-                            "type": "initials",
-                            "color": "#fd4165",
-                            "initials": "AA"
-                        }
-                    },
-                    "custom_fields_values": [
-                        {
-                            "id": "1000",
-                            "custom_field_id": "1",
-                            "name": "field name",
-                            "value": "content",
-                            "options": "",
-                            "type_name": "Text"
-                        }
-                    ],
-                    "due_at": "2025-01-01T00:00:00.000+01:00",
-                    "origin": "api",
-                    "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/123"}],
-                    "problems": [{ "id": "100", "href": "https://mydomain.com/problems/123"}],
-                    "changes": [{ "id": "100", "href": "https://mydomain.com/changes/123"}],
-                    "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/123"}],
-                    "releases": [{ "id": "100", "href": "https://mydomain.com/releases/123"}],
-                    "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/123"}]
-                }
+          },
+          "custom_fields_values": [
+            {
+              "id": "10",
+              "custom_field_id": "1",
+              "name": "Text custom field",
+              "value": "content",
+              "options": "",
+              "type_name": "Text"
             },
-            "xml": {
-                "description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
-                "xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
+            {
+              "id": "100",
+              "custom_field_id": "1",
+              "name": "User custom field",
+              "value": "1",
+              "options": "",
+              "type_name": "User",
+              "user": {
+                "group_id": 1,
+                "is_user": true,
+                "id": 1,
+                "name": "John Doe",
+                "email": "john.doe@email.com"
+              }
             }
+          ],
+          "due_at": "2025-01-01T00:00:00.000+01:00",
+          "origin": "api",
+          "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
+          "problems": [{ "id": "100", "href": "https://mydomain.com/problems/100"}],
+          "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
+          "solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/100"}],
+          "releases": [{ "id": "100", "href": "https://mydomain.com/releases/100"}],
+          "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}],
+          "is_service_request": false,
+          "cc": ["jane.doe@email.com"]
         }
+      }
     }
+  }
 }

data/lib/definitions/common/examples/problem.json

@@ -0,0 +1,110 @@
+{
+    "examples": {
+        "request": {
+            "json": {
+                "problem": {
+                    "name": "Problem Name",
+                    "site_id": 1,
+                    "department_id": 1,
+                    "description": "description",
+                    "state": 1,
+                    "root_cause": "Root cause description",
+                    "symptoms": "Symptoms description",
+                    "workaround": "workaround description",
+                    "assignee": { "email": "john.doe@email.com" },
+                    "requester": { "email": "john.doe@email.com" },
+                    "priority": "High",
+                    "add_to_tag_list": "tag1",
+                    "remove_from_tag_list": "tag2",
+                    "tag_list": "tag1",
+                    "custom_fields_values_attributes": [
+                        { "id": "10", "custom_field_id": 1, "value": "content" }
+                    ],
+                    "incident_ids": [100],
+                    "itsm_change_ids": [100],
+                    "configuration_item_ids":[100]
+                }
+            }
+        },
+        "response": {
+            "json": {
+                "problem": {
+                    "id": "10000",
+                    "number": "1000",
+                    "name": "Problem Name",
+                    "description": "description",
+                    "state": "New",
+                    "root_cause": "Root cause description",
+                    "symptoms": "Symptoms description",
+                    "workaround": "workaround description",
+                    "site": {
+                        "id": "1",
+                        "name": "Austin TX, USA",
+                        "location": "AUS",
+                        "description": "",
+                        "time_zone": ""
+                    },
+                    "department": {
+                        "id": "1",
+                        "name": "Support",
+                        "description": "",
+                        "default_assignee_id": "1"
+                    },
+                    "priority": "High",
+                    "created_by": {
+                        "id": "1",
+                        "account_id": "1",
+                        "user_id": "1",
+                        "email": "john.doe@email.com",
+                        "name": "John Doe",
+                        "disabled": false,
+                        "avatar": {
+                            "type": "initials",
+                            "color": "#fd4165",
+                            "initials": "JD"
+                        }
+                    },
+                    "assignee": { 
+                        "group_id": "1",
+                        "is_user": "true",
+                        "id":  "1",
+                        "name": "John Doe",
+                        "email": "john.doe@email.com",
+                        "avatar": {
+                            "type": "initials",
+                            "color": "#fd4165",
+                            "initials": "JD"
+                        }
+                    },
+                    "requester": {
+                        "id": "1",
+                        "account_id": "1",
+                        "user_id": "1",
+                        "email": "john.doe@email.com",
+                        "name": "John Doe",
+                        "disabled": false,
+                        "avatar": {
+                            "type": "initials",
+                            "color": "#fd4165",
+                            "initials": "JD"
+                        }
+                    },
+                    "custom_fields_values": [
+                        {
+                            "id": "10",
+                            "custom_field_id": "1",
+                            "name": "field name",
+                            "value": "content",
+                            "options": "",
+                            "type_name": "Text"
+                        }
+                    ],
+                    "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
+                    "incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/100"}],
+                    "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
+                    "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
+                }
+            }
+        }
+    }
+}

data/lib/definitions/common/examples/release.json

@@ -0,0 +1,128 @@
+{
+  "examples": {
+    "request": {
+      "json": {
+        "release": {
+          "name": "Release Name",
+          "site_id": 1,
+          "department_id": 1,
+          "description": "description",
+          "state": 1,
+          "plan": "plan description" ,
+          "build": "build description",
+          "deploy": "deploy description",
+          "planned_start_at": "2025-01-01 00:00",
+          "planned_end_at": "2025-01-01 05:00" ,
+          "assignee": { "email": "john.doe@email.com" },
+          "requester": { "email": "john.doe@email.com" },
+          "priority": "High",
+          "add_to_tag_list": "tag1",
+          "remove_from_tag_list": "tag2",
+          "tag_list": "tag1",
+          "custom_fields_values_attributes": [
+            { "id": "10", "custom_field_id": 1, "value": "content" }
+          ],
+          "approval_levels_attributes": [
+            { "id": "1", "approver_ids": "1", "approval_condition": "1" }
+          ],
+          "itsm_change_ids": [100],
+          "configuration_item_ids":[100]
+        }
+      }
+    },
+    "response": {
+      "json": {
+        "release": {
+          "id": "10000",
+          "number": "1000",
+          "name": "Release Name",
+          "description": "description",
+          "state": "New",
+          "plan": "plan description" ,
+          "build": "build description",
+          "deploy": "deploy description",
+          "planned_start_at": "2025-01-01T00:00:00.000+01:00",
+          "planned_end_at": "2025-01-01T05:00:00.000+01:00" ,
+          "site": {
+            "id": "1",
+            "name": "Austin TX, USA",
+            "location": "AUS",
+            "description": "Austin TX, USA"
+          },
+          "department": {
+            "id": "1",
+            "name": "Support",
+            "description": "Support Department",
+            "default_assignee_id": "1"
+          },
+          "priority": "High",
+          "created_by": {
+            "id": "1",
+            "account_id": "1",
+            "user_id": "1",
+            "email": "john.doe@email.com",
+            "name": "John Doe",
+            "disabled": false,
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+        },
+          "assignee": { 
+            "group_id": "1",
+            "is_user": "true",
+            "id":  "1",
+            "name": "John Doe",
+            "email": "john.doe@email.com",
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "requester": {
+            "id": "1",
+            "account_id": "1",
+            "user_id": "1",
+            "email": "john.doe@email.com",
+            "name": "John Doe",
+            "disabled": false,
+            "avatar": {
+              "type": "initials",
+              "color": "#fd4165",
+              "initials": "JD"
+            }
+          },
+          "custom_fields_values": [
+            {
+              "id": "10",
+              "custom_field_id": "1",
+              "name": "field name",
+              "value": "content",
+              "options": "",
+              "type_name": "Text"
+            }
+          ],
+          "tags": [{ "id": 1, "name": "tag1", "taggings_count": 1 }],
+          "approvers": [
+            { 
+              "group_id": "1",
+              "is_user": "true",
+              "id":  "1",
+              "name": "John Doe",
+              "email": "john.doe@email.com",
+              "avatar": {
+                "type": "initials",
+                "color": "#fd4165",
+                "initials": "JD"
+              }
+            }
+          ],
+          "changes": [{ "id": "100", "href": "https://mydomain.com/changes/100"}],
+          "configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/100"}]
+        }
+      }
+    }
+  }
+}