solarwinds-itsm-api-definitions 0.0.9 → 0.1.4

data/lib/definitions/paths/hardwares/warranties.json

@@ -0,0 +1,64 @@
+{
+  "get": {
+    "operationId": "getWarranties",
+    "description": "List of warranties",
+    "tags": ["Hardware"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of warranties",
+              "type": "array",
+              "items": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" }
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of warranties",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" }
+            }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Server error" }
+    }
+  },
+  "post": {
+    "operationId": "createWarranty",
+    "description": "Create new Warranty",
+    "tags": ["Hardware"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Warranty fields to fill",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/request" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/request" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object created and returned correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/hardwares/warranty_by_id.json

@@ -0,0 +1,75 @@
+{
+  "put": {
+    "operationId": "updateWarrantyById",
+    "description": "Update warranty with specified fields",
+    "tags": ["Hardware"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { 
+        "name": "hardware_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the hardware"
+      },
+      { 
+        "name": "warranty_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the warranty"
+      }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Warranty fields to update",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/request" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/request" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/warranty.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteWarrantyById",
+    "description": "Delete warranty",
+    "tags": ["Hardware"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { 
+        "name": "hardware_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the hardware"
+      },
+      { 
+        "name": "warranty_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the warranty"
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Message regarding a successful operation",
+        "content": { "application/json": { "example": { "messages": { "message": "Deleted warranty" } } } }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/incidents/incident_by_id.json

@@ -4,13 +4,19 @@
     "description": "Get incident",
     "tags": ["Incident"],
     "parameters": [
-      { "$ref": "../../common/components.json#/components/parameters/token_param" },
-      { "$ref": "../../common/components.json#/components/parameters/id_param" }
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
     ],
     "responses": {
       "200": {
         "description": "Object was returned correctly",
-        "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/incident.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" } }
+        }
       },
       "400": { "description": "Bad request" },
       "404": { "description": "Not found" },
@@ -22,18 +28,30 @@
     "description": "Update incident with specified fields",
     "tags": ["Incident"],
     "parameters": [
-      { "$ref": "../../common/components.json#/components/parameters/token_param" },
-      { "$ref": "../../common/components.json#/components/parameters/id_param" }
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
     ],
     "requestBody": {
       "required": true,
       "description": "Incident fields to update",
-      "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_request_content" }
+      "content": {
+        "application/json": {
+          "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/request/put" },
+          "example": { "$ref": "../../common/examples/incident.json#/examples/request/json" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/request/put" } }
+      }
     },
     "responses": {
       "200": {
         "description": "Object was updated correctly",
-        "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/incident.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" } }
+        }
       },
       "400": { "description": "Bad request" },
       "404": { "description": "Not found" },
@@ -45,12 +63,12 @@
     "description": "Delete incident",
     "tags": ["Incident"],
     "parameters": [
-      { "$ref": "../../common/components.json#/components/parameters/token_param" },
-      { "$ref": "../../common/components.json#/components/parameters/id_param" }
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
     ],
     "responses": {
       "200": {
-        "description": "Object was returned correctly",
+        "description": "Returns the deleted incident's id",
         "content": {
           "application/json": {
             "example": { "deleted_ids": ["1"] }

data/lib/definitions/paths/incidents/incidents.json

@@ -4,12 +4,29 @@
     "description": "List of incidents",
     "tags": ["Incident"],
     "parameters": [
-      { "$ref": "../../common/components.json#/components/parameters/token_param" }
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
     ],
     "responses": {
-      "200": { 
+      "200": {
         "description": "Object was returned correctly",
-        "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/many_incidents_content" }
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of incidents",
+              "type": "array",
+              "items": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" }
+            },
+            "example": [{ "$ref": "../../common/examples/incident.json#/examples/response/json" }]
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of incidents",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" }
+            }
+          }
+        }
       },
       "400": { "description": "Bad request" },
       "404": { "description": "Not found" },
@@ -21,21 +38,32 @@
     "description": "Create new incident",
     "tags": ["Incident"],
     "parameters": [
-      { "$ref": "../../common/components.json#/components/parameters/token_param" }
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
     ],
     "requestBody": {
       "required": true,
       "description": "Incident fields to fill",
-      "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_request_content" }
+      "content": {
+        "application/json": {
+          "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/request/post" },
+          "example": { "$ref": "../../common/examples/incident.json#/examples/request/json" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/request/post" } }
+      }
     },
     "responses": {
-      "200": { 
+      "200": {
         "description": "Object created and returned correctly",
-        "content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/incident.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/incident.json#/components/schemas/response" } }
+        }
       },
       "400": { "description": "Bad request" },
       "500": { "description": "Server error" }
     }
   }
 }
-  

data/lib/definitions/paths/memberships/membership_by_id.json

@@ -0,0 +1,20 @@
+{
+  "delete": {
+    "operationId": "deleteMemebershipById",
+    "description": "Delete membership.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X DELETE https://api.samanage.com/memberships/1.xml",
+    "tags": ["Membership"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Message regarding a successful operation",
+        "content": { "application/json": { "example": { "messages": { "message": "Deleted membership" } } } }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/memberships/memberships.json

@@ -0,0 +1,29 @@
+{
+  "post": {
+    "operationId": "createMembership",
+    "description": "Create new Membership. Memberships are used to relate a user to a group.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X POST https://api.samanage.com/memberships.xml?group_id=1&user_ids=1",
+    "tags": ["Membership"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { 
+        "name": "group_id",
+        "in": "query",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the group"
+      },
+      { 
+        "name": "user_ids",
+        "in": "query",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric IDs of the users"
+      }
+    ],
+    "responses": {
+      "200": { "description": "membership created and returned correctly" },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/mobiles/mobile_by_id.json

@@ -0,0 +1,74 @@
+{
+  "get": {
+    "operationId": "getMobileById",
+    "description": "Get mobile device",
+    "tags": ["Mobile Device"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "put": {
+    "operationId": "updateMobileById",
+    "description": "Update mobile device with specified fields",
+    "tags": ["Mobile Device"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Mobile device fields to update",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/request/put" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteMobileById",
+    "description": "Delete mobile device",
+    "tags": ["Mobile Device"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Returns the deleted mobile's id",
+        "content": {
+          "application/json": {
+            "example": { "deleted_ids": ["1"] }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/mobiles/mobiles.json

@@ -0,0 +1,62 @@
+{
+  "get": {
+    "operationId": "getMobiles",
+    "description": "List of mobile devices",
+    "tags": ["Mobile Device"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of mobile devices",
+              "type": "array",
+              "items": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" }
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of mobile devices",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" }
+            }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Server error" }
+    }
+  },
+  "post": {
+    "operationId": "createMobile",
+    "description": "Create new mobile device",
+    "tags": ["Mobile Device"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Mobile Device fields to fill",
+      "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/request/post" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/request/post" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object created and returned correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/mobile.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}