solarwinds-itsm-api-definitions 0.1.1 → 0.1.6

data/lib/definitions/paths/contracts/contracts.json

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

data/lib/definitions/paths/contracts/item_by_id.json

@@ -0,0 +1,75 @@
+{
+  "put": {
+    "operationId": "updateItemById",
+    "description": "Update contract's item with specified fields",
+    "tags": ["Contract"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      {
+        "name": "contract_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the contract"
+      },
+      {
+        "name": "item_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the item"
+      }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Contract's Item fields to update",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/request/put" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteitemById",
+    "description": "Delete contract's item",
+    "tags": ["Contract"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      {
+        "name": "contract_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the contract"
+      },
+      {
+        "name": "item_id",
+        "in": "path",
+        "schema": { "type": "string" },
+        "required": true,
+        "description": "Numeric ID of the item"
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Message regarding a successful operation",
+        "content": { "application/json": { "example": { "messages": { "message": "Deleted item" } } } }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/contracts/items.json

@@ -0,0 +1,30 @@
+{
+  "post": {
+    "operationId": "createItem",
+    "description": "Create new contract's Item",
+    "tags": ["Contract"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Item fields to fill",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/request/post" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/request/post" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object created and returned correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/procurement/item.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/departments/department_by_id.json

@@ -0,0 +1,70 @@
+{
+  "get": {
+    "operationId": "getDepartmentById",
+    "description": "Get department",
+    "tags": ["Department"],
+    "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/setup/department.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/setup/department.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "put": {
+    "operationId": "updateDepartmentById",
+    "description": "Update department with specified fields",
+    "tags": ["Department"],
+    "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+        { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+      ],
+    "requestBody": {
+      "required": true,
+      "description": "Department fields to update",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/setup/department.json#/components/schemas/request/put" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/setup/department.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/setup/department.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/setup/department.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteDepartmentById",
+    "description": "Delete department",
+    "tags": ["Department"],
+    "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 department" } } } }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/departments/departments.json

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

data/lib/definitions/paths/groups/group_by_id.json

@@ -0,0 +1,70 @@
+{
+  "get": {
+    "operationId": "getGroupById",
+    "description": "Get group",
+    "tags": ["Group"],
+    "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/setup/group.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/setup/group.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "put": {
+      "operationId": "updateGroupById",
+      "description": "Update group with specified fields",
+      "tags": ["Group"],
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+        { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+      ],
+      "requestBody": {
+      "required": true,
+      "description": "Group fields to update",
+      "content": {
+        "application/json": { "schema": { "$ref": "../../common/schemas/setup/group.json#/components/schemas/request/put" } },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/setup/group.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": { "schema": { "$ref": "../../common/schemas/setup/group.json#/components/schemas/response" } },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/setup/group.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteGroupById",
+    "description": "Delete group",
+    "tags": ["Group"],
+    "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 group" } } } }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

data/lib/definitions/paths/groups/groups.json

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

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

@@ -0,0 +1,83 @@
+{
+  "get": {
+    "operationId": "getHardwareById",
+    "description": "Get hardware",
+    "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": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/hardware.json#/examples/response" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "put": {
+    "operationId": "updateHardwareById",
+    "description": "Update hardware with specified fields",
+    "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": "Hardware fields to update",
+      "content": {
+        "application/json": {
+          "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/request/put" },
+          "example": { "$ref": "../../common/examples/hardware.json#/examples/request" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/hardware.json#/examples/response" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/inventory/hardware.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteHardwareById",
+    "description": "Delete hardware",
+    "tags": ["Hardware"],
+    "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 hardware's id",
+        "content": {
+          "application/json": {
+            "example": { "deleted_ids": ["1"] }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}