solarwinds-itsm-api-definitions 0.1.3 → 0.1.8

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

@@ -1,13 +1,18 @@
 {
   "openapi": "3.0.1",
   "info": {
-    "title": "SolarWinds ITSM API",
-    "description": "All SolarWinds ITSM API definitions",
-    "version": "0.1.3",
+    "title": "SolarWinds Service Desk API",
+    "description":
+      "All SolarWinds Service Desk API definitions\n# General Concepts\n## Service URL\nFor US based customers, please use `https://api.samanage.com`\n\n For European based customers, please use `https://apieu.samanage.com`\n\n## Formats\n\nYou can use XML or JSON format for your request.\n\nXML Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+xml\" -X GET https://api.samanage.com/incidents.xml`\n\nJSON Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" -H \"Content-Type: application/json\" -X GET https://api.samanage.com/incidents.json`\n\nFor create and update, the provided data needs to be in the correct format.\n\nXML Example: `<incident> <field_to_update>content</field_to_update> </incident>`\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"content\"}}`\n\nTo clear fields, use the following format:\n\nXML Example: `<incident> <field_to_update></field_to_update> </incident>`\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"\"}}`\n\n## Authentication\nThe API authentication is token-based. Admins can generate a token directly from the user setup page.  The token is needed by the API developer to gain access to specific items in SolarWinds accessible only via the API. When an admin re-generates their token (via the user setup page), all previously generated tokens become invalid.\n\nThe tokens are relatively long strings that resemble the following: <div style=\"word-wrap: break-word;\"> AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1</div>\n\nIn order to supply the API token you should pass X-Samanage-Authorization header in the following format: “Bearer API_TOKEN_STRING”.\n\nThe API call resembles the following:\n\n`curl -H \"X-Samanage-Authorization: Bearer AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n\nIf the authentication fails, a “401 Unauthorized” message will be returned.\n## Security\nSWSD uses a secured API channel. To connect to the regional API server, use the account admin users’ token information and connect using Token-based authentication. Requests should never be transferred in plain text over the wire. Instead, use SSL version 1.2 or higher (which can be accessed using https://) to ensure that all communication with the server is encrypted and secured.\n\nTo ensure API performance and avoid denial of service, we employ API call limits based per minute as defined by the Service Desk plan of the endpoint user.\n\nPackages:\n\nProfessional Plan - 1000 calls per minute\n\nEnterprise Plan - 1500 calls per minute\n## Versioning\nClients must provide the version number they are ready to work with in the “Accept” HTTP header. A valid \"Accept\" header should specify current content type and version number. For example, “application/vnd.samanage.v2.1+xml”.\n When no “Accept” header is specified, the API will default to version 2.1.\nIf you request an API version that is no longer supported, the API will respond with an HTTP status code of “406 – Not Acceptable”.\n\nExample: \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n## Version History\n* 1.0: Deprecated\n* 1.1: Changed structure of custom_fields_values\n* 1.2: Changed name of “incident_type” to “category” in Catalog items and Incidents\n* 1.3: Updates to incidents or comments will not send an email or a notification to the users. To enable this feature you must add add_callbacks=true to the url.\n* 2.1: Token based authentication\n## Pagination\nEvery response with a large data set will be paginated. The response will include the pagination data as headers and links (formatted as <url>; rel=”relative”). For example:\n\nX-Per-Page: 50\n\nX-Total-Count: 3099\n\nX-Total-Pages: 62\n\nLink: `<https://api.samanage.com/incidents.xml?page=1>`; rel=\"first\",\n\n`<https://api.samanage.com/incidents.xml?page=8>`; rel=\"prev\",\n\n`<https://api.samanage.com/incidents.xml?page=10>`; rel=\"next\",\n\n`<https://api.samanage.com/incidents.xml?page=62>`; rel=\"last\"\n\nYou can request a specific page by providing a “page” parameter. For example, to request the third page of the hardware list, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?page=3`\n\nTo control the number of rows returned, provide the per_page parameter. For example, to request 100 rows with each results page, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?per_page=100`\n## API Entry Point\n All communication with the API begins with a list of available services. Although it is possible to get directly to a specific service URL, we advise you begin with the api.xml entry point. This ensures your program will run seamlessly if changes are made to the underlying URLs for services in future versions of the API.\n\n**Request**\n\nGET api.samanage.com/api.json \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/json\" -X GET https://api.samanage.com/api.json`\n\n**Response**\n\n`[{\"name\":\"Computers List\",\"href\":\"https://api.samanage.com/hardwares.json\"},`\n\n`{\"name\":\"Helpdesk Incidents List\",\"href\":\"https://api.samanage.com/incidents.json\"},`\n\n`{\"name\":\"Changes List\",\"href\":\"https://api.samanage.com/changes.json\"},`\n\n`...]`\n## Short / long layout\nFor all APIs, you can specify the layout (short / long). This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions.\n\nTo use, add the parameter to the request: “?layout=short” or “?layout=long”. If not present, the default is “short”.\n## Searching\nYou can search for records by using query parameters on top of the base URL. For example, when requesting a list of hardwares, you may want to limit them to only those with a specific IP address. This could be accomplished with a request like -\n\n GET api.samanage.com/hardwares.xml?ip_address=123.456*\n\nHere, ip_address is a query parameter that implements a filter where the IP equals 123.456.xxx.xxx.\n\nOther examples: `https://api.samanage.com/other_assets.json?asset_id=XXXXXXXX`, `https://api.samanage.com/hardwares.json?asset_tag=XXXXXXXX`\n## Date formats\nThe following date formats are allowed as input when updating date fields:\n\n* January 21, 2015\n* January 21 2015\n* Jan 21, 2015\n* Jan 21 2015\n* 21/1/2015\n* 2015/1/21\n* 21-1-2015\n* 2015-1-21\n*21.1.2015 \n* 2015.1.21\n## Custom fields\nTo set custom fields, use the following data format:\n\n XML Example:\n\n`<incident><custom_fields_values>`\n\n`<custom_fields_value><name>field name</name><value>content</value></custom_fields_value>`\n\n`</custom_fields_values></incident>`\n\nJSON Example:\n\n`{\"incident\": {\"custom_fields_values\": {\"custom_fields_value\": [{\"name\": \"field name\",\"value\": \"content\"}]}}}`<br><br><hr></hr>",
+    "version": "0.1.8",
+    "x-logo": {
+      "url": "https://tse4.mm.bing.net/th?id=OIP.lhiASqIhZ7Ow90BTOuu5kAHaEH&pid=Api&P=0&w=301&h=168",
+      "href": "https://support.solarwinds.com"
+    },
     "contact": {
       "name": "API Support",
-      "url": "samanage.com/support",
-      "email": "support@samanage.com"
+      "url": "https://support.solarwinds.com",
+      "email": "servicedesksupport@solarwinds.com"
     }
   },
   "servers": [
@@ -17,14 +22,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" }
   ]
 }

data/lib/definitions/paths/attachments/attachments.json

@@ -0,0 +1,12 @@
+{
+  "post": {
+    "operationId": "createAttachment",
+    "description": "Create a new attachment: <p>curl -H 'X-Samanage-Authorization: Bearer TOKEN' <br>-F 'file[attachable_type]=PARENT_OBJECT_TYPE' <br>-F 'file[attachable_id]=PARENT_OBJECT_ID' <br>-F 'file[attachment]=@/PATH/TO/FILE' <br>-H 'Accept: application/vnd.samanage.v1.3+xml' <br>-H 'Content-Type: multipart/form-data' <br>-X POST https://api.samanage.com/attachments.xml/json </p>",
+    "tags": ["Attachment"],
+    "responses": {
+      "200": { "description": "File successfully attached" },
+      "400": { "description": "Bad request" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/audits/audits.json

@@ -0,0 +1,35 @@
+{
+  "get": {
+    "operationId": "getAudits",
+    "description": "List of audits",
+    "tags": ["Audit"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" }
+    ],
+    "responses": {
+      "200": { 
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of audits",
+              "type": "array",
+              "items": { "$ref": "../../common/schemas/analytics/audit.json#/components/schemas/response" }
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of audits",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/analytics/audit.json#/components/schemas/response" }
+            }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Server error" }
+    }
+  }
+}

data/lib/definitions/paths/audits/audits_by_id.json

@@ -0,0 +1,37 @@
+{
+  "get": {
+    "operationId": "getAuditById",
+    "description": "Get audits of a specific object. Example: curl -X GET \"https://api.samanage.com/incidents/1/audits\" -H  \"accept: application/json\" -H  \"X-Samanage-Authorization: Bearer TOKEN\"",
+    "tags": ["Audit"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/object_param" }
+    ],
+    "responses": {
+      "200": {
+        "description": "Object was returned correctly",
+        "content": {
+          "application/json": {
+            "schema": {
+              "description": "List of audits of a specific object",
+              "type": "array",
+              "items": { "$ref": "../../common/schemas/analytics/audit.json#/components/schemas/response" }
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "description": "List of audits of a specific object",
+              "type": "array",
+              "xml": { "name": "/", "wrapped": true },
+              "items": { "$ref": "../../common/schemas/analytics/audit.json#/components/schemas/response" }
+            }
+          }
+        }
+      },
+      "400": { "description": "Bad request" },
+      "404": { "description": "Not found" },
+      "500": { "description": "Internal Server Error" }
+    }
+  }
+}

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" }
+    }
+  }
+}