solarwinds-itsm-api-definitions 0.1.7 → 0.2.1

data/lib/definitions/common/components.json

@@ -70,7 +70,7 @@
         "value_of_custom_field": {
           "anyOf":[
             { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" },
-            { "content": { "application/octet-stream": {} }, "description": "attachment custom field" }
+            { "content": { "application/octet-stream": {} }, "description": "attachment custom field" }, { "nullable": true }
           ]
         },
         "custom_field": {
@@ -79,7 +79,7 @@
           "properties": {
             "name": { "type": "string", "example": "Name of custom text field" },
             "value": { "$ref": "components.json#/components/request/schemas/value_of_custom_field" },
-            "user_value": { "$ref": "components.json#/components/request/schemas/association_by_email" }
+            "user_value": { "anyOf": [{ "$ref": "components.json#/components/request/schemas/association_by_email" }, { "nullable": true }] }
           }
         },
         "custom_fields_value": {
@@ -427,6 +427,11 @@
         },
         "number_or_string": {
           "anyOf": [{ "type": "string", "example": "1" }, { "type": "integer", "example": 1 }]
+        },
+        "string_or_null": {
+          "type": "string",
+          "nullable": true,
+          "example": "string"
         }
       }
     }

data/lib/definitions/common/examples/change_request.json

@@ -0,0 +1,29 @@
+{
+  "examples": {
+    "change_request": {
+      "name": "Change name",
+      "description": "Change description",
+      "change_plan": "Change plan",
+      "test_plan": "Test plan",
+      "rollback_plan": "Rollback plan",
+      "priority": "Low",
+      "change_type": "None",
+      "assignee": { "email": "john.doe@email.com" },
+      "site": { "name":"Site name" },
+      "department": { "name":"Department name" },
+      "request_variables_attributes": [
+        {
+          "name": "Variable name",
+          "value": "Content"
+        },
+        {
+          "name": "User Variable",
+          "user_value": { "email": "john.doe@email.com" }
+        },
+        {
+          "name": "MultyPickList variable",
+          "value": "option1#dlmtr#option2"
+        }
+      ]}
+  }
+}

data/lib/definitions/common/schemas/service_desk/change.json

@@ -27,7 +27,7 @@
       "request_properties": {
         "name": { "type": "string", "example": "Change Name" },
         "change_type": { "type": "integer", "example": 1 },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/change_catalog.json

@@ -27,7 +27,7 @@
       "request_properties": {
         "name": { "type": "string", "example": "Change Name" },
         "change_type": { "type": "integer", "example": 1 },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/change_request.json

@@ -0,0 +1,30 @@
+{
+  "components": {
+    "schemas": {
+      "request": {
+        "type": "object",
+        "xml": { "name": "/" },
+        "properties": {
+          "change_request": {
+            "type": "object",
+            "properties": {
+              "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+              "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
+              "priority": { "type": "string", "example": "High" },
+              "change_plan": { "type": "string", "example": "Change Plan" },
+              "test_plan": { "type": "string", "example": "Test Plan" },
+              "rollback_plan": { "type": "string", "example": "Rollback Plan" },
+              "assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
+              "request_variables_attributes": {
+                "anyOf": [
+                  { "$ref": "../../components.json#/components/request/schemas/variable" },
+                  { "type": "array", "items": { "$ref": "../../components.json#/components/request/schemas/variable" } }
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/definitions/common/schemas/service_desk/comment.json

@@ -26,7 +26,8 @@
       },
       "request_properties": {
         "body": { "type": "string", "example": "Comment body" },
-        "is_private": { "anyOf": [{ "type": "string", "example": "true" }, { "type": "boolean", "example": true }] }
+        "is_private": { "anyOf": [{ "type": "string", "example": "true" }, { "type": "boolean", "example": true }] },
+        "user_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" }
       },
       "response": {
         "type": "object",

data/lib/definitions/common/schemas/service_desk/configuration_item.json

@@ -28,7 +28,7 @@
         "type": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "type_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
         "name": { "type": "string", "example": "CI Name" },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "asset_tag": { "type": "string", "example": "Configuration Item Tag" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
         "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/incident.json

@@ -28,7 +28,7 @@
         "name": { "type": "string", "example": "Incident Name" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
         "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "state_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
         "assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
         "assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/problem.json

@@ -26,7 +26,7 @@
       },
       "request_properties": {
         "name": { "type": "string", "example": "Problem Name" },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/release.json

@@ -26,7 +26,7 @@
       },
       "request_properties": {
         "name": { "type": "string", "example": "Release Name" },
-        "description": { "type": "string", "example": "description" },
+        "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
         "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
         "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },

data/lib/definitions/common/schemas/service_desk/solution.json

@@ -28,7 +28,7 @@
           "name": { "type": "string", "example": "Solution Name" },
           "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
           "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
-          "description": { "type": "string", "example": "description" },
+          "description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
           "state": { "type": "string", "example": "Approved" },
           "category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
           "subcategory": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },

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

@@ -26,7 +26,7 @@
       },
       "request_properties": {
         "name": { "type": "string", "example": "Support" },
-        "description": { "type": "string", "example": "Support Department" }
+        "description": { "anyOf":[{ "type": "string", "example": "Support Department" }, { "nullable": true }] }
       },
       "response": {
         "type": "object",
@@ -45,4 +45,4 @@
       }
     }
   }
-}
+}

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

@@ -27,7 +27,7 @@
       "request_properties": {
         "name": { "type": "string", "example": "Austin TX, USA" },
         "location": { "type": "string", "example": "AUS" },
-        "description": { "type": "string", "example": "Description Austin TX, USA" },
+        "description": { "anyOf":[{ "type": "string", "example": "Description Austin TX, USA" }, { "nullable": true }] },
         "time_zone": { "type": "string", "example": "Texas" },
         "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
         "manager_id": {
@@ -61,4 +61,4 @@
       }
     }
   }
-}
+}

data/lib/definitions/openapi.json

@@ -4,7 +4,7 @@
     "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.7",
+    "version": "0.2.1",
     "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"
@@ -28,6 +28,7 @@
     "/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" },
+    "/change_catalogs/{id}/change_requests": { "$ref": "paths/change_requests/request_by_id.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" },
@@ -91,6 +92,7 @@
     { "name": "Problem", "description": "Problem operations" },
     { "name": "Change", "description": "Change operations" },
     { "name": "Change Catalog", "description": "Change catalog operations" },
+    { "name": "Change Request", "description": "Requesting a change" },
     { "name": "Release", "description": "Release operations" },
     { "name": "Solution", "description": "Solution operations" },
     { "name": "Catalog Item", "description": "Catalog Item operations" },

data/lib/definitions/paths/change_requests/request_by_id.json

@@ -0,0 +1,36 @@
+{
+  "post": {
+    "operationId": "createChangeRequest",
+    "description": "Request a Change",
+    "tags": ["Change Request"],
+    "parameters": [
+      { "$ref": "../../common/components.json#/components/request/parameters/token_param" },
+      { "$ref": "../../common/components.json#/components/request/parameters/id_param" }
+    ],
+    "requestBody": {
+      "description": "Change Request fields to fill",
+      "content": {
+        "application/json": {
+            "schema": { "$ref": "../../common/schemas/service_desk/change_request.json#/components/schemas/request" },
+            "example": { "$ref": "../../common/examples/change_request.json#/examples" }
+        },
+        "application/xml": { "schema": { "$ref": "../../common/schemas/service_desk/change_request.json#/components/schemas/request" } }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Object created and 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": "Server error" }
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds-itsm-api-definitions
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Jonathan Goldstein
@@ -10,20 +10,25 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies: []
 description: SolarWinds ITSM OpenAPI definitions gem
 email:
-- jonsgold@gmail.com
+- jonathan.goldstein@solarwinds.com
 - sagi.gold@solarwinds.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Redocly/development.html
+- Redocly/index.html
+- Redocly/redoc/favicon.ico
+- Redocly/redoc/schema/resolved_schema.json
 - lib/definitions/common/components.json
 - lib/definitions/common/examples/catalog_item.json
 - lib/definitions/common/examples/change.json
 - lib/definitions/common/examples/change_catalog.json
+- lib/definitions/common/examples/change_request.json
 - lib/definitions/common/examples/configuration_item.json
 - lib/definitions/common/examples/hardware.json
 - lib/definitions/common/examples/incident.json
@@ -48,6 +53,7 @@ files:
 - lib/definitions/common/schemas/service_desk/catalog_item.json
 - lib/definitions/common/schemas/service_desk/change.json
 - lib/definitions/common/schemas/service_desk/change_catalog.json
+- lib/definitions/common/schemas/service_desk/change_request.json
 - lib/definitions/common/schemas/service_desk/comment.json
 - lib/definitions/common/schemas/service_desk/configuration_item.json
 - lib/definitions/common/schemas/service_desk/incident.json
@@ -73,6 +79,7 @@ files:
 - lib/definitions/paths/categories/category_by_id.json
 - lib/definitions/paths/change_catalogs/change_catalog_by_id.json
 - lib/definitions/paths/change_catalogs/change_catalogs.json
+- lib/definitions/paths/change_requests/request_by_id.json
 - lib/definitions/paths/changes/change_by_id.json
 - lib/definitions/paths/changes/changes.json
 - lib/definitions/paths/comments/comment_by_id.json
@@ -149,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: OpenAPI definitions