@itentialopensource/adapter-zscaler 0.7.0 → 0.8.1

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.

package/README.md

@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -31,7 +32,7 @@ Itential Product and opensource adapters utilize SemVer for versioning. The curr
 
 Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Zscaler works appropriately.
 
-Release notes can be viewed in CHANGELOG.md or in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> for Itential adapters.
+Release notes can be viewed in CHANGELOG.md.
 
 ## Supported IAP Versions
 
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.
@@ -96,6 +100,10 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">commander</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">dns-lookup-promise</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
   <tr>
     <td style="padding:15px">fs-extra</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
@@ -112,14 +120,14 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">mongodb</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
   </tr>
-  <tr>
-    <td style="padding:15px">network-diagnostics</td>
-    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
-  </tr>
   <tr>
     <td style="padding:15px">nyc</td>
     <td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">ping</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
   <tr>
     <td style="padding:15px">readline-sync</td>
     <td style="padding:15px">Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality.</td>
@@ -143,7 +151,6 @@ eslint
 eslint-config-airbnb-base
 eslint-plugin-import
 eslint-plugin-json
-package-json-validator
 testdouble
 ```
 
@@ -172,7 +179,9 @@ tar -xvf adapter-zscaler.tar
 
 ```bash
 cd adapter-zscaler
-npm run adapter:install
+npm install
+npm run lint:errors
+npm run test
 ```
 
 4. Restart IAP
@@ -181,17 +190,20 @@ npm run adapter:install
 systemctl restart pronghorn
 ```
 
-5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
+5. Create an adapter service instance configuration in IAP Admin Essentials GUI
+
+6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+
+7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-npm run adapter:install can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If this happens you can replace step 3-5 above with these:
+
+For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
 
 3. Install adapter dependencies and check the adapter.
 
 ```bash
 cd adapter-zscaler
-npm run install
-npm run lint:errors
-npm run test
+npm run adapter:install
 ```
 
 4. Restart IAP
@@ -200,11 +212,8 @@ npm run test
 systemctl restart pronghorn
 ```
 
-5. Create an adapter service instance configuration in IAP Admin Essentials GUI
-
-6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
 ### Testing
 
@@ -268,7 +277,7 @@ Test should also be written to clean up after themselves. However, it is importa
 
 ### Helpful Links
 
-<a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a>
+<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
 ### Node Scripts