@itentialopensource/adapter-utils 4.44.9

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [support@itential.com](mailto:support@itential.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
+
+_return to [README](../README.md)_

package/CONTRIBUTING.md

@@ -0,0 +1,173 @@
+# Contributing
+
+:+1: :tada: First off, thanks for taking the time to contribute! :tada: :+1:
+
+The following is a set of guidelines for contributing. [These are mostly guidelines, not rules](https://www.youtube.com/watch?v=jl0hMfqNQ-g). Use your best judgment, and feel free to propose changes to this document in a merge request.
+
+#### Table Of Contents
+
+[Code of Conduct](#code-of-conduct)
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+  * [Your First Code Contribution](#your-first-code-contribution)
+  * [Merge Requests](#merge-requests)
+
+[Styleguides](#styleguides)
+  * [Git Commit Messages](#git-commit-messages)
+  * [JavaScript Styleguide](#javascript-styleguide)
+  * [Tests Styleguide](#tests-styleguide)
+  * [Documentation Styleguide](#documentation-styleguide)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@itential.com](mailto:support@itential.com).
+
+## How Can I 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 [this list](#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](#how-do-i-submit-a-good-bug-report). Fill out the [gitlab issue template](https://gitlab.com/itentialopensource/argo/issues/new); the information it asks for helps us resolve issues faster.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+#### Before Submitting A Bug Report
+
+* **Check the [User Guide](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__.
+* **Perform a [cursory search](https://gitlab.com/itentialopensource/argo/issues)** to see if the problem has already been reported and is being worked on. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [gitlab issues](https://docs.gitlab.com/ee/user/project/issues/). Create an issue and fill out the [gitlab issue template](https://gitlab.com/itentialopensource/argo/issues/new).
+
+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 many details as possible. For example, start by explaining how you setup and started the project, e.g. which command exactly you used in the terminal, or how you started the project otherwise.
+* **Provide specific examples to demonstrate the steps**. Include links to files or projects, or copy/paste-able snippets, which you use in those 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 [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) 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 doesn't 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 argo are you using?** You can get the exact version by checking the project's version in its VERSION file.
+* **What's the name and version of the OS you're using**?
+* **Are you running or using the project in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
+
+### Your First Code Contribution
+
+#### Forking this Repository
+
+In order for you to have autonomy over your code changes, while still helping us coordinate all merge requests, you will need to fork this repository first.
+
+* Click the "fork" button from this project's main page.
+  * This will create a brand new git repo which is a copy ("fork") of this original repo.
+  * When forking, you can tell gitlab to host it inside your personal gitlab account's project.
+* Clone the newly forked repo.
+* Continue with the next step of [Local Development](#local development).
+
+Note: There are sometimes exceptions to this. For example, if you are an Itential employee, you can create a gitlab issue on this project to request developer access to this repo if you do not already have it.
+
+
+#### 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 [User Guide](README.md).
+
+For all commits you make, follow the project's [Styleguide](#styleguides).
+
+This repo's pipeline is powered by [Argo](https://gitlab.com/itentialopensource/argo). Therefore, you should make sure to name your branches according to these rules: https://gitlab.com/itentialopensource/argo/blob/master/GIT_FLOW.md .
+
+
+#### Merge Requests
+
+Merge Requests empower dialog and collaberation. Feel free to make merge requests whenever you want to open discussion about the changes being made -- even if your work is not finished.
+
+See https://gitlab.com/itentialopensource/argo/blob/master/GIT_FLOW.md#3-open-a-merge-request-pull-request for more information about Itential's culture around merge requests.
+
+If you are working from a forked repo, then you should create the merge request from the forked repo. Gitlab will be smart enough to realize that this repo is a forked copy, and it will automatically assume you are trying to make a merge request to the original source repo.
+
+* 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's [Styleguide](#styleguides).
+* End all files with a newline.
+
+## Styleguides
+
+### 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 docs
+    * :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
+
+### Docker Styleguide
+
+All shell scripts must be POSIX compliant and pass testing via [shellcheck](https://github.com/koalaman/shellcheck).
+
+__Order build steps from less-frequently changed to more-frequently changed.__ eg:
+
+```
+# Rarely changed base package requirements:
+RUN apt-get update -qq && apt-get install -qq make ant netcat gawk
+
+# More commonly changed layer (nso isntaller example):
+RUN curl -L -o nso_installer.bin https://address.com/path/to/installer.bin \
+```
+
+__Bundle like-steps to keep layer stages compact and specific.__ eg:
+
+```
+# Bundle all package install steps into one run command:
+RUN apt-get update -qq && apt-get install -qq make ant netcat gawk
+
+# Set all environment variables in one layer:
+ENV NCS_LOG_DIR=/var/log/ncs \
+    NCS_RUN_DIR=/var/opt/ncs \
+    NCS_CONFIG_DIR=/etc/ncs \
+    NCS_DIR=/opt/ncs/current
+```
+
+__Avoid installing unnecessary packages.__ Don't install packages just because they might be "nice to have". Images are supposed to be minimal, specific, and compact by design.
+
+__Each container must have only one purpose/concern.__ For example, if adding an external service, write a separate image for that external service and leverage the separate image's container in conjunction with the official ci images. Do __NOT__ simply add the external service into the argo images.
+
+__Use multi-line arguments.__ Instead of creating extremely long command strings, use a space and a backslash (`\`) to span the argument over multiple lines .This makes MRs much easier to read and review. eg:
+
+```
+# bad
+ENV NCS_LOG_DIR=/var/log/ncs NCS_RUN_DIR=/var/opt/ncs NCS_CONFIG_DIR=/etc/ncs NCS_DIR=/opt/ncs/current
+
+# good
+ENV NCS_LOG_DIR=/var/log/ncs \
+    NCS_RUN_DIR=/var/opt/ncs \
+    NCS_CONFIG_DIR=/etc/ncs \
+    NCS_DIR=/opt/ncs/current
+```
+
+_return to [README](./README.md)_

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2019 Itential, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,12 @@
+Itential Adapter Utilities
+===
+
+Itential Adapter Utilities is a set of Node.js runtime libraries used by Itential Adapters.
+
+# Usage
+
+Include `@itentialopensource/adapter-utils` as a dependency and require it:
+
+```
+const { RequestHandler, PropertyUtility } = require('@itentialopensource/adapter-utils');
+```

package/actionSchema.json

@@ -0,0 +1,186 @@
+{
+  "$id": "action-schemas",
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "actions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "the action being performed",
+            "examples": [
+              "get_config"
+            ]
+          },
+          "protocol": {
+            "type": "string",
+            "description": "the protocol to use for this action",
+            "default": "REST",
+            "enum": [
+              "REST"
+            ]
+          },
+          "method": {
+            "type": "string",
+            "description": "the method to use for this action",
+            "default": "GET",
+            "enum": [
+              "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "TRACE", "CONNECT"
+            ]
+          },
+          "entitypath": {
+            "type": "string",
+            "description": "the path to use for this action",
+            "default": "GET",
+            "pattern": "^({base_path}|\\/)[-a-zA-Z0-9!@$:&%_+.,~#\\/*=:]*({version})?([-a-zA-Z0-9!@$:&%_+.,~#\\/*=:]*({pathv[0-9]+})?)*(\\??[-a-zA-Z0-9!@$:&%_+.,\\(\\)~#\\/*=:]*({username})?[-a-zA-Z0-9!@$:&%_+.,\\(\\)~#\/*=:]*({password})?({query})?)?$",
+            "examples": [
+              "/api/devices{pathv1}{query}", "/api/devices{pathv1}/components{pathv2}{query}",
+              "/api/devices", "/api/devices{query}"
+            ]
+          },
+          "querykey": {
+            "type": "string",
+            "description": "anything that should proceed the query in the entitypath",
+            "default": "?",
+            "examples": [
+              "?query=", "?sysparam_query="
+            ]
+          },
+          "timeout": {
+            "type": "integer",
+            "description": "request timeout for this action"
+          },
+          "sendEmpty": {
+            "type": "boolean",
+            "description": "whether to send an empty body"
+          },
+          "sendGetBody": {
+            "type": "boolean",
+            "description": "whether to send a body with the get request"
+          },
+          "schema": {
+            "type": "string",
+            "description": "the name of the schema file for this action",
+            "examples": [
+              "schema.json"
+            ]
+          },
+          "requestSchema": {
+            "type": "string",
+            "description": "the name of the request schema file for this action (will override the schema)",
+            "examples": [
+              "req_schema.json"
+            ]
+          },
+          "responseSchema": {
+            "type": "string",
+            "description": "the name of the response schema file for this action (will override the schema)",
+            "examples": [
+              "resp_schema.json"
+            ]
+          },
+          "datatype": {
+            "type": "string",
+            "description": "the type of data used in this action, if unsupported type JSON will be used",
+            "default": "JSON"
+          },
+          "requestDatatype": {
+            "type": "string",
+            "description": "the name of the request data type for this action (will override the datatype)",
+            "examples": [
+              "req_schema.json"
+            ]
+          },
+          "responseDatatype": {
+            "type": "string",
+            "description": "the name of the response data type for this action (will override the datatype)",
+            "examples": [
+              "resp_schema.json"
+            ]
+          },
+          "sso": {
+            "$ref": "#/definitions/sso"
+          },
+          "headers": {
+            "type": "object"
+          },
+          "responseObjects": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "description": "the response type - based on the entitypath",
+                  "default": "default",
+                  "examples": [
+                    "default", "withpathv1", "withpathv2", "withpathv3", "withquery"
+                  ]
+                },
+                "key": {
+                  "type": "string",
+                  "description": "the field in the response where the data we want is",
+                  "default": "",
+                  "examples": [
+                    "result"
+                  ]
+                },
+                "mockFile": {
+                  "type": "string",
+                  "description": "the relative location of a data file containing a mock response",
+                  "examples": [
+                    "mockdatafiles/actionname.json"
+                  ]
+                }
+              },
+              "required": ["type", "key"]
+            }
+          }
+        },
+        "required": ["name", "protocol", "method", "entitypath"],
+        "oneOf": [
+          {
+            "required": ["schema"]
+          },
+          {
+            "required": ["requestSchema","responseSchema"]
+          }      
+        ]
+      }
+    }
+  },
+  "required": ["actions"],
+  "definitions": {
+    "sso": {
+      "type": "object",
+      "properties": {
+        "protocol": {
+          "type": "string",
+          "description": "the protocol to request token from system",
+          "default": "",
+          "enum": [
+            "http", "https", ""
+          ]
+        },
+        "host": {
+          "type": "string",
+          "description": "hostname of the authentication system",
+          "default": "",
+          "examples": [
+            "systemx.customer.com"
+          ]
+        },
+        "port": {
+          "type": "integer",
+          "description": "port on which to connect to the authentication system",
+          "default": 0,
+          "minimum": 0,
+          "maximum": 65535
+        }
+      }
+    }
+  }
+}