@manyos/smileconnect-api 1.71.1 → 1.71.3

package/docs/_sidebar.md

@@ -28,6 +28,7 @@
 - How-Tos
 
   - [Authentication](howto/token)
+  - [Add additional Adapter](howto/additonalAdapter)
   - [Incident Requests](howto/incidents)
   - [Handle Worklogs](howto/worklogs)
   - [Handle Attachments](howto/attachments)

package/docs/adapter.md

@@ -99,12 +99,35 @@ The query used in the form. e.g. 'Remedy Login ID' = "Allen"
 
 The fields to be returned by the query. e.g. "Full Name, Remedy Login ID, First Name, Last Name, Department"
 
+* options (optional object of additional options):
+
+Currently supported:
+
+* limit: max entries that should be returned. Can be contrained by limit settings of the adapter. (limitMax)
+
+* offset: optional offset to be used together with limit for chunking.  
+
+* sort: an object that describes how the return records should be sorted. Each field can be sorted ascending (1) or descending (-1).
+
+* countOnly: optional boolean. If set to *true* only the count of records will be returned.
+
 Full example:
 ```javascript
+const options = {
+    "limit": 5,
+    "offset": 5,
+    "sort": {
+        "Last Name": 1,
+        "First Name": -1
+    }
+}
+
 const result = await adapter.remedy.search(
     "CTM:People",
     "'Remedy Login ID' = \"Allen\"",
-    "Full Name, Remedy Login ID, First Name, Last Name, Department");
+    "Full Name, Remedy Login ID, First Name, Last Name, Department",
+    options
+);
 ```
 
 Will return an object with a data array and some meta data.
@@ -675,4 +698,4 @@ Returns an object with an array translated sentences. e.g.
         {"detected_source_language":"DE","text":"Good morning. Hope to see you soon! Many greetings, Robert"}
     ]
 }
-```
+```

package/docs/howto/additonalAdapter.md

@@ -0,0 +1,41 @@
+# Add additonal adapter
+
+You can have multiple instances of each adapter. In this guide we'll show you how to add additional remedy adapter.
+
+While the first adapter is automatically deployed when you install SMILEconnect, additional adapters need to be added to the adapter configuration manually.
+
+1. Add a new Block to your [adapter configuration](../adapter.md) (below adapter remedy2 was added).
+
+Configuration example:
+```javascript
+const adapterParams = {
+    remedy: {
+        type: "remedy",
+        arServer: env.AR_SERVER,
+        arUser: env.AR_USER,
+        arPassword: env.AR_PASSWORD,
+        arPort: env.AR_PORT,
+        rapiUri: env.RAPI_URL,
+        cacheTime: env.AR_CACHE_TTL,
+        limitDefault: env.LIMIT_DEFAULT || 100,
+        limitMax: env.LIMIT_MAX
+    },
+    remedy2: {
+        type: "remedy",
+        arServer: env.AR_SERVER2,
+        arUser: env.AR_USER2,
+        arPassword: env.AR_PASSWORD2,
+        arPort: env.AR_PORT2,
+        rapiUri: env.RAPI_URL,
+        cacheTime: env.AR_CACHE_TTL,
+        limitDefault: env.LIMIT_DEFAULT || 100,
+        limitMax: env.LIMIT_MAX
+    }
+};
+// noinspection JSAnnotator
+return adapterParams;
+```
+
+2. Add the needed configuration values (e.g. AR_SERVER2, AR_PASSWORD2, ...) to your API secret.
+
+**Note:** Any change of the Adapter configuration requires a restart / redeployment of SMILEconnect.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.71.1",
+  "version": "1.71.3",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {

package/util/config.js

@@ -561,7 +561,7 @@ async function getPathDef(objectName, baseUri, schema, isSubTicket, suppressUpda
                 summary: `Update an object of type ${objectName}`,
                 description: "A single object is returned in the data attribute",
                 parameters: [],
-                responses: await getApiResponse(schema, false)
+                responses: await getApiResponse(schema, true)
         }
     }