solarwinds-itsm-api-definitions 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7ea66292b7c9f3019dedc2b63e45fba1a1517501c3d20213b075440091b2ef1
+  data.tar.gz: 88c5a8e92f0f4539d98b78aa306798401fdbd9f6f1684a0a60b5efa9b30fa5ba
+SHA512:
+  metadata.gz: 2c1bd3454a5d487a990e01608c448ae5b60fa22d138a9c3716809c97bc2c22878427cd504a20edd9a8f4d5dc808b23d472cf51accf5d7c61c3acc744679ed47e
+  data.tar.gz: 68d1aa1a5a8a3fad5f53c16e39cba6c2c44065306c04f67d3aaf001e72cbfb117d77b8252ad8a0c2a4d0dedce77a3c1e0d82a5527437e9737b35de3b00729701

data/lib/definitions/common/components.json

@@ -0,0 +1,34 @@
+{
+  "components": {
+    "parameters": {
+      "token_param": {
+        "name": "X-Samanage-Authorization",
+        "in": "header",
+        "schema": { "type": "string" },
+        "example": "Bearer TOKEN"
+      },
+      "id_param": {
+        "name": "id",
+        "in": "path",
+        "schema": { "oneOf": [{ "type": "string" }, { "type": "integer" }] },
+        "required": true,
+        "description": "Numeric ID of the incident to update"
+      }
+    },
+    "schemas": {
+      "association_by_name": {
+        "type": "object",
+        "oneOf": [{
+          "type": "object",
+          "properties": {
+            "name": { "type": "string", "required": true }
+          }
+        },
+        { "enum": ["nil", "", null] }]
+      },
+      "association_by_id": {
+        "oneOf": [{ "type": "string" }, { "type": "integer" }]
+      }
+    }
+  }
+}

data/lib/definitions/common/sites_and_departments.json

@@ -0,0 +1,6 @@
+{
+  "site": { "$ref": "components.json#/components/schemas/association_by_name" },
+  "site_id": { "$ref": "components.json#/components/schemas/association_by_id" },
+  "department": { "$ref": "components.json#/components/schemas/association_by_name" },
+  "department_id": { "$ref": "components.json#/components/schemas/association_by_id" }
+}

data/lib/definitions/openapi.json

@@ -0,0 +1,20 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "SolarWinds ITSM API",
+    "description": "All SolarWinds ITSM API definitions",
+    "version": "0.0.1",
+    "contact": {
+      "name": "API Support",
+      "url": "samanage.com/support",
+      "email": "support@samanage.com"
+    }
+  },
+  "servers": [
+    { "url": "https://api.samanage.com" },
+    { "url": "https://apieu.samanage.com" }
+  ],
+  "paths": {
+    "$ref": "paths/paths.json"
+  }
+}

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

@@ -0,0 +1,58 @@
+{
+  "/incidents/{id}": {
+    "put": {
+      "operationId": "updateIncidentById",
+      "description": "The update API for incidents in JSON",
+      "parameters": [
+        { "$ref": "../../common/components.json#/components/parameters/token_param" },
+        { "$ref": "../../common/components.json#/components/parameters/id_param" }
+      ],
+      "requestBody": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "incident": {
+                  "type": "object",
+                  "properties": {
+                    "$ref": [
+                      "../../common/sites_and_departments.json"
+                    ],
+                    "description": { "type": "string" },
+                    "state": { "$ref": "../../common/components.json#/components/schemas/association_by_id" },
+                    "assignee": {
+                      "type": "object",
+                      "oneOf": [{
+                        "type": "object",
+                        "properties": {
+                          "email": {
+                            "type": "string",
+                            "required": true
+                          }
+                        }
+                      },
+                      {
+                        "enum": ["nil", "", null]
+                      }]
+                    },
+                    "assignee_id": { "$ref": "../../common/components.json#/components/schemas/association_by_id" }
+                  }
+                }
+              }
+            },
+            "examples": {
+              "0": {
+                "value": "{\"incident\":{\"site\":{\"name\":\"SITE-NAME\"},\"department\":{\"name\":\"DEPARTMENT-NAME\"},\"site_id\":SITE-ID,\"department_id\":DEPARTMENT-ID,\"description\":\"SOMEDESCRIPTION\",\"state\":\"SITE-NAME\",\"assignee\":{\"email\":\"EMAIL\"}}}"
+              }
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": { "description": "Object was updated correctly" },
+        "404": { "description": "Not found" }
+      }
+    }
+  }
+}

data/lib/definitions/paths/paths.json

@@ -0,0 +1,5 @@
+{
+  "$ref": [
+    "content/incidents.json"
+  ]
+}

data/lib/resolved_schema/resolved_schema.json

@@ -0,0 +1 @@
+{"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.0.1","contact":{"name":"API Support","url":"samanage.com/support","email":"support@samanage.com"}},"servers":[{"url":"https://api.samanage.com"},{"url":"https://apieu.samanage.com"}],"paths":{"/incidents/{id}":{"put":{"operationId":"updateIncidentById","description":"The update API for incidents in JSON","parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"oneOf":[{"type":"string"},{"type":"integer"}]},"required":true,"description":"Numeric ID of the incident to update"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"site":{"type":"object","oneOf":[{"type":"object","properties":{"name":{"type":"string","required":true}}},{"enum":["nil","",null]}]},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department":{"type":"object","oneOf":[{"type":"object","properties":{"name":{"type":"string","required":true}}},{"enum":["nil","",null]}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","properties":{"email":{"type":"string","required":true}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}},"examples":{"0":{"value":"{\"incident\":{\"site\":{\"name\":\"SITE-NAME\"},\"department\":{\"name\":\"DEPARTMENT-NAME\"},\"site_id\":SITE-ID,\"department_id\":DEPARTMENT-ID,\"description\":\"SOMEDESCRIPTION\",\"state\":\"SITE-NAME\",\"assignee\":{\"email\":\"EMAIL\"}}}"}}}}},"responses":{"200":{"description":"Object was updated correctly"},"404":{"description":"Not found"}}}}}}

data/lib/solarwinds/itsm/api/definitions.rb

@@ -0,0 +1,57 @@
+require 'json'
+
+module Solarwinds
+  module Itsm
+    module Api
+      module Definitions
+        RESOLVED_DIR = 'lib/resolved_schema'
+
+        def self.base_schema
+          path = 'lib/definitions/openapi.json'
+          JSON.parse(File.open(path).read)
+        end
+
+        def self.resolved_schema
+          recursive_resolve(base_schema, 'lib/definitions')
+        end
+
+        def self.resolved_schema_path
+          File.join(RESOLVED_DIR, 'resolved_schema.json')
+        end
+
+        def self.write_resolved_schema(path = RESOLVED_DIR, name = 'resolved_schema.json')
+          File.write(File.join(path, name), resolved_schema.to_json)
+        end
+
+        private
+
+        def self.recursive_resolve(schema, base_uri)
+          return schema unless schema.is_a?(Array) || schema.is_a?(Hash)
+
+          schema.each_with_object({}) do |(key, value), resolved_schema|
+            if key == '$ref'
+              reference = [*value].each_with_object({}) do |referred_path, result|
+                split_path = referred_path.split('#/')
+                path_to_file = split_path.first
+                path_to_nested_object = split_path.size > 1 ? split_path.last.split('/') : nil
+
+                path_and_file_name = path_to_file.split(/\/(?!.*\/.*)/)
+                new_base_uri = (path_and_file_name.size > 1) ? Pathname.new("#{base_uri}/#{path_and_file_name.first}").cleanpath.to_s : base_uri
+                json = JSON.parse(File.open(File.join(new_base_uri, path_and_file_name.last)).read)
+                internal_object = path_to_nested_object&.inject(json) { |obj, arg| obj[arg] } || json
+                result.merge!(recursive_resolve(internal_object, new_base_uri))
+              end
+              resolved_schema.merge!(reference)
+            elsif value.is_a?(Array)
+              resolved_schema[key] = value.map { |v| recursive_resolve(v, base_uri) }
+            elsif value.is_a?(Hash)
+              resolved_schema[key] = recursive_resolve(value, base_uri)
+            else
+              resolved_schema[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: solarwinds-itsm-api-definitions
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonathan Goldstein
+- Darth Vader
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-26 00:00:00.000000000 Z
+dependencies: []
+description: SolarWinds ITSM OpenAPI definitions gem
+email: jonsgold@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/definitions/common/components.json
+- lib/definitions/common/sites_and_departments.json
+- lib/definitions/openapi.json
+- lib/definitions/paths/content/incidents.json
+- lib/definitions/paths/paths.json
+- lib/resolved_schema/resolved_schema.json
+- lib/solarwinds/itsm/api/definitions.rb
+homepage: https://rubygems.org/gems/solarwinds-itsm-api-definitions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: OpenAPI definitions
+test_files: []