@itentialopensource/adapter-ciena_mcp 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.0 [11-10-2023]
+
+* Adapter Engine has been updated and the changes are being migrated to the adapter
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-ciena_mcp!3
+
+---
+
+## 0.3.3 [07-27-2022]
+
+* Change schemas to escape . so that objectization is not done
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-ciena_mcp!2
+
+---
+
 ## 0.3.2 [06-03-2022]
 
 * Fix Datatype on token

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.

package/PROPERTIES.md

@@ -164,7 +164,7 @@ This section defines **all** the properties that are available for the adapter,
 
 ### Connection Properties
 
-These base properties are used to connect to Ciena MCP upon the adapter initially coming up. It is important to set these properties appropriately.
+These base properties are used to connect to CienaMcp upon the adapter initially coming up. It is important to set these properties appropriately.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -205,7 +205,7 @@ These base properties are used to connect to Ciena MCP upon the adapter initiall
   </tr>
   <tr>
     <td style="padding:15px">stub</td>
-    <td style="padding:15px">Optional. Indicates whether the stub should run instead of making calls to Ciena MCP (very useful during basic testing). Default is false (which means connect to Ciena MCP).</td>
+    <td style="padding:15px">Optional. Indicates whether the stub should run instead of making calls to CienaMcp (very useful during basic testing). Default is false (which means connect to CienaMcp).</td>
   </tr>
   <tr>
     <td style="padding:15px">protocol</td>
@@ -218,9 +218,9 @@ A connectivity check tells IAP the adapter has loaded successfully.
 
 ### Authentication Properties
 
-The following properties are used to define the authentication process to Ciena MCP.
+The following properties are used to define the authentication process to CienaMcp.
 
->**Note**: Depending on the method that is used to authenticate with Ciena MCP, you may not need to set all of the authentication properties.
+>**Note**: Depending on the method that is used to authenticate with CienaMcp, you may not need to set all of the authentication properties.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -233,11 +233,11 @@ The following properties are used to define the authentication process to Ciena
   </tr>
   <tr>
     <td style="padding:15px">username</td>
-    <td style="padding:15px">Used to authenticate with Ciena MCP on every request or when pulling a token that will be used in subsequent requests.</td>
+    <td style="padding:15px">Used to authenticate with CienaMcp on every request or when pulling a token that will be used in subsequent requests.</td>
   </tr>
   <tr>
     <td style="padding:15px">password</td>
-    <td style="padding:15px">Used to authenticate with Ciena MCP on every request or when pulling a token that will be used in subsequent requests.</td>
+    <td style="padding:15px">Used to authenticate with CienaMcp on every request or when pulling a token that will be used in subsequent requests.</td>
   </tr>
   <tr>
     <td style="padding:15px">token</td>
@@ -249,7 +249,7 @@ The following properties are used to define the authentication process to Ciena
   </tr>
   <tr>
     <td style="padding:15px">token_timeout</td>
-    <td style="padding:15px">Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Ciena MCP. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.</td>
+    <td style="padding:15px">Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to CienaMcp. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.</td>
   </tr>
   <tr>
     <td style="padding:15px">token_cache</td>
@@ -293,11 +293,11 @@ The following properties are used to define the authentication process to Ciena
 
 ### Healthcheck Properties
 
-The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Ciena MCP. There are currently three types of healthchecks.
+The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach CienaMcp. There are currently three types of healthchecks.
 
-- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Ciena MCP.
+- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach CienaMcp.
 - Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
-- Intermittent - Adapter will check connectivity to Ciena MCP at a frequency defined in the `frequency` property.
+- Intermittent - Adapter will check connectivity to CienaMcp at a frequency defined in the `frequency` property.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -346,7 +346,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">attempt_timeout</td>
-    <td style="padding:15px">Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Ciena MCP, and then will re-attempt the request that aborted. Default is 5000 milliseconds.</td>
+    <td style="padding:15px">Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to CienaMcp, and then will re-attempt the request that aborted. Default is 5000 milliseconds.</td>
   </tr>
   <tr>
     <td style="padding:15px">global_request</td>
@@ -378,7 +378,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">archiving</td>
-    <td style="padding:15px">Optional flag. Default is false. It archives the request, the results and the various times (wait time, Ciena MCP time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.</td>
+    <td style="padding:15px">Optional flag. Default is false. It archives the request, the results and the various times (wait time, CienaMcp time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.</td>
   </tr>
   <tr>
     <td style="padding:15px">return_request</td>
@@ -389,7 +389,7 @@ The request section defines properties to help handle requests.
 
 ### SSL Properties
 
-The SSL section defines the properties utilized for ssl authentication with Ciena MCP. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
+The SSL section defines the properties utilized for ssl authentication with CienaMcp. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -433,7 +433,7 @@ The SSL section defines the properties utilized for ssl authentication with Cien
 
 ### Throttle Properties
 
-The throttle section is used when requests to Ciena MCP must be queued (throttled). All of the properties in this section are optional.
+The throttle section is used when requests to CienaMcp must be queued (throttled). All of the properties in this section are optional.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -458,7 +458,7 @@ The throttle section is used when requests to Ciena MCP must be queued (throttle
   </tr>
   <tr>
     <td style="padding:15px">concurrent_max</td>
-    <td style="padding:15px">Defines the number of requests the adapter can send to Ciena MCP at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Ciena MCP in a serial manner.</td>
+    <td style="padding:15px">Defines the number of requests the adapter can send to CienaMcp at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to CienaMcp in a serial manner.</td>
   </tr>
   <tr>
     <td style="padding:15px">expire_timeout</td>
@@ -466,7 +466,7 @@ The throttle section is used when requests to Ciena MCP must be queued (throttle
   </tr>
   <tr>
     <td style="padding:15px">average_runtime</td>
-    <td style="padding:15px">Represents the approximate average of how long it takes Ciena MCP to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Ciena MCP performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.</td>
+    <td style="padding:15px">Represents the approximate average of how long it takes CienaMcp to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when CienaMcp performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.</td>
   </tr>
   <tr>
     <td style="padding:15px">priorities</td>
@@ -477,7 +477,7 @@ The throttle section is used when requests to Ciena MCP must be queued (throttle
 
 ### Proxy Properties
 
-The proxy section defines the properties to utilize when Ciena MCP is behind a proxy server.
+The proxy section defines the properties to utilize when CienaMcp is behind a proxy server.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -486,7 +486,7 @@ The proxy section defines the properties to utilize when Ciena MCP is behind a p
   </tr>
   <tr>
     <td style="padding:15px">enabled</td>
-    <td style="padding:15px">Required. Default is false. If Ciena MCP is behind a proxy server, set enabled flag to true.</td>
+    <td style="padding:15px">Required. Default is false. If CienaMcp is behind a proxy server, set enabled flag to true.</td>
   </tr>
   <tr>
     <td style="padding:15px">host</td>
@@ -573,7 +573,7 @@ The mongo section defines the properties used to connect to a Mongo database. Mo
 
 ### Device Broker Properties
 
-The device broker section defines the properties used integrate Ciena MCP to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
+The device broker section defines the properties used integrate CienaMcp to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
 
 <table border="1" class="bordered-table">
   <tr>

package/README.md

@@ -1,4 +1,4 @@
-# Adapter for Ciena MCP 
+# Adapter for CienaMcp 
 
 ## Table of Contents
 
@@ -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)
@@ -29,9 +30,9 @@ Some of the page links in this document and links to other GitLab files do not w
 
 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>.
 
-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 Ciena MCP works appropriately.
+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 CienaMcp 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.
@@ -86,7 +90,7 @@ The following list of packages are required for Itential opensource adapters or
   </tr>
   <tr>
     <td style="padding:15px">ajv</td>
-    <td style="padding:15px">Required for validation of adapter properties to integrate with Ciena MCP.</td>
+    <td style="padding:15px">Required for validation of adapter properties to integrate with CienaMcp.</td>
   </tr>
   <tr>
     <td style="padding:15px">axios</td>
@@ -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-ciena_mcp.tar
 
 ```bash
 cd adapter-ciena_mcp
-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-ciena_mcp
-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
 
@@ -225,7 +234,7 @@ To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests t
 
 #### 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 Ciena MCP. 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.
+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 CienaMcp. 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.
 
@@ -240,9 +249,9 @@ To add new integration tests, edit the `test/integration/adapterTestIntegration.
 
 #### Integration Testing
 
-Integration Testing requires connectivity to Ciena MCP. 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 CienaMcp. 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 Ciena MCP. 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 Ciena MCP which change order dependencies or required data.
+> **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 CienaMcp. 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 CienaMcp which change order dependencies or required data.
 
 ```bash
 node utils/testRunner
@@ -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
 
@@ -309,15 +318,15 @@ There are several node scripts that now accompany the adapter. These scripts are
   </tr>
   <tr>
     <td style="padding:15px">npm run connectivity</td>
-    <td style="padding:15px">Provides a connectivity check to the Ciena MCP system.</td>
+    <td style="padding:15px">Provides a connectivity check to the CienaMcp system.</td>
   </tr>
   <tr>
     <td style="padding:15px">npm run healthcheck</td>
-    <td style="padding:15px">Checks whether the configured healthcheck call works to Ciena MCP.</td>
+    <td style="padding:15px">Checks whether the configured healthcheck call works to CienaMcp.</td>
   </tr>
   <tr>
     <td style="padding:15px">npm run basicget</td>
-    <td style="padding:15px">Checks whether the basic get calls works to Ciena MCP.</td>
+    <td style="padding:15px">Checks whether the basic get calls works to CienaMcp.</td>
   </tr>
 </table>
 <br>

package/SUMMARY.md

@@ -1,8 +1,8 @@
 ## Overview
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Ciena MCP System. The API that was used to build the adapter for Ciena MCP is usually available in the report directory of this adapter. The adapter utilizes the Ciena MCP 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 Automation Platform (IAP) with the CienaMcp System. The API that was used to build the adapter for CienaMcp is usually available in the report directory of this adapter. The adapter utilizes the CienaMcp 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.
 
->**Note**: It is possible that some integrations will be supported through the Ciena MCP 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.
+>**Note**: It is possible that some integrations will be supported through the CienaMcp 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.
 

package/SYSTEMINFO.md

@@ -1,11 +1,18 @@
 # Ciena MCP
 
-Vendor: Ciena MCP
-Homepage: https://Ciena MCP.com/
+Vendor: Ciena
+Homepage: https://www.ciena.com/
 
-Product: Ciena MCP
-Product Page: https://Ciena MCP.com/
+Product: Manage, Control and Plan (MPC)
+Product Page: https://www.ciena.com/products/manage-control-plan
 
 ## Introduction
+We classify Ciena MCP into the Data Center domain as Ciena MCP provides the capability to get information about and make changes to infrastructure.
 
-## Additional Product Documentation
+## Why Integrate
+The Ciena MCP adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Ciena MCP. With this adapter you have the ability to perform operations such as:
+
+- Automate service & network provisioning, compliance, and service assurance and fulfillment.
+
+## Additional Product Documentation
+The [API documents for Ciena MCP](https://software.ciena.com/releasenotes/MCP-DOCS_5.2-217/build/site/mcp-docs/release-notes.html)

package/TROUBLESHOOT.md

@@ -22,21 +22,21 @@ npm run troubleshoot
 Go into the Itential Platform GUI and verify/update the properties
 ```
 
-3. Verify there is connectivity between the Itential Platform Server and Ciena MCP Server.
+3. Verify there is connectivity between the Itential Platform Server and CienaMcp Server.
 
 ```text
-ping the ip address of Ciena MCP server
-try telnet to the ip address port of Ciena MCP
+ping the ip address of CienaMcp server
+try telnet to the ip address port of CienaMcp
 execute a curl command to the other system
 ```
 
-4. Verify the credentials provided for Ciena MCP.
+4. Verify the credentials provided for CienaMcp.
 
 ```text
-login to Ciena MCP using the provided credentials
+login to CienaMcp using the provided credentials
 ```
 
-5. Verify the API of the call utilized for Ciena MCP Healthcheck.
+5. Verify the API of the call utilized for CienaMcp Healthcheck.
 
 ```text
 Go into the Itential Platform GUI and verify/update the properties