@itentialopensource/adapter-git 0.3.10 → 0.4.1

package/.eslintrc.js

@@ -9,6 +9,7 @@ module.exports = {
     'json'
   ],
   parserOptions: {
+    ecmaVersion: 2020,
     sourceType: 'module'
   },
   rules: {

package/AUTH.md

@@ -1,13 +1,13 @@
 ## Authenticating Git Adapter 
 
-This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
 
 ### User and Password Authentication
 The Git adapter requires user and password for authentiaction.
 
 STEPS  
 1. Ensure you have access to a Git server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.auth``` field
 ```json
 "authentication": {
@@ -19,8 +19,8 @@ STEPS
 
 ### Troubleshooting
 - Make sure you copied over the correct username and password.
-- Turn on debug level logs for the adapter in IAP Admin Essentials.
-- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
+- Turn on auth_logging for the adapter in Itential Platform Admin Essentials (adapter properties).
 - Investigate the logs - in particular:
   - The FULL REQUEST log to make sure the proper headers are being sent with the request.
   - The FULL BODY log to make sure the payload is accurate.

package/ENHANCE.md

@@ -2,7 +2,7 @@
 
 ### Adding a Second Instance of an Adapter
 
-You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the Itential Platform Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
 
 ### Adding Adapter Calls
 
@@ -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://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation 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 Itential Platform, 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
@@ -32,7 +32,7 @@ Files to update
 
 ### Adding Adapter Properties
 
-While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+While changing adapter properties is done in the service instance configuration section of Itential Platform, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
 
 ```text
 Files to update

package/PROPERTIES.md

@@ -1,6 +1,6 @@
 ## Configuration
 
-This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
+This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or Itential Platform are provided in the sampleProperties.
 
 ```json
   {
@@ -82,12 +82,15 @@ This section defines **all** the properties that are available for the adapter,
         "password": "",
       },
       "mongo": {
+        "url": "",
         "host": "",
         "port": 0,
         "database": "",
+        "dbAuth": false,
         "username": "",
         "password": "",
         "replSet": "",
+        "addSrv": false,
         "db_ssl": {
           "enabled": false,
           "accept_invalid_cert": false,
@@ -97,6 +100,7 @@ This section defines **all** the properties that are available for the adapter,
         }
       },
       "devicebroker": {
+        "enabled": false,
         "getDevice": [
           {
             "path": "/call/to/get/device/details",
@@ -214,7 +218,7 @@ These base properties are used to connect to Git upon the adapter initially comi
 </table>
 <br>
 
-A connectivity check tells IAP the adapter has loaded successfully.
+A connectivity check tells Itential Platform the adapter has loaded successfully.
 
 ### Authentication Properties
 
@@ -342,7 +346,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">failover_codes</td>
-    <td style="padding:15px">An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.</td>
+    <td style="padding:15px">An array of error codes for which the adapter will send back a failover flag to Itential Platform so that the Platform can attempt the action in another adapter.</td>
   </tr>
   <tr>
     <td style="padding:15px">attempt_timeout</td>
@@ -374,7 +378,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">return_raw</td>
-    <td style="padding:15px">Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.</td>
+    <td style="padding:15px">Optional. Tells the adapter whether the raw response should be returned as well as the Itential Platform response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.</td>
   </tr>
   <tr>
     <td style="padding:15px">archiving</td>
@@ -520,29 +524,41 @@ The mongo section defines the properties used to connect to a Mongo database. Mo
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">url</td>
+    <td style="padding:15px">Optional. Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.</td>
+  </tr>
   <tr>
     <td style="padding:15px">host</td>
-    <td style="padding:15px">Optional. Host information for the mongo server.</td>
+    <td style="padding:15px">Optional. Host information for the Mongo server.</td>
   </tr>
   <tr>
     <td style="padding:15px">port</td>
-    <td style="padding:15px">Optional. Port information for the mongo server.</td>
+    <td style="padding:15px">Optional. Port information for the Mongo server.</td>
   </tr>
   <tr>
     <td style="padding:15px">database</td>
     <td style="padding:15px">Optional. The database for the adapter to use for its data.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">dbAuth</td>
+    <td style="padding:15px">Optional. Whether to use authentication for MongoDB connection. Default is false.</td>
+  </tr>
   <tr>
     <td style="padding:15px">username</td>
-    <td style="padding:15px">Optional. If credentials are required to access mongo, this is the user to login as.</td>
+    <td style="padding:15px">Optional. If credentials are required to access Mongo, this is the user to login as.</td>
   </tr>
   <tr>
     <td style="padding:15px">password</td>
-    <td style="padding:15px">Optional. If credentials are required to access mongo, this is the password to login with.</td>
+    <td style="padding:15px">Optional. If credentials are required to access Mongo, this is the password to login with.</td>
   </tr>
   <tr>
     <td style="padding:15px">replSet</td>
-    <td style="padding:15px">Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.</td>
+    <td style="padding:15px">Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addSrv</td>
+    <td style="padding:15px">Optional. Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records</td>
   </tr>
   <tr>
     <td style="padding:15px">db_ssl</td>
@@ -580,6 +596,10 @@ The device broker section defines the properties used integrate Git to the devic
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">enabled</td>
+    <td style="padding:15px">Whether or not the device broker calls have been mapped.</td>
+  </tr>
   <tr>
     <td style="padding:15px">getDevice</td>
     <td style="padding:15px">The array of calls used to get device details for the broker</td>
@@ -637,4 +657,4 @@ The device broker section defines the properties used integrate Git to the devic
     <td style="padding:15px">Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.</td>
   </tr>
 </table>
-<br>
+<br>

package/README.md

@@ -1,50 +1,93 @@
-# Git Adapter
+# Adapter for Git 
 
-This adapter is used to perform Git operations without needing to install Git on the machine. It can be used with a variety of Git services, including GitHub, GitLab, and Bitbucket. This ReadMe file is intended to provide information on this adapter.
+## Table of Contents
 
-Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
+Some of the page links in this document and links to other GitLab files do not work in Confluence however, the information is available in other sections of the Confluence material.
 
-For custom built adapters, it is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+- [Specific to this Adapter](#specific-to-this-adapter)
+  - [Authentication](./AUTH.md)
+  - [Sample Properties](./sampleProperties.json)
+  - [Available Calls](./CALLS.md)
+  - [Swagger](./report/adapter-openapi.json)
+- [Generic Adapter Information](#generic-adapter-information)
+  - [Overview](./SUMMARY.md)
+  - [Versioning](#versioning)
+  - [Supported Platform Versions](#supported-platform-versions)
+  - [Getting Started](#getting-started)
+    - [Helpful Background Information](#helpful-background-information)
+    - [Prerequisites](#prerequisites)
+    - [How to Install](#how-to-install)
+    - [Testing](#testing)
+  - [Configuration](./PROPERTIES.md)
+  - [Utilities](./UTILITIES.md)
+  - [Additional Information](#additional-information)
+    - [Enhancements](./ENHANCE.md)
+    - [Contributing](./CONTRIBUTING.md)
+    - [Helpful Links](#helpful-links)
+  - [Troubleshoot](./TROUBLESHOOT.md)
+  - [License and Maintainers](#license-and-maintainers)
+  - [Product License](#product-license)
 
-## Versioning
 
-Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
+## Specific to this Adapter
 
-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 Bitbucket_server works appropriately.
+### [Authentication](./AUTH.md)
 
-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.
+### [Sample Properties](./sampleProperties.json)
 
-## Supported IAP Versions
+<a href="./sampleProperties.json" target="_blank">Sample Properties</a> can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
 
-Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with. 
+### [Available Calls](./CALLS.md)
 
-Itential opensource adapter as well as custom adapters built with the Itential Adapter Builder work acoss many releases of IAP. As a result, it is not often necessary to modify an adapter when upgrading IAP. If IAP has changes that impact the pronghorn.json, like adding a new required section, this will most likely require changes to all adapters when upgrading IAP.
+### [Swagger](./report/adapter-openapi.json)
 
-Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on IAP or the IAP database schema and so it is possible these scripts could stop working in different versions of IAP. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of IAP.
 
-## Getting Started
+## Generic Adapter Information
+
+### [Overview](./SUMMARY.md)
+
+### Versioning
+
+Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the Platform GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
+
+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 Git works appropriately.
+
+Release notes can be viewed in CHANGELOG.md.
+
+### Supported Platform Versions
+
+Itential Product adapters are built for particular versions of Platform and packaged with the versions they work with. 
+
+Itential opensource adapter as well as custom adapters built with the Itential Adapter Builder work acoss many releases of Platform. As a result, it is not often necessary to modify an adapter when upgrading Platform. If Platform has changes that impact the pronghorn.json, like adding a new required section, this will most likely require changes to all adapters when upgrading Platform.
+
+Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on Platform or the Platform database schema and so it is possible these scripts could stop working in different versions of Platform. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of Platform.
+
+### Getting Started
 
 These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
 
-### Helpful Background Information
+#### 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
+Platform 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.
 Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
 
-### Prerequisites
+#### Prerequisites
 
 The following is a list of required packages for installation on the system the adapter will run on:
 
@@ -65,6 +108,18 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">@itentialopensource/adapter-utils</td>
     <td style="padding:15px">Runtime library classes for all adapters;  includes request handling, connection, authentication throttling, and translation.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">ajv</td>
+    <td style="padding:15px">Required for validation of adapter properties to integrate with Git.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">axios</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">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">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>
@@ -77,10 +132,30 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">mocha-param</td>
     <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
   </tr>
+  <tr>
+    <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">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>
   </tr>
+  <tr>
+    <td style="padding:15px">semver</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">winston</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>
 </table>
 <br>
 
@@ -92,86 +167,62 @@ eslint
 eslint-config-airbnb-base
 eslint-plugin-import
 eslint-plugin-json
-package-json-validator
 testdouble
 ```
 
-### Specific Prerequisites
+#### How to Install
 
-At the current time the Git adapter does not utilize the adapter utilities as it makes use of the following library instead.
-
-<table border="1" class="bordered-table">
-  <tr>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Package</span></th>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
-  </tr>
-  <tr>
-    <td style="padding:15px">isomorphic-git</td>
-    <td style="padding:15px">Javascript implementation of Git</td>
-  </tr>
-</table>
-<br>
-
-### How to Install
-
-1. Set up the name space location in your IAP node_modules.
+1a. If you are working on Itential Platform 2023.2 or earlier versions, set up the name space location in your Itential Platform node_modules.
 
 ```bash
 cd /opt/pronghorn/current/node_modules (* could be in a different place)
 if the @itentialopensource directory does not exist, create it:
     mkdir @itentialopensource
+cd @itentialopensource
 ```
 
-2. Clone/unzip/tar the adapter into your IAP environment.
+1b. If you are working on Platform 6, you need to install the adapter in the services directory.
 
 ```bash
-cd \@itentialopensource
-git clone git@gitlab.com:\@itentialopensource/adapters/adapter-git
-or
-unzip adapter-gitr.zip
-or
-tar -xvf adapter-git.tar
+cd /opt/itential/platform/services (* you may have configured it to be in a different place)
 ```
 
-3. Run the adapter install script.
+2. Clone/unzip/tar the adapter into your Platform environment.
 
 ```bash
-cd adapter-git
-npm run adapter:install
-```
-
-4. Restart IAP
-
-```bash
-systemctl restart pronghorn
+git clone git@gitlab.com:@itentialopensource/adapters/adapter-git
+or
+unzip adapter-git.zip
+or
+tar -xvf adapter-git.tar
 ```
 
-5. 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:
-
-3. Install adapter dependencies and check the adapter.
+3. install the adapter dependencies.
 
 ```bash
 cd adapter-git
-npm run install
+npm install
 npm run lint:errors
 npm run test
 ```
 
-4. Restart IAP
+4. Restart Platform
 
 ```bash
 systemctl restart pronghorn
 ```
 
-5. Create an adapter service instance configuration in IAP Admin Essentials GUI
+5. Create an adapter service instance configuration in Platform 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
+7. Change the adapter service instance configuration (host, port, credentials, etc) in Platform Admin Essentials GUI
+
+#### Testing
 
-#### Unit Testing
+Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
+
+##### Unit Testing
 
 Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
 
@@ -179,17 +230,18 @@ Unit Testing includes testing basic adapter functionality as well as error condi
 node utils/testRunner --unit
 
 npm run test:unit
+npm run test:baseunit
 ```
 
 To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-### Integration Testing - Standalone
+##### Integration Testing - Standalone
 
 Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Git. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
 
 Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
 
-```json
+```bash
 node utils/testRunner
   answer no at the first prompt
 
@@ -198,9 +250,9 @@ npm run test:integration
 
 To add new integration tests, edit the `test/integration/adapterTestIntegration.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-### Integration Testing
+##### Integration Testing
 
-Integration Testing requires connectivity to a Git service. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
+Integration Testing requires connectivity to Git. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
 
 > **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with Git. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Git which change order dependencies or required data.
 
@@ -214,11 +266,23 @@ Test should also be written to clean up after themselves. However, it is importa
 
 > **Reminder**: Do not check in code with actual credentials to systems.
 
-## Contributing to Git adapter
+### [Configuration](./PROPERTIES.md)
+
+### [Utilities](./UTILITIES.md)
+
+### Additional Information
+
+#### [Enhancements](./ENHANCE.md)
+
+#### [Contributing](./CONTRIBUTING.md)
+
+#### Helpful Links
+
+<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
-Please check out the [Contributing Guidelines](./CONTRIBUTING.md).
+### [Troubleshoot](./TROUBLESHOOT.md)
 
-## License and Maintainers
+### License and Maintainers
 
 ```text
 Itential Product Adapters are maintained by the Itential Product Team.
@@ -226,6 +290,6 @@ Itential OpenSource Adapters are maintained by the Itential Adapter Team and the
 Custom Adapters are maintained by other sources.
 ```
 
-## Product License
+### Product License
 
 [Apache 2.0](./LICENSE)

package/SUMMARY.md

@@ -1,9 +1,9 @@
 ## Overview
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Git System. The API that was used to build the adapter for Git is usually available in the report directory of this adapter. The adapter utilizes the Git API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+This adapter is used to integrate the Itential Platform with the Git System. The API that was used to build the adapter for Git is usually available in the report directory of this adapter. The adapter utilizes the Git API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 >**Note**: It is possible that some integrations will be supported through the Git adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
 
 Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 
-For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into Itential Platform.

package/SYSTEMINFO.md

@@ -11,7 +11,7 @@ Product Page: https://en.wikipedia.org/wiki/Git
 We classify Git into the CI/CD domain as Git handles the versioning, building, storage and deploying of the system and components.
 
 ## Why Integrate
-The Git adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Git. With this adapter you have the ability to perform operations with Git on items such as:
+The Git adapter from Itential is used to integrate the Itential Platform with Git. With this adapter you have the ability to perform operations with Git on items such as:
 
 - Manage projects and files in a repository
 

package/TAB1.md

@@ -1,9 +1,9 @@
 # Overview 
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Git System. The API that was used to build the adapter for Git is usually available in the report directory of this adapter. The adapter utilizes the Git API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+This adapter is used to integrate the Itential Platform with the Git System. The API that was used to build the adapter for Git is usually available in the report directory of this adapter. The adapter utilizes the Git API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 ## Details 
-The Git adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Git. With this adapter you have the ability to perform operations with Git on items such as:
+The Git adapter from Itential is used to integrate the Itential Platform with Git. With this adapter you have the ability to perform operations with Git on items such as:
 
 - Manage projects and files in a repository
 

package/TAB2.md

@@ -11,14 +11,14 @@
 ## Specific Adapter Information
 ### Authentication
 
-This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Git adapter with User and Password. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
 
 #### User and Password Authentication
 The Git adapter requires user and password for authentiaction.
 
 STEPS  
 1. Ensure you have access to a Git server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.auth``` field
 ```json
 "authentication": {
@@ -30,8 +30,8 @@ STEPS
 
 #### Troubleshooting
 - Make sure you copied over the correct username and password.
-- Turn on debug level logs for the adapter in IAP Admin Essentials.
-- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
+- Turn on auth_logging for the adapter in Itential Platform Admin Essentials (adapter properties).
 - Investigate the logs - in particular:
   - The FULL REQUEST log to make sure the proper headers are being sent with the request.
   - The FULL BODY log to make sure the payload is accurate.
@@ -40,7 +40,7 @@ STEPS
 - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
 ### Sample Properties
 
-Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+Sample Properties can be used to help you configure the adapter in the Itential Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
 
 ```json
   "properties": {

package/TROUBLESHOOT.md

@@ -1,6 +1,6 @@
 ## Troubleshoot
 
-Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
+Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into Itential Platform.
 
 You also have the option to run individual commands to perform specific test: