solarwinds-itsm-api-definitions 0.1.3 → 0.1.4

data/lib/definitions/common/schemas/setup/department.json

@@ -0,0 +1,48 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "department": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "department.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "department": {
+              "type": "object",
+              "properties": { "$ref": "department.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Support" },
+        "description": { "type": "string", "example": "Support Department" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "department": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Support" },
+              "description": { "type": "string", "example": "Support Department" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/group.json

@@ -0,0 +1,65 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "group": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "group.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "group": {
+              "type": "object",
+              "properties": { "$ref": "group.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Group Name" },
+        "description": { "type": "string", "example": "Group Description" },
+        "superviser_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+        "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
+        "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "group": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Group Name" },
+              "description": { "type": "string", "example": "Group Description" },
+              "is_user": { "type": "boolean", "example": false },
+              "reports_to": { "$ref": "../../components.json#/components/response/schemas/group_details" },
+              "avatar": { "$ref": "../../components.json#/components/response/schemas/avatar" },
+              "send_notifications": { "type": "boolean", "example": true },
+              "memberships": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+                    "user": { "type": "string", "example": "John Doe" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/role.json

@@ -0,0 +1,51 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "role": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "role.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "role": {
+              "type": "object",
+              "properties": { "$ref": "role.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Support Agent" },
+        "description": { "type": "string", "example": "Support Agent role" },
+        "portal": { "type": "boolean", "example": true }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "role": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Support Agent" },
+              "description": { "type": "string", "example": "Support Agent role" },
+              "portal": { "type": "boolean", "example": true },
+              "show_my_tasks": { "type": "boolean", "example": false }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/site.json

@@ -0,0 +1,64 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "site": {
+              "type": "object",
+              "required": ["name", "location"],
+              "properties": { "$ref": "site.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "site": {
+              "type": "object",
+              "properties": { "$ref": "site.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Austin TX, USA" },
+        "location": { "type": "string", "example": "AUS" },
+        "description": { "type": "string", "example": "Description Austin TX, USA" },
+        "time_zone": { "type": "string", "example": "Texas" },
+        "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
+        "manager_id": {
+          "$ref": "../../components.json#/components/common/schemas/association_by_id",
+          "description": "user only, not group"
+        },
+        "default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+        "business_record": {
+          "type": "object",
+          "properties": { "id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } }
+        }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "site": {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Austin TX, USA" },
+              "location": { "type": "string", "example": "AUS" },
+              "description": { "type": "string", "example": "Description Austin TX, USA" },
+              "time_zone": { "type": "string", "example": "Texas" },
+              "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
+              "business_record": { "type": "string", "example": "1" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/setup/user.json

@@ -0,0 +1,67 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "user": {
+              "type": "object",
+              "required": ["name", "email"],
+              "properties": { "$ref": "user.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "user": {
+              "type": "object",
+              "properties": { "$ref": "user.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "John Doe" },
+        "title": { "type": "string", "example": "Support Agent" },
+        "email": { "type": "string", "format": "email", "example": "john.doe@email.com" },
+        "disabled": { "type": "boolean", "example": false },
+        "phone": { "type": "string", "example": "+10000000" },
+        "mobile_phone": { "type": "string", "example": "+10000000" },
+        "role": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
+        "reports_to": { "$ref": "../../components.json#/components/request/schemas/reports_to" },
+        "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "user": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "John Doe" },
+              "title": { "type": "string", "example": "Support Agent" },
+              "email": { "type": "string", "format": "email", "example": "john.doe@email.com" },
+              "phone": { "type": "string", "example": "+10000000" },
+              "mobile_phone": { "type": "string", "example": "+10000000" },
+              "role": { "$ref": "../../components.json#/components/response/schemas/role" },
+              "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
+              "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
+              "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
+              "avatar": { "$ref": "../../components.json#/components/response/schemas/avatar" },
+              "reports_to": { "$ref": "../../components.json#/components/response/schemas/group_details" },
+              "group_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
+              "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/tasks/task.json

@@ -0,0 +1,52 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "post": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "task": {
+              "type": "object",
+              "required": ["name"],
+              "properties": { "$ref": "task.json#/components/schemas/request_properties" }
+            }
+          }
+        },
+        "put": {
+          "type": "object",
+          "xml": { "name": "/" },
+          "properties": {
+            "task": {
+              "type": "object",
+              "properties": { "$ref": "task.json#/components/schemas/request_properties" }
+            }
+          }
+        }
+      },
+      "request_properties": {
+        "name": { "type": "string", "example": "Task Name" },
+        "assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
+        "due_at": { "type": "string", "example": "Jan 01, 2030" },
+        "is_complete": { "type": "boolean", "example": false }
+      },
+      "response": {
+        "type": "object",
+        "xml": { "name": "/", "wrapped": true },
+        "properties": {
+          "task": {
+            "type": "object",
+            "properties": {
+              "id": { "$ref": "../../components.json#/components/response/schemas/id" },
+              "name": { "type": "string", "example": "Task Name" },
+              "due_at": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" },
+              "requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
+              "assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
+              "parent": { "$ref": "../../components.json#/components/response/schemas/parent_object" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "SolarWinds ITSM API",
     "description": "All SolarWinds ITSM API definitions",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "contact": {
       "name": "API Support",
       "url": "samanage.com/support",
@@ -17,14 +17,101 @@
   "paths": {
     "/incidents/{id}": { "$ref": "paths/incidents/incident_by_id.json" },
     "/incidents": { "$ref": "paths/incidents/incidents.json" },
+    "/problems/{id}": { "$ref": "paths/problems/problem_by_id.json" },
+    "/problems": { "$ref": "paths/problems/problems.json" },
+    "/changes/{id}": { "$ref": "paths/changes/change_by_id.json" },
+    "/changes": { "$ref": "paths/changes/changes.json" },
+    "/change_catalogs/{id}": { "$ref": "paths/change_catalogs/change_catalog_by_id.json" },
+    "/change_catalogs": { "$ref": "paths/change_catalogs/change_catalogs.json" },
+    "/releases/{id}": { "$ref": "paths/releases/release_by_id.json" },
+    "/releases": { "$ref": "paths/releases/releases.json" },
+    "/solutions/{id}": { "$ref": "paths/solutions/solution_by_id.json" },
+    "/solutions": { "$ref": "paths/solutions/solutions.json" },
+    "/catalog_items/{id}": { "$ref": "paths/catalog_items/catalog_item_by_id.json" },
+    "/catalog_items": { "$ref": "paths/catalog_items/catalog_items.json" },
+    "/catalog_items/{id}/service_requests": { "$ref": "paths/service_requests/request_by_id.json" },
+    "/configuration_items/{id}": { "$ref": "paths/configuration_items/configuration_item_by_id.json" },
+    "/configuration_items": { "$ref": "paths/configuration_items/configuration_items.json" },
+    "/configuration_items/{id}/append_multiple_dependent_assets": { "$ref": "paths/configuration_items/append_dependent_assets.json" },
+    "/asset_links/delete_asset_link_by_id": { "$ref": "paths/configuration_items/delete_asset_link.json" },
     "/users/{id}": { "$ref": "paths/users/user_by_id.json" },
     "/users": { "$ref": "paths/users/users.json" },
-    "/problems/{id}": { "$ref": "paths/problems/problem_by_id.json" },
-    "/problems": { "$ref": "paths/problems/problems.json" }
+    "/sites/{id}": { "$ref": "paths/sites/site_by_id.json" },
+    "/sites": { "$ref": "paths/sites/sites.json" },
+    "/departments/{id}": { "$ref": "paths/departments/department_by_id.json" },
+    "/departments": { "$ref": "paths/departments/departments.json" },
+    "/roles/{id}": { "$ref": "paths/roles/role_by_id.json" },
+    "/roles": { "$ref": "paths/roles/roles.json" },
+    "/groups/{id}": { "$ref": "paths/groups/group_by_id.json" },
+    "/groups": { "$ref": "paths/groups/groups.json" },
+    "/categories/{id}": { "$ref": "paths/categories/category_by_id.json" },
+    "/categories": { "$ref": "paths/categories/categories.json" },
+    "/hardwares/{id}": { "$ref": "paths/hardwares/hardware_by_id.json" },
+    "/hardwares": { "$ref": "paths/hardwares/hardwares.json" },
+    "/mobiles/{id}": { "$ref": "paths/mobiles/mobile_by_id.json" },
+    "/mobiles": { "$ref": "paths/mobiles/mobiles.json" },
+    "/other_assets/{id}": { "$ref": "paths/other_assets/other_asset_by_id.json" },
+    "/other_assets": { "$ref": "paths/other_assets/other_assets.json" },
+    "/softwares/{id}": { "$ref": "paths/softwares/software_by_id.json" },
+    "/softwares": { "$ref": "paths/softwares/softwares.json" },
+    "/printers/{id}": { "$ref": "paths/printers/printer_by_id.json" },
+    "/printers": { "$ref": "paths/printers/printers.json" },
+    "/contracts/{id}": { "$ref": "paths/contracts/contract_by_id.json" },
+    "/contracts": { "$ref": "paths/contracts/contracts.json" },
+    "/purchase_orders/{id}": { "$ref": "paths/purchase_orders/purchase_order_by_id.json" },
+    "/purchase_orders": { "$ref": "paths/purchase_orders/purchase_orders.json" },
+    "/vendors/{id}": { "$ref": "paths/vendors/vendor_by_id.json" },
+    "/vendors": { "$ref": "paths/vendors/vendors.json" },
+    "/contracts/{id}/items": { "$ref": "paths/contracts/items.json" },
+    "/contracts/{contract_id}/items/{item_id}": { "$ref": "paths/contracts/item_by_id.json" },
+    "/{object_type}/{id}/tasks": { "$ref": "paths/tasks/tasks.json" },
+    "/{object_type}/{id}/tasks/{task_id}": { "$ref": "paths/tasks/task_by_id.json" },
+    "/{object_type}/{id}/comments": { "$ref": "paths/comments/comments.json" },
+    "/{object_type}/{id}/comments/{comment_id}": { "$ref": "paths/comments/comment_by_id.json" },
+    "/hardwares/{id}/warranties": { "$ref": "paths/hardwares/warranties.json" },
+    "/hardwares/{hardware_id}/warranties/{warranty_id}": { "$ref": "paths/hardwares/warranty_by_id.json" },
+    "/{object_type}/{id}/time_tracks": { "$ref": "paths/time_tracks/time_tracks.json" },
+    "/{object_type}/{id}/time_tracks/{time_track_id}": { "$ref": "paths/time_tracks/time_track_by_id.json" },
+    "/{object_type}/{id}/purchases": { "$ref": "paths/purchases/purchases.json" },
+    "/{object_type}/{id}/purchases/{purchase_id}": { "$ref": "paths/purchases/purchase_by_id.json" },
+    "/memberships": { "$ref": "paths/memberships/memberships.json" },
+    "/memberships/{id}": { "$ref": "paths/memberships/membership_by_id.json" },
+    "/audits": { "$ref": "paths/audits/audits.json" },
+    "/{object_type}/{id}/audits": { "$ref": "paths/audits/audits_by_id.json" },
+    "/risks": { "$ref": "paths/risks/risks.json" },
+    "/attachments": { "$ref": "paths/attachments/attachments.json" }
   },
   "tags": [
     { "name": "Incident", "description": "Incident operations" },
+    { "name": "Problem", "description": "Problem operations" },
+    { "name": "Change", "description": "Change operations" },
+    { "name": "Change Catalog", "description": "Change catalog operations" },
+    { "name": "Release", "description": "Release operations" },
+    { "name": "Solution", "description": "Solution operations" },
+    { "name": "Catalog Item", "description": "Catalog Item operations" },
+    { "name": "Service Request", "description": "Requesting a service" },
+    { "name": "Configuration Item", "description": "Configuration Item operations" },
     { "name": "User", "description": "User operations" },
-    { "name": "Problem", "description": "Problem operations" }
+    { "name": "Site", "description": "Site operations" },
+    { "name": "Department", "description": "Department operations" },
+    { "name": "Role", "description": "Role operations" },
+    { "name": "Group", "description": "Group operations" },
+    { "name": "Membership", "description": "Membership operations" },
+    { "name": "Category", "description": "Category operations" },
+    { "name": "Hardware", "description": "Hardware operations" },
+    { "name": "Mobile Device", "description": "Mobile device operations" },
+    { "name": "Other Asset", "description": "Other asset operations" },
+    { "name": "Software", "description": "Software operations" },
+    { "name": "Printer", "description": "Printer operations" },
+    { "name": "Contract", "description": "Contract operations" },
+    { "name": "Purchase Order", "description": "Purchase order operations" },
+    { "name": "Vendor", "description": "Vendor operations" },
+    { "name": "Task", "description": "Task operations" },
+    { "name": "Comment", "description": "Comment operations" },
+    { "name": "Time Track", "description": "Time Track operations" },
+    { "name": "Purchase", "description": "Purchase operations" },
+    { "name": "Audit", "description": "Audit operations" },
+    { "name": "Risk", "description": "Risk operations" },
+    { "name": "Attachment", "description": "Attachment operations" }
   ]
 }