solarwinds-itsm-api-definitions 0.1.1 → 0.1.6

data/lib/definitions/paths/catalog_items/catalog_item_by_id.json

@@ -0,0 +1,83 @@
+{
+    "get": {
+      "operationId": "getCatalogItemById",
+      "description": "Get catalog item",
+      "tags": ["Catalog Item"],
+      "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/service_desk/catalog_item.json#/components/schemas/response" },
+              "example": { "$ref": "../../common/examples/catalog_item.json#/examples/response/json" }
+            },
+            "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" } }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Internal Server Error" }
+      }
+    },
+    "put": {
+      "operationId": "updateCatalogItemById",
+      "description": "Update catalog item with specified fields",
+      "tags": ["Catalog Item"],
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+        { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+      ],
+      "requestBody": {
+        "required": true,
+        "description": "Catalog item fields to update",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/request/put" },
+            "example": { "$ref": "../../common/examples/catalog_item.json#/examples/request/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/request/put" } }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Object was updated correctly",
+          "content": {
+            "application/json": {
+              "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" },
+              "example": { "$ref": "../../common/examples/catalog_item.json#/examples/response/json" }
+            },
+            "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" } }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Internal Server Error" }
+      }
+    },
+    "delete": {
+      "operationId": "deleteCatalogItemById",
+      "description": "Delete catalog item",
+      "tags": ["Catalog Item"],
+      "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 catalog item'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/catalog_items/catalog_items.json

@@ -0,0 +1,69 @@
+{
+    "get": {
+      "operationId": "getCatalogItems",
+      "description": "List of catalog items",
+      "tags": ["Catalog Item"],
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+      ],
+      "responses": {
+        "200": {
+          "description": "Object was returned correctly",
+          "content": {
+            "application/json": {
+              "schema": {
+                "description": "List of catalog items",
+                "type": "array",
+                "items": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" }
+              },
+              "example": [{ "$ref": "../../common/examples/catalog_item.json#/examples/response/json" }]
+            },
+            "application/xml": {
+              "schema": {
+                "description": "List of catalog items",
+                "type": "array",
+                "xml": { "name": "/", "wrapped": true },
+                "items": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" }
+              }
+            }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Server error" }
+      }
+    },
+    "post": {
+      "operationId": "createCatalogItem",
+      "description": "Create new catalog item",
+      "tags": ["Catalog Item"],
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+      ],
+      "requestBody": {
+        "required": true,
+        "description": "Catalog Item fields to fill",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/request/post" },
+            "example": { "$ref": "../../common/examples/catalog_item.json#/examples/request/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/request/post" } }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Object created and returned correctly",
+          "content": {
+            "application/json": {
+              "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" },
+              "example": { "$ref": "../../common/examples/catalog_item.json#/examples/response/json" }
+            },
+            "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/catalog_item.json#/components/schemas/response" } }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "500": { "description": "Server error" }
+      }
+    }
+  }

data/lib/definitions/paths/categories/categories.json

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

data/lib/definitions/paths/categories/category_by_id.json

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

data/lib/definitions/paths/change_catalogs/change_catalog_by_id.json

@@ -0,0 +1,83 @@
+{
+  "get": {
+    "operationId": "getChangeCatalogById",
+    "description": "Get change catalog",
+    "tags": ["Change Catalog"],
+    "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/service_desk/change_catalog.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/change_catalog.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "put": {
+    "operationId": "updateChangeCatalogById",
+    "description": "Update change catalog with specified fields",
+    "tags": ["Change Catalog"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Change catalog fields to update",
+      "content": {
+        "application/json": {
+          "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/request/put" },
+          "example": { "$ref": "../../common/examples/change_catalog.json#/examples/request/json" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/request/put" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object was updated correctly",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/change_catalog.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  },
+  "delete": {
+    "operationId": "deleteChangeCatalogById",
+    "description": "Delete change catalog",
+    "tags": ["Change Catalog"],
+    "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 change catalog'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/change_catalogs/change_catalogs.json

@@ -0,0 +1,69 @@
+{
+  "get": {
+    "operationId": "getChangeCatalogs",
+    "description": "List of change catalogs",
+    "tags": ["Change Catalog"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of change catalogs",
+              "type": "array",
+              "items": { "allOf": [{ "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" }] }
+            },
+            "example": [{ "$ref": "../../common/examples/change_catalog.json#/examples/response/json" }]
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of change catalogs",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" }
+            }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Server error" }
+    }
+  },
+  "post": {
+    "operationId": "createChangeCatalog",
+    "description": "Create new change catalog",
+    "tags": ["Change Catalog"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+    ],
+    "requestBody": {
+      "required": true,
+      "description": "Change catalog fields to fill",
+      "content": {
+        "application/json": {
+          "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/request/post" },
+          "example": { "$ref": "../../common/examples/change_catalog.json#/examples/request/json" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/request/post" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object created and returned correctly",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" },
+            "example": { "$ref": "../../common/examples/change_catalog.json#/examples/response/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_catalog.json#/components/schemas/response" } }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/changes/change_by_id.json

@@ -0,0 +1,83 @@
+{
+    "get": {
+      "operationId": "getChangeById",
+      "description": "Get change",
+      "tags": ["Change"],
+      "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/service_desk/change.json#/components/schemas/response" },
+              "example": { "$ref": "../../common/examples/change.json#/examples/response/json" }
+            },
+            "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change.json#/components/schemas/response" } }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Internal Server Error" }
+      }
+    },
+    "put": {
+      "operationId": "updateChangeById",
+      "description": "Update change with specified fields",
+      "tags": ["Change"],
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+        { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+      ],
+      "requestBody": {
+        "required": true,
+        "description": "Change fields to update",
+        "content": {
+          "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/change.json#/components/schemas/request/put" },
+            "example": { "$ref": "../../common/examples/change.json#/examples/request/json" }
+          },
+          "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change.json#/components/schemas/request/put" } }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Object was updated correctly",
+          "content": {
+            "application/json": {
+              "schema": { "$ref": "../../common/schemas/service_desk/change.json#/components/schemas/response" },
+              "example": { "$ref": "../../common/examples/change.json#/examples/response/json" }
+            },
+            "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change.json#/components/schemas/response" } }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Internal Server Error" }
+      }
+    },
+    "delete": {
+      "operationId": "deleteChangeById",
+      "description": "Delete change",
+      "tags": ["Change"],
+      "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 change's id",
+          "content": {
+            "application/json": {
+              "example": { "deleted_ids": ["1"] }
+            }
+          }
+        },
+        "400": { "description": "Bad request" },
+        "404": { "description": "Not found" },
+        "500": { "description": "Internal Server Error" }
+      }
+    }
+  }