@itentialopensource/adapter-zscaler 0.7.0 → 0.8.0

package/CALLS.md

@@ -165,5 +165,347 @@ Specific adapter calls are built based on the API of the Adapter for Zscaler. Th
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">getAuthenticatedSession(callback)</td>
+    <td style="padding:15px">Checks if there is an authenticated session</td>
+    <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postAuthenticatedSession(credentials, callback)</td>
+    <td style="padding:15px">Creates an authenticated session</td>
+    <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteAuthenticatedSession(callback)</td>
+    <td style="padding:15px">Ends an authenticated session</td>
+    <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditReport(callback)</td>
+    <td style="padding:15px">This endpoint is deprecated, use GET /auditlogEntryReport</td>
+    <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postAuditReport(callback)</td>
+    <td style="padding:15px">This endpoint is deprecated, use POST /auditlogEntryReport</td>
+    <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteAuditReport(callback)</td>
+    <td style="padding:15px">This endpoint is deprecated, use DELETE /auditlogEntryReport</td>
+    <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditReportdownload(callback)</td>
+    <td style="padding:15px">This endpoint is deprecated, use GET /auditlogEntryReport/download</td>
+    <td style="padding:15px">{base_path}/{version}/auditReport/download?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditlogEntryReport(callback)</td>
+    <td style="padding:15px">Gets the status of a request for an audit log report</td>
+    <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postAuditlogEntryReport(request, callback)</td>
+    <td style="padding:15px">Creates an audit log report for the specified time period and saves it as a CSV file</td>
+    <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteAuditlogEntryReport(callback)</td>
+    <td style="padding:15px">Cancels the request to create an audit log report</td>
+    <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditlogEntryReportdownload(callback)</td>
+    <td style="padding:15px">Downloads the most recently created audit log report</td>
+    <td style="padding:15px">{base_path}/{version}/auditlogEntryReport/download?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDepartments(callback)</td>
+    <td style="padding:15px">Gets a list of departments</td>
+    <td style="padding:15px">{base_path}/{version}/departments?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDepartmentsid(id, callback)</td>
+    <td style="padding:15px">Gets the department for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/departments/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getGroups(search, page, pageSize, callback)</td>
+    <td style="padding:15px">Gets a list of groups</td>
+    <td style="padding:15px">{base_path}/{version}/groups?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getGroupsgroupId(groupId, callback)</td>
+    <td style="padding:15px">Gets the group for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/groups/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUsers(name, dept, group, page, pageSize, callback)</td>
+    <td style="padding:15px">Gets a list of all users and allows user filtering by name, department, or group</td>
+    <td style="padding:15px">{base_path}/{version}/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postUsers(user, callback)</td>
+    <td style="padding:15px">Adds a new user</td>
+    <td style="padding:15px">{base_path}/{version}/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postUsersbulkDelete(userIds, callback)</td>
+    <td style="padding:15px">Bulk delete users up to a maximum of 500 users per request</td>
+    <td style="padding:15px">{base_path}/{version}/users/bulkDelete?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUsersuserId(userId, callback)</td>
+    <td style="padding:15px">Gets the user information for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putUsersuserId(userId, user, callback)</td>
+    <td style="padding:15px">Updates the user information for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUsersuserId(userId, callback)</td>
+    <td style="padding:15px">Deletes the user for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecurity(callback)</td>
+    <td style="padding:15px">Gets a list of white-listed URLs</td>
+    <td style="padding:15px">{base_path}/{version}/security?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putSecurity(policy, callback)</td>
+    <td style="padding:15px">Updates the list of white-listed URLs</td>
+    <td style="padding:15px">{base_path}/{version}/security?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSecurityadvanced(callback)</td>
+    <td style="padding:15px">Gets a list of black-listed URLs</td>
+    <td style="padding:15px">{base_path}/{version}/security/advanced?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putSecurityadvanced(advSettings, callback)</td>
+    <td style="padding:15px">Updates the list of black-listed URLs</td>
+    <td style="padding:15px">{base_path}/{version}/security/advanced?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postSecurityadvancedblacklistUrls(action, callback)</td>
+    <td style="padding:15px">Adds a URL to or removes a URL from the black list</td>
+    <td style="padding:15px">{base_path}/{version}/security/advanced/blacklistUrls?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteSslSettingscertchain(callback)</td>
+    <td style="padding:15px">Deletes the intermediate certificate chain</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/certchain?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSslSettingsdownloadcsr(callback)</td>
+    <td style="padding:15px">Downloads a Certificate Signing Request (CSR)</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/downloadcsr?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postSslSettingsgeneratecsr(cert, callback)</td>
+    <td style="padding:15px">Generates a Certificate Signing Request (CSR)</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/generatecsr?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSslSettingsshowcert(callback)</td>
+    <td style="padding:15px">Shows information about the signed intermediate root certificate</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/showcert?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postSslSettingsuploadcerttext(fileInputStream, callback)</td>
+    <td style="padding:15px">Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/uploadcert/text?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postSslSettingsuploadcertchaintext(fileInputStream, callback)</td>
+    <td style="padding:15px">Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain</td>
+    <td style="padding:15px">{base_path}/{version}/sslSettings/uploadcertchain/text?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategories(customOnly, callback)</td>
+    <td style="padding:15px">Gets information about all or custom URL categories</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postUrlCategories(customCategory, callback)</td>
+    <td style="padding:15px">Adds a new custom URL category</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategorieslite(callback)</td>
+    <td style="padding:15px">Gets a lightweight key-value list of all or custom URL categories</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/lite?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategoriesurlQuota(callback)</td>
+    <td style="padding:15px">Gets the URL quota information for your organization</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/urlQuota?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUrlCategoriescategoryId(categoryId, callback)</td>
+    <td style="padding:15px">Gets the URL category information for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putUrlCategoriescategoryId(categoryId, action, customCategory, callback)</td>
+    <td style="padding:15px">Updates the URL category for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUrlCategoriescategoryId(categoryId, callback)</td>
+    <td style="padding:15px">Deletes the custom URL category for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postUrlLookup(urls, callback)</td>
+    <td style="padding:15px">Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']</td>
+    <td style="padding:15px">{base_path}/{version}/urlLookup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getVpnCredentials(search, type, includeOnlyWithoutLocation, locationId, managedBy, page, pageSize, callback)</td>
+    <td style="padding:15px">Gets VPN credentials that can be associated to locations</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postVpnCredentials(vpnCred, callback)</td>
+    <td style="padding:15px">Adds VPN credentials that can be associated to locations</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postVpnCredentialsbulkDelete(ids, callback)</td>
+    <td style="padding:15px">Bulk delete VPN credentials up to a maximum of 100 credentials per request</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials/bulkDelete?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getVpnCredentialsvpnId(vpnId, callback)</td>
+    <td style="padding:15px">Gets the VPN credentials for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putVpnCredentialsvpnId(vpnId, vpnCred, callback)</td>
+    <td style="padding:15px">Updates the VPN credentials for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteVpnCredentialsvpnId(vpnId, callback)</td>
+    <td style="padding:15px">Deletes the VPN credentials for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getLocations(search, sslScanEnabled, xffEnabled, authRequired, bwEnforced, page, pageSize, callback)</td>
+    <td style="padding:15px">Gets information on locations</td>
+    <td style="padding:15px">{base_path}/{version}/locations?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postLocations(location, callback)</td>
+    <td style="padding:15px">Adds a new location</td>
+    <td style="padding:15px">{base_path}/{version}/locations?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postLocationsbulkDelete(LocationIds, callback)</td>
+    <td style="padding:15px">Bulk delete locations up to a maximum of 100 locations per request</td>
+    <td style="padding:15px">{base_path}/{version}/locations/bulkDelete?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getLocationslite(sslScanEnabled, search, page, pageSize, callback)</td>
+    <td style="padding:15px">Gets a lightweight list of locations</td>
+    <td style="padding:15px">{base_path}/{version}/locations/lite?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getLocationslocationId(locationId, callback)</td>
+    <td style="padding:15px">Gets the location information for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putLocationslocationId(locationId, location, callback)</td>
+    <td style="padding:15px">Updates the location information for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteLocationslocationId(locationId, callback)</td>
+    <td style="padding:15px">Deletes the location for the specified ID</td>
+    <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSandboxreportquota(callback)</td>
+    <td style="padding:15px">Gets the Sandbox Report API quota information for your organization</td>
+    <td style="padding:15px">{base_path}/{version}/sandbox/report/quota?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSandboxreportmd5Hash(md5Hash, details, callback)</td>
+    <td style="padding:15px">Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox</td>
+    <td style="padding:15px">{base_path}/{version}/sandbox/report/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getStatus(callback)</td>
+    <td style="padding:15px">Gets the activation status for a configuration change</td>
+    <td style="padding:15px">{base_path}/{version}/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postStatusactivate(callback)</td>
+    <td style="padding:15px">Activates configuration changes</td>
+    <td style="padding:15px">{base_path}/{version}/status/activate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
 </table>
 <br>

package/CHANGELOG.md

@@ -1,118 +1,9 @@
 
-## 0.7.0 [05-24-2022]
+## 0.8.0 [12-27-2023]
 
-* Migration to the latest Adapter Foundation
+* Adapter Engine has been updated and the changes are being migrated to the adapter
 
-See merge request itentialopensource/adapters/security/adapter-zscaler!13
+See merge request itentialopensource/adapters/security/adapter-zscaler!22
 
 ---
 
-## 0.6.7 [01-19-2022]
-
-- Changed the health check url to be a url that exists in zscaler
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!12
-
----
-
-## 0.6.6 [11-17-2021]
-
-- Fix lint errors after updating adapter.js and pronghorn.json
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!10
-
----
-
-## 0.6.5 [11-02-2021]
-
-- This added the updated "getObfuscatedKey" auth to all empty body payloads and updated the calls to allow every call to be properly wrapped in a session.
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!8
-
----
-
-## 0.6.4 [10-25-2021]
-
-- Changes to still support both Basic Auth and Obfuscated ApiKey Auth
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!7
-
----
-
-## 0.6.3 [03-16-2021]
-
-- Migration to bring up to the latest foundation
-  - Change to .eslintignore (adapter_modification directory)
-  - Change to README.md (new properties, new scripts, new processes)
-  - Changes to adapterBase.js (new methods)
-  - Changes to package.json (new scripts, dependencies)
-  - Changes to propertiesSchema.json (new properties and changes to existing)
-  - Changes to the Unit test
-  - Adding several test files, utils files and .generic entity
-  - Fix order of scripts and dependencies in package.json
-  - Fix order of properties in propertiesSchema.json
-  - Update sampleProperties, unit and integration tests to have all new properties.
-  - Add all new calls to adapter.js and pronghorn.json
-  - Add suspend piece to older methods
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!6
-
----
-
-## 0.6.2 [07-09-2020]
-
-- Update to the latest adapter foundation
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!5
-
----
-
-## 0.6.1 [01-15-2020]
-
-- Update the adapter to the latest foundation
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!4
-
----
-
-## 0.6.0 [11-08-2019]
-
-- Update the adapter to the latest adapter foundation.
-  - Updating to adapter-utils 4.24.3 (automatic)
-  - Add sample token schemas (manual)
-  - Adding placement property to getToken response schema (manual - before encrypt)
-  - Adding sso default into action.json for getToken (manual - before response object)
-  - Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
-  - Update sample properties to include new properties (manual)
-  - Update integration test for raw mockdata (automatic)
-  - Update test properties (manual)
-  - Changes to artifactize (automatic)
-  - Update type in sampleProperties so it is correct for the adapter (manual)
-  - Update the readme (automatic)
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!3
-
----
-
-## 0.5.0 [09-17-2019] & 0.4.0 [09-14-2019]
-
-- Update the adapter to the latest adapter foundation
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!2
-
----
-## 0.3.0 [07-30-2019] & 0.2.0 [07-16-2019]
-
-- Migrate the adapter to the latest foundation, categorize it and make it available to app artifact
-
-See merge request itentialopensource/adapters/security/adapter-zscaler!1
-
----
-
-## 0.1.1 [04-25-2019]
-
-- Initial Commit
-
-See commit 08e8fb0
-
----

package/CONTRIBUTING.md

@@ -10,163 +10,4 @@ This project and everyone participating in it is governed by the Code of Conduct
 
 ## How to Contribute
 
-### Reporting Bugs
-
-This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :left_right_arrow: :computer:, and find related reports :mag_right:.
-
-Before creating bug reports, please check before-submitting-a-bug-report, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you have an Itential support contract, please create an Itential Service Desk ticket. If you don't have an Itential support contract, please send an email of the issue to support@itential.com.
-
-#### Before Submitting A Bug Report
-
-* **Check the README.md.** You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem __in the latest version__.
-* **Work through the troubleshooting process.** Troubleshooting will include changing the log level of Itential Automation Platform (IAP) and adapters and checking the logs to see what the issues are. These logs should be included in any ticket you open for this issue.
-* **Check for resolutions to the issue.** Check the <a href="https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921" target="_blank">Itential Knowledge Base</a> to see if there is a known resolution for the issue you are having.
-* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
-
-#### How to Submit a (Good) Bug Report
-
-Bugs are tracked through the Itential Service Desk. Explain the problem and include additional details to help maintainers reproduce the problem:
-
-- **Use a clear and descriptive title** for the issue to identify the problem.
-- **Describe the exact steps which reproduce the problem** in as much detail as possible. For example, start by explaining how you configured the adapter (e.g., which properties you used and how they were set) or how you are using an artifact.
-- **Provide specific examples to demonstrate the steps**. Include logs, or copy/paste snippets, in your examples.
-- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
-- **Explain which behavior you expected to see instead and why.**
-- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/" target="_blank">this tool</a> to record GIFs on macOS and Windows. Use <a href="https://github.com/colinkeenan/silentcast" target="_blank">this tool</a> or <a href="https://github.com/rhcarvalho/byzanz-guiz" target="_blank">program</a> on Linux.
-- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
-
-Provide more context by answering these questions:
-
-- **Did the problem start happening recently** (e.g. after updating to a new version/tag) or was this always a problem?
-- If the problem started happening recently, **can you reproduce the problem in an older version/tag?** What's the most recent version in which the problem does not happen?
-- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
-
-Include details about your configuration and environment:
-
-- **Which version of the adapter/artifact are you using?** You can get the exact version by checking the project version in the package.json file.
-- **What's the name and version of the OS you're using**?
-- **Are you running or using IAP in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and guest?
-- **Are there firewalls between IAP and any other system you are integrating with?** If so, have you tried running curl from the system IAP is on to the other system to verify you have connectivity between the systems?
-
-### Your First Code Contribution
-
-#### Local development
-
-This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the README.md. The README.mdprovides many more details on cloning the repository for local development, how to lint and test your changes. 
-
-#### Development Process
-
-The following provides a local copy of the repository along with dependencies.
-
-```json
-go to the repository you are interested in working on
-click on the Clone button to get the link(s) you can use to clone the repository
-git clone <link to clone the project>
-npm install
-```
-
-Prior to making changes you should create a branch to work in. The branch should be named with the type of change (major, minor or patch) and then a Jira issue number or a description of the issue.
-
-```json
-git checkout -b <name_of_your_new_branch>
-```
-
-Make all of the desired changes.
-
-> **Note:** All code changes should be accompanied by additional Unit and Integration tests to minimize the likelihood that any changes will negatively impact the adapter/artifact as well as to ensure the desired functionality is achieved.
-
-
-<table border="1" class="bordered-table">
-  <tr>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Files</span></th>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Changes</span></th>
-  </tr>
-  <tr>
-    <td style="padding:15px">.codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore</td>
-    <td style="padding:15px">These are foundational files that are used in linting and building of the adapter. Changes to these files are heavily scrutinized and may be implemented in a different manner so that the changes can be implemented across all adapters.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md</td>
-    <td style="padding:15px">These are license and process files for the repository. Changes to these files may require legal review and may also be implemented in a different manner so that the changes can be implemented across all adapters.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">utils/*, adapterBase.js</td>
-    <td style="padding:15px">Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">adapter.js</td>
-    <td style="padding:15px">Changes to this file are code changes. They should be accompanied by the appropriate unit and integration tests. If new methods are added, they should also be added to the pronghorn.json file, otherwise integration tests are likely to fail.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">error.json, propertiesSchema.json</td>
-    <td style="padding:15px">These files are utilized by the Itential Runtime libraries. You can make changes to these files, but the changes should be appending of new errors or properties. Removal of errors and properties can result in rejection of the changes.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">pacakge.json, package-lock.json</td>
-    <td style="padding:15px">The package-lock.json is automatically generated and should only be updated when the dependencies inside of the package.json are modified. You can make changes to the package.json to add additional scripts, add new dependencies, modify names, etc. However, changing the scripts or dependencies that are Itential specific will be overriden during the acceptance process.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">pronghorn.json</td>
-    <td style="padding:15px">Changes to this file are made for integration into IAP. The most common change here is adding new methods that shoud be exposed to the IAP Workflow.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">entities/*</td>
-    <td style="padding:15px">Changes to these files include adding new capabilities, updating existing capabilities, or removing deprecated capabilities in the adapter. Translation configuration can also be modified here.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">test/*</td>
-    <td style="padding:15px">Changes to these files include adding, updating, or removing unit and integration tests in the adapter. Tests should never be removed unless the methods that are being tested are removed also. Both the unit and integration test file should have a marker that identifies where modification can take place. Modifications above that marker are likely to be rejected or implemented in a different manner.</td>
-  </tr>
-</table>
-<br>
-
-> **Note:** It is a best practice to lint and test your code prior to committing changes into the repository. You can lint your code by running **npm run lint** and test it by running **node utils/testRunner.sh**. However, there are pre-commit hooks that will run these scripts when you commit your changes.
-
-Commit the changes to the repository.
-
-```json
-git commit -a -m "<descriptive message>" 
-```
-
-> **Note:** There are pre-commit hooks in place. If the pre-commit hooks fail, you will need to address those issues before moving forward.
-
-Push the changes into the repository. This should only be done after the commit has successfully completed.
-
-```json
-git push origin <name_of_your_new_branch>
-```
-
-Create a Merge Request.
-
-### Merge Requests
-
-- Fill out the provided merge request template.
-- Reference related issues and merge requests liberally.
-- Include screenshots and animated GIFs in your merge request whenever possible.
-- Follow the project Styleguide.
-- End all files with a newline.
-
-## Styleguide
-
-### Git Commit Messages
-
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Consider starting the commit message with an applicable emoji _(not required)_:
-  - :art: `:art:` When improving the format/structure of the code.
-  - :racehorse: `:racehorse:` When improving performance
-  - :non-potable_water: `:non-potable_water:` When plugging memory leaks.
-  - :memo: `:memo:` When writing documentation.
-  - :penguin: `:penguin:` When fixing something on Linux.
-  - :apple: `:apple:` When fixing something on macOS.
-  - :checkered_flag: `:checkered_flag:` When fixing something on Windows.
-  - :bug: `:bug:` When fixing a bug.
-  - :fire: `:fire:` When removing code or files.
-  - :green_heart: `:green_heart:` When fixing the CI build.
-  - :white_check_mark: `:white_check_mark:` When adding tests,
-  - :lock: `:lock:` When dealing with security.
-  - :arrow_up: `:arrow_up:` When upgrading dependencies.
-  - :arrow_down: `:arrow_down:` When downgrading dependencies.
-  - :shirt: `:shirt:` When removing linter warnings.
-
-__Avoid installing unnecessary packages.__ Do not install packages just because they might be "nice to have". Itential Opensource projects are supposed to be minimal, specific, and compact by design.
+Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

package/ENHANCE.md

@@ -18,7 +18,7 @@ npm run adapter:update
 
 If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
 
-If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
 
 ```text
 Files to update
@@ -66,4 +66,4 @@ Files to update
 * test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
 ```
 
-As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
+As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.